httplib.h 802 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453
  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.61.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003d00"
  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. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  104. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  105. #endif
  106. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  107. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  108. #endif
  109. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  110. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  111. #endif
  112. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  113. // 1400 rather than a round number: a body that already fits in one 1500-byte
  114. // MTU gains nothing from being made smaller.
  115. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  116. #endif
  117. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  118. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  119. #endif
  120. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  121. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  122. #endif
  123. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  124. // recurses roughly once per matched character for quantified patterns such
  125. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  126. // a default ~8MB thread stack that has been observed to take on the order of
  127. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  128. // margin below that (well under the 8192-byte request URI limit) while still
  129. // fitting any realistic route segment; raise it if a route legitimately needs
  130. // longer paths. Regex routes are never applied to paths longer than this.
  131. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  132. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  133. #endif
  134. #ifndef CPPHTTPLIB_TCP_NODELAY
  135. #define CPPHTTPLIB_TCP_NODELAY false
  136. #endif
  137. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  138. #define CPPHTTPLIB_IPV6_V6ONLY false
  139. #endif
  140. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  141. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  142. #endif
  143. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  144. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  145. #endif
  146. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  147. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  148. #endif
  149. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  150. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  151. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  152. ? std::thread::hardware_concurrency() - 1 \
  153. : 0))
  154. #endif
  155. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  156. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  157. #endif
  158. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  159. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  160. #endif
  161. #ifndef CPPHTTPLIB_RECV_FLAGS
  162. #define CPPHTTPLIB_RECV_FLAGS 0
  163. #endif
  164. #ifndef CPPHTTPLIB_SEND_FLAGS
  165. #define CPPHTTPLIB_SEND_FLAGS 0
  166. #endif
  167. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  168. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  169. #endif
  170. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  171. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  172. #endif
  173. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  174. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  175. #endif
  176. // One macro used to set the read timeout for both sides. They want different
  177. // defaults: a client's read timeout is the caller's own tool (it waits forever
  178. // until asked not to), while a server keeps a ceiling that reclaims a worker
  179. // from a peer that has gone quiet. The old name still works and sets both.
  180. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  181. #pragma message( \
  182. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  183. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  184. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  185. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  186. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  187. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  188. #endif
  189. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  190. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  191. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  192. #endif
  193. #endif
  194. // 0 waits forever. A read timeout is how a caller gets control back to send on
  195. // the same connection; it is not a liveness check (that is ping/pong). Only a
  196. // timeout set at runtime through set_read_timeout() is reported as
  197. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  198. // ws::Fail and closes the connection.
  199. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  200. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  201. #endif
  202. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  203. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  204. #endif
  205. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  207. #endif
  208. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  209. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  210. #endif
  211. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  212. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  213. #endif
  214. /*
  215. * Headers
  216. */
  217. #ifdef _WIN32
  218. #ifndef _CRT_SECURE_NO_WARNINGS
  219. #define _CRT_SECURE_NO_WARNINGS
  220. #endif //_CRT_SECURE_NO_WARNINGS
  221. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  222. #define _CRT_NONSTDC_NO_DEPRECATE
  223. #endif //_CRT_NONSTDC_NO_DEPRECATE
  224. #if defined(_MSC_VER)
  225. #if _MSC_VER < 1900
  226. #error Sorry, Visual Studio versions prior to 2015 are not supported
  227. #endif
  228. #pragma comment(lib, "ws2_32.lib")
  229. #ifndef _SSIZE_T_DEFINED
  230. using ssize_t = __int64;
  231. #define _SSIZE_T_DEFINED
  232. #endif
  233. #endif // _MSC_VER
  234. #ifndef S_ISREG
  235. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  236. #endif // S_ISREG
  237. #ifndef S_ISDIR
  238. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  239. #endif // S_ISDIR
  240. #ifndef NOMINMAX
  241. #define NOMINMAX
  242. #endif // NOMINMAX
  243. #include <io.h>
  244. #include <winsock2.h>
  245. #include <ws2tcpip.h>
  246. #if defined(__has_include)
  247. #if __has_include(<afunix.h>)
  248. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  249. #include <afunix.h>
  250. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  251. #endif
  252. #endif
  253. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  254. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  255. #endif
  256. using nfds_t = unsigned long;
  257. using socket_t = SOCKET;
  258. using socklen_t = int;
  259. #else // not _WIN32
  260. #include <arpa/inet.h>
  261. #if !defined(_AIX) && !defined(__MVS__)
  262. #include <ifaddrs.h>
  263. #endif
  264. #ifdef __MVS__
  265. #include <strings.h>
  266. #ifndef NI_MAXHOST
  267. #define NI_MAXHOST 1025
  268. #endif
  269. #endif
  270. #include <net/if.h>
  271. #include <netdb.h>
  272. #include <netinet/in.h>
  273. #ifdef __linux__
  274. #include <resolv.h>
  275. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  276. #endif
  277. #include <csignal>
  278. #include <netinet/tcp.h>
  279. #include <poll.h>
  280. #include <pthread.h>
  281. #include <sys/mman.h>
  282. #include <sys/socket.h>
  283. #include <sys/un.h>
  284. #include <unistd.h>
  285. using socket_t = int;
  286. #ifndef INVALID_SOCKET
  287. #define INVALID_SOCKET (-1)
  288. #endif
  289. #endif //_WIN32
  290. #if defined(__APPLE__)
  291. #include <TargetConditionals.h>
  292. #endif
  293. #include <algorithm>
  294. #include <array>
  295. #include <atomic>
  296. #include <cassert>
  297. #include <chrono>
  298. #include <climits>
  299. #include <condition_variable>
  300. #include <cstdlib>
  301. #include <cstring>
  302. #include <errno.h>
  303. #include <exception>
  304. #include <fcntl.h>
  305. #include <fstream>
  306. #include <functional>
  307. #include <iomanip>
  308. #include <iostream>
  309. #include <iterator>
  310. #include <list>
  311. #include <map>
  312. #include <memory>
  313. #include <mutex>
  314. #include <random>
  315. #include <regex>
  316. #include <set>
  317. #include <sstream>
  318. #include <string>
  319. #include <sys/stat.h>
  320. #include <system_error>
  321. #include <thread>
  322. #include <type_traits>
  323. #include <unordered_map>
  324. #include <unordered_set>
  325. #include <utility>
  326. #include <vector>
  327. // On macOS with a TLS backend, enable Keychain root certificates by default
  328. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  329. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  330. // only; on those platforms the user must provide a CA bundle explicitly.
  331. #if defined(__APPLE__) && defined(__clang__) && \
  332. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  333. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  334. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  335. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  336. #if TARGET_OS_OSX
  337. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  338. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  339. #endif
  340. #endif
  341. #endif
  342. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  343. defined(__APPLE__) && !TARGET_OS_OSX
  344. #error \
  345. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  346. #endif
  347. // On Windows, enable Schannel certificate verification by default
  348. // unless the user explicitly opts out.
  349. #if defined(_WIN32) && \
  350. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  351. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  352. #endif
  353. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  354. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  355. #if TARGET_OS_MAC && defined(__clang__)
  356. #include <CFNetwork/CFHost.h>
  357. #include <CoreFoundation/CoreFoundation.h>
  358. #endif
  359. #endif
  360. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  361. #ifdef _WIN32
  362. #include <wincrypt.h>
  363. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  364. // used
  365. #undef X509_NAME
  366. #undef X509_CERT_PAIR
  367. #undef X509_EXTENSIONS
  368. #undef PKCS7_SIGNER_INFO
  369. #ifdef _MSC_VER
  370. #pragma comment(lib, "crypt32.lib")
  371. #endif
  372. #endif // _WIN32
  373. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  374. #if TARGET_OS_OSX
  375. #include <Security/Security.h>
  376. #endif
  377. #endif
  378. #include <openssl/err.h>
  379. #include <openssl/evp.h>
  380. #include <openssl/ssl.h>
  381. #include <openssl/x509v3.h>
  382. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  383. #include <openssl/applink.c>
  384. #endif
  385. #include <iostream>
  386. #include <sstream>
  387. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  388. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  389. #error Please use OpenSSL or a current version of BoringSSL
  390. #endif
  391. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  392. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  393. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  394. #endif
  395. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  396. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  397. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  398. // in with this first include group so the version gating below can use it.
  399. #include <mbedtls/error.h>
  400. #include <mbedtls/net_sockets.h>
  401. #include <mbedtls/oid.h>
  402. #include <mbedtls/pk.h>
  403. #include <mbedtls/ssl.h>
  404. #include <mbedtls/version.h>
  405. #include <mbedtls/x509_crt.h>
  406. #if MBEDTLS_VERSION_MAJOR >= 4
  407. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  408. #include <psa/crypto.h>
  409. #else
  410. #include <mbedtls/ctr_drbg.h>
  411. #include <mbedtls/entropy.h>
  412. #include <mbedtls/md5.h>
  413. #include <mbedtls/sha1.h>
  414. #include <mbedtls/sha256.h>
  415. #include <mbedtls/sha512.h>
  416. #endif
  417. #ifdef _WIN32
  418. #include <wincrypt.h>
  419. #ifdef _MSC_VER
  420. #pragma comment(lib, "crypt32.lib")
  421. #endif
  422. #endif // _WIN32
  423. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  424. #if TARGET_OS_OSX
  425. #include <Security/Security.h>
  426. #endif
  427. #endif
  428. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  429. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  430. #if MBEDTLS_VERSION_MAJOR >= 4
  431. #define CPPHTTPLIB_MBEDTLS_V4
  432. #endif
  433. #if MBEDTLS_VERSION_MAJOR >= 3
  434. #define CPPHTTPLIB_MBEDTLS_V3
  435. #endif
  436. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  437. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  438. #include <wolfssl/options.h>
  439. #include <wolfssl/openssl/x509v3.h>
  440. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  441. #ifndef WOLFSSL_GEN_EMAIL
  442. #define WOLFSSL_GEN_EMAIL 1
  443. #endif
  444. #ifndef WOLFSSL_GEN_DNS
  445. #define WOLFSSL_GEN_DNS 2
  446. #endif
  447. #ifndef WOLFSSL_GEN_URI
  448. #define WOLFSSL_GEN_URI 6
  449. #endif
  450. #ifndef WOLFSSL_GEN_IPADD
  451. #define WOLFSSL_GEN_IPADD 7
  452. #endif
  453. #include <wolfssl/ssl.h>
  454. #include <wolfssl/wolfcrypt/hash.h>
  455. #include <wolfssl/wolfcrypt/md5.h>
  456. #include <wolfssl/wolfcrypt/sha256.h>
  457. #include <wolfssl/wolfcrypt/sha512.h>
  458. #ifdef _WIN32
  459. #include <wincrypt.h>
  460. #ifdef _MSC_VER
  461. #pragma comment(lib, "crypt32.lib")
  462. #endif
  463. #endif // _WIN32
  464. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  465. #if TARGET_OS_OSX
  466. #include <Security/Security.h>
  467. #endif
  468. #endif
  469. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  470. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  471. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  472. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  473. #define CPPHTTPLIB_SSL_ENABLED
  474. #endif
  475. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  476. #include <zlib.h>
  477. #endif
  478. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  479. #include <brotli/decode.h>
  480. #include <brotli/encode.h>
  481. #endif
  482. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  483. #include <zstd.h>
  484. #endif
  485. /*
  486. * Declaration
  487. */
  488. namespace httplib {
  489. namespace ws {
  490. class WebSocket;
  491. } // namespace ws
  492. namespace detail {
  493. /*
  494. * Backport std::make_unique from C++14.
  495. *
  496. * NOTE: This code came up with the following stackoverflow post:
  497. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  498. *
  499. */
  500. template <class T, class... Args>
  501. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  502. make_unique(Args &&...args) {
  503. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  504. }
  505. template <class T>
  506. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  507. make_unique(std::size_t n) {
  508. typedef typename std::remove_extent<T>::type RT;
  509. return std::unique_ptr<T>(new RT[n]);
  510. }
  511. // Locale-independent ASCII character classification. The <cctype>
  512. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  513. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  514. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  515. // classified without regard to the locale.
  516. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  517. inline bool is_ascii_alpha(char c) {
  518. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  519. }
  520. inline bool is_ascii_alnum(char c) {
  521. return is_ascii_digit(c) || is_ascii_alpha(c);
  522. }
  523. namespace case_ignore {
  524. inline unsigned char to_lower(int c) {
  525. const static unsigned char table[256] = {
  526. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  527. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  528. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  529. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  530. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  531. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  532. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  533. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  534. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  535. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  536. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  537. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  538. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  539. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  540. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  541. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  542. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  543. 255,
  544. };
  545. return table[(unsigned char)(char)c];
  546. }
  547. inline std::string to_lower(const std::string &s) {
  548. std::string result = s;
  549. std::transform(
  550. result.begin(), result.end(), result.begin(),
  551. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  552. return result;
  553. }
  554. inline bool equal(const std::string &a, const std::string &b) {
  555. return a.size() == b.size() &&
  556. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  557. return to_lower(ca) == to_lower(cb);
  558. });
  559. }
  560. struct equal_to {
  561. bool operator()(const std::string &a, const std::string &b) const {
  562. return equal(a, b);
  563. }
  564. };
  565. struct hash {
  566. size_t operator()(const std::string &key) const {
  567. return hash_core(key.data(), key.size(), 0);
  568. }
  569. size_t hash_core(const char *s, size_t l, size_t h) const {
  570. return (l == 0) ? h
  571. : hash_core(s + 1, l - 1,
  572. // Unsets the 6 high bits of h, therefore no
  573. // overflow happens
  574. (((std::numeric_limits<size_t>::max)() >> 6) &
  575. h * 33) ^
  576. static_cast<unsigned char>(to_lower(*s)));
  577. }
  578. };
  579. template <typename T>
  580. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  581. detail::case_ignore::equal_to>;
  582. } // namespace case_ignore
  583. // This is based on
  584. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  585. struct scope_exit {
  586. explicit scope_exit(std::function<void(void)> &&f)
  587. : exit_function(std::move(f)), execute_on_destruction{true} {}
  588. scope_exit(scope_exit &&rhs) noexcept
  589. : exit_function(std::move(rhs.exit_function)),
  590. execute_on_destruction{rhs.execute_on_destruction} {
  591. rhs.release();
  592. }
  593. ~scope_exit() {
  594. if (execute_on_destruction) { this->exit_function(); }
  595. }
  596. void release() { this->execute_on_destruction = false; }
  597. private:
  598. scope_exit(const scope_exit &) = delete;
  599. void operator=(const scope_exit &) = delete;
  600. scope_exit &operator=(scope_exit &&) = delete;
  601. std::function<void(void)> exit_function;
  602. bool execute_on_destruction;
  603. };
  604. // Simple from_chars implementation for integer and double types (C++17
  605. // substitute)
  606. template <typename T> struct from_chars_result {
  607. const char *ptr;
  608. std::errc ec;
  609. };
  610. template <typename T>
  611. inline from_chars_result<T> from_chars(const char *first, const char *last,
  612. T &value, int base = 10) {
  613. value = 0;
  614. const char *p = first;
  615. bool negative = false;
  616. if (p != last && *p == '-') {
  617. negative = true;
  618. ++p;
  619. }
  620. if (p == last) { return {first, std::errc::invalid_argument}; }
  621. T result = 0;
  622. for (; p != last; ++p) {
  623. char c = *p;
  624. int digit = -1;
  625. if (is_ascii_digit(c)) {
  626. digit = c - '0';
  627. } else if ('a' <= c && c <= 'z') {
  628. digit = c - 'a' + 10;
  629. } else if ('A' <= c && c <= 'Z') {
  630. digit = c - 'A' + 10;
  631. } else {
  632. break;
  633. }
  634. if (digit < 0 || digit >= base) { break; }
  635. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  636. return {p, std::errc::result_out_of_range};
  637. }
  638. result = result * base + digit;
  639. }
  640. if (p == first || (negative && p == first + 1)) {
  641. return {first, std::errc::invalid_argument};
  642. }
  643. value = negative ? T(0) - result : result;
  644. return {p, std::errc{}};
  645. }
  646. // from_chars for double (hand-written, locale-independent)
  647. //
  648. // The only double consumed by this library is the HTTP quality value, whose
  649. // grammar is (RFC 9110 12.4.2):
  650. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  651. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  652. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  653. // '.' always the decimal separator (std::strtod would instead read it from the
  654. // global C locale, mis-parsing q-values once an embedder calls
  655. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  656. // the result to [0, 1], so inputs outside that range need not be distinguished
  657. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  658. // cases that exponent and wide-range handling would introduce.
  659. inline from_chars_result<double> from_chars(const char *first, const char *last,
  660. double &value) {
  661. value = 0.0;
  662. const char *p = first;
  663. // Each 1eN is exactly representable, so a single final division by the
  664. // matching entry yields a correctly-rounded result.
  665. static const double powers_of_ten[] = {
  666. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  667. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  668. const int max_frac_digits =
  669. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  670. // Accumulate digits into a 64-bit integer and remember how many were
  671. // fractional. Two independent caps keep this bounded and safe:
  672. // * accumulation saturates before mantissa could overflow uint64_t, and
  673. // * frac_digits is capped at max_frac_digits so it is always a valid index
  674. // into powers_of_ten (without this an input like "0.000...0" would never
  675. // grow mantissa, so the saturation cap alone would not bound it).
  676. // Both caps only drop digits far beyond the precision a q-value needs; any
  677. // value they would change is well outside [0, 1] and rejected by the caller.
  678. uint64_t mantissa = 0;
  679. int frac_digits = 0;
  680. bool seen_digit = false;
  681. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  682. auto accumulate = [&](char c) {
  683. if (mantissa <= limit) {
  684. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  685. return true;
  686. }
  687. return false;
  688. };
  689. for (; p != last && is_ascii_digit(*p); ++p) {
  690. seen_digit = true;
  691. accumulate(*p);
  692. }
  693. if (p != last && *p == '.') {
  694. ++p;
  695. for (; p != last && is_ascii_digit(*p); ++p) {
  696. seen_digit = true;
  697. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  698. }
  699. }
  700. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  701. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  702. return {p, std::errc{}};
  703. }
  704. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  705. int &out) {
  706. int val = 0;
  707. auto r = from_chars(s, s + len, val);
  708. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  709. return false;
  710. }
  711. out = val;
  712. return true;
  713. }
  714. inline bool parse_port(const char *s, size_t len, int &port) {
  715. return parse_int_in_range(s, len, 1, 65535, port);
  716. }
  717. inline bool parse_port(const std::string &s, int &port) {
  718. return parse_port(s.data(), s.size(), port);
  719. }
  720. struct UrlComponents {
  721. std::string scheme;
  722. std::string host;
  723. std::string port;
  724. std::string path;
  725. std::string query;
  726. };
  727. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  728. uc = {};
  729. size_t pos = 0;
  730. auto sep = url.find("://");
  731. if (sep != std::string::npos) {
  732. uc.scheme = url.substr(0, sep);
  733. // Scheme must be [a-z]+ only
  734. if (uc.scheme.empty()) { return false; }
  735. for (auto c : uc.scheme) {
  736. if (c < 'a' || c > 'z') { return false; }
  737. }
  738. pos = sep + 3;
  739. } else if (url.compare(0, 2, "//") == 0) {
  740. pos = 2;
  741. }
  742. auto has_authority_prefix = pos > 0;
  743. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  744. url[0] != '?' && url[0] != '#');
  745. if (has_authority) {
  746. if (pos < url.size() && url[pos] == '[') {
  747. auto close = url.find(']', pos);
  748. if (close == std::string::npos) { return false; }
  749. uc.host = url.substr(pos + 1, close - pos - 1);
  750. // IPv6 host must be [a-fA-F0-9:]+ only
  751. if (uc.host.empty()) { return false; }
  752. for (auto c : uc.host) {
  753. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  754. (c >= 'A' && c <= 'F') || c == ':')) {
  755. return false;
  756. }
  757. }
  758. pos = close + 1;
  759. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  760. // path, query or fragment delimiter (or the end of input). Otherwise the
  761. // trailing bytes would be folded into the path while the connection
  762. // still targets the bracketed address.
  763. if (pos < url.size()) {
  764. auto c = url[pos];
  765. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  766. }
  767. } else {
  768. auto end = url.find_first_of(":/?#", pos);
  769. if (end == std::string::npos) { end = url.size(); }
  770. uc.host = url.substr(pos, end - pos);
  771. pos = end;
  772. }
  773. if (pos < url.size() && url[pos] == ':') {
  774. ++pos;
  775. auto end = url.find_first_of("/?#", pos);
  776. if (end == std::string::npos) { end = url.size(); }
  777. uc.port = url.substr(pos, end - pos);
  778. pos = end;
  779. }
  780. // Without :// or //, the entire input must be consumed as host[:port].
  781. // If there is leftover (path, query, etc.), this is not a valid
  782. // host[:port] string — clear and reparse as a plain path.
  783. if (!has_authority_prefix && pos < url.size()) {
  784. uc.host.clear();
  785. uc.port.clear();
  786. pos = 0;
  787. }
  788. }
  789. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  790. auto end = url.find_first_of("?#", pos);
  791. if (end == std::string::npos) { end = url.size(); }
  792. uc.path = url.substr(pos, end - pos);
  793. pos = end;
  794. }
  795. if (pos < url.size() && url[pos] == '?') {
  796. auto end = url.find('#', pos);
  797. if (end == std::string::npos) { end = url.size(); }
  798. uc.query = url.substr(pos, end - pos);
  799. }
  800. return true;
  801. }
  802. // Resolves a relative-path or query-only Location value against the path of
  803. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  804. // references starting with '/' are returned unchanged.
  805. inline std::string resolve_relative_location(const std::string &location,
  806. const std::string &base) {
  807. if (location.empty() || location[0] == '/') { return location; }
  808. // A ':' in the first segment means the value has a scheme.
  809. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  810. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  811. auto base_path = base.substr(0, base.find_first_of("?#"));
  812. if (location[0] == '?') { return base_path + location; }
  813. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  814. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  815. // Remove "." and ".." segments from the merged path.
  816. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  817. std::string path;
  818. size_t i = 0;
  819. while (i < path_end) {
  820. auto next = (std::min)(merged.find('/', i + 1), path_end);
  821. auto segment = merged.substr(i + 1, next - i - 1);
  822. auto is_last = next == path_end;
  823. if (segment == "." || segment == "..") {
  824. if (segment == "..") {
  825. path.erase((std::min)(path.rfind('/'), path.size()));
  826. }
  827. if (is_last) { path += '/'; }
  828. } else {
  829. path += '/';
  830. path += segment;
  831. }
  832. i = next;
  833. }
  834. if (path.empty()) { path = "/"; }
  835. return path + merged.substr(path_end);
  836. }
  837. } // namespace detail
  838. enum class SSLVerifierResponse {
  839. // no decision has been made, use the built-in certificate verifier
  840. NoDecisionMade,
  841. // connection certificate is verified and accepted
  842. CertificateAccepted,
  843. // connection certificate was processed but is rejected
  844. CertificateRejected
  845. };
  846. // System CA loading policy for SSL clients. Auto (the default) loads system
  847. // CA certs only when no custom CA is configured; enable_system_ca() switches
  848. // to an explicit policy.
  849. enum class SystemCAMode { Auto, Enabled, Disabled };
  850. enum StatusCode {
  851. // Information responses
  852. Continue_100 = 100,
  853. SwitchingProtocol_101 = 101,
  854. Processing_102 = 102,
  855. EarlyHints_103 = 103,
  856. // Successful responses
  857. OK_200 = 200,
  858. Created_201 = 201,
  859. Accepted_202 = 202,
  860. NonAuthoritativeInformation_203 = 203,
  861. NoContent_204 = 204,
  862. ResetContent_205 = 205,
  863. PartialContent_206 = 206,
  864. MultiStatus_207 = 207,
  865. AlreadyReported_208 = 208,
  866. IMUsed_226 = 226,
  867. // Redirection messages
  868. MultipleChoices_300 = 300,
  869. MovedPermanently_301 = 301,
  870. Found_302 = 302,
  871. SeeOther_303 = 303,
  872. NotModified_304 = 304,
  873. UseProxy_305 = 305,
  874. unused_306 = 306,
  875. TemporaryRedirect_307 = 307,
  876. PermanentRedirect_308 = 308,
  877. // Client error responses
  878. BadRequest_400 = 400,
  879. Unauthorized_401 = 401,
  880. PaymentRequired_402 = 402,
  881. Forbidden_403 = 403,
  882. NotFound_404 = 404,
  883. MethodNotAllowed_405 = 405,
  884. NotAcceptable_406 = 406,
  885. ProxyAuthenticationRequired_407 = 407,
  886. RequestTimeout_408 = 408,
  887. Conflict_409 = 409,
  888. Gone_410 = 410,
  889. LengthRequired_411 = 411,
  890. PreconditionFailed_412 = 412,
  891. PayloadTooLarge_413 = 413,
  892. UriTooLong_414 = 414,
  893. UnsupportedMediaType_415 = 415,
  894. RangeNotSatisfiable_416 = 416,
  895. ExpectationFailed_417 = 417,
  896. ImATeapot_418 = 418,
  897. MisdirectedRequest_421 = 421,
  898. UnprocessableContent_422 = 422,
  899. Locked_423 = 423,
  900. FailedDependency_424 = 424,
  901. TooEarly_425 = 425,
  902. UpgradeRequired_426 = 426,
  903. PreconditionRequired_428 = 428,
  904. TooManyRequests_429 = 429,
  905. RequestHeaderFieldsTooLarge_431 = 431,
  906. UnavailableForLegalReasons_451 = 451,
  907. // Server error responses
  908. InternalServerError_500 = 500,
  909. NotImplemented_501 = 501,
  910. BadGateway_502 = 502,
  911. ServiceUnavailable_503 = 503,
  912. GatewayTimeout_504 = 504,
  913. HttpVersionNotSupported_505 = 505,
  914. VariantAlsoNegotiates_506 = 506,
  915. InsufficientStorage_507 = 507,
  916. LoopDetected_508 = 508,
  917. NotExtended_510 = 510,
  918. NetworkAuthenticationRequired_511 = 511,
  919. };
  920. namespace detail {
  921. // A multimap that keeps its entries in the order they were inserted.
  922. //
  923. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  924. // fields sharing a field name significant and forbids a proxy from reordering
  925. // them, and a query string's parameters are meaningful in the order the caller
  926. // wrote them. Neither standard container expresses it: std::unordered_multimap
  927. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  928. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  929. // key, which would drop control data such as Host behind whatever else the
  930. // message carries and alphabetise a query string.
  931. //
  932. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  933. // scan, which beats hashing for the handful of entries a message carries
  934. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  935. //
  936. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  937. // Params, whose parameter names are case-sensitive, not.
  938. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  939. public:
  940. using key_type = std::string;
  941. using mapped_type = Mapped;
  942. using value_type = std::pair<std::string, Mapped>;
  943. using size_type = std::size_t;
  944. using difference_type = std::ptrdiff_t;
  945. using reference = value_type &;
  946. using const_reference = const value_type &;
  947. private:
  948. static size_type npos() { return static_cast<size_type>(-1); }
  949. static bool keys_equal(const std::string &a, const std::string &b) {
  950. return KeyEqual()(a, b);
  951. }
  952. // Iterating yields every entry in insertion order, but equal_range() and
  953. // find() have to walk only the entries sharing one key, which are not
  954. // adjacent. Both are the same iterator type: key_idx_ selects between the
  955. // two traversals, and since equality compares only the position, an iterator
  956. // restricted to one key still compares equal to end().
  957. template <typename V> class iterator_t {
  958. public:
  959. using iterator_category = std::bidirectional_iterator_tag;
  960. using value_type = insertion_ordered_multimap::value_type;
  961. using difference_type = insertion_ordered_multimap::difference_type;
  962. using pointer = V *;
  963. using reference = V &;
  964. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  965. template <typename U,
  966. typename std::enable_if<std::is_convertible<U *, V *>::value,
  967. int>::type = 0>
  968. iterator_t(const iterator_t<U> &rhs)
  969. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  970. key_idx_(rhs.key_idx_) {}
  971. reference operator*() const { return data_[idx_]; }
  972. pointer operator->() const { return data_ + idx_; }
  973. iterator_t &operator++() {
  974. // Saturating, so that advancing past the last entry of a key stays at
  975. // end() instead of running off the container.
  976. if (idx_ >= size_) { return *this; }
  977. ++idx_;
  978. if (key_idx_ != npos()) {
  979. while (idx_ < size_ && !matches(idx_)) {
  980. ++idx_;
  981. }
  982. }
  983. return *this;
  984. }
  985. iterator_t operator++(int) {
  986. auto tmp = *this;
  987. ++*this;
  988. return tmp;
  989. }
  990. iterator_t &operator--() {
  991. if (idx_ == 0) { return *this; }
  992. --idx_;
  993. if (key_idx_ != npos()) {
  994. while (idx_ > 0 && !matches(idx_)) {
  995. --idx_;
  996. }
  997. }
  998. return *this;
  999. }
  1000. iterator_t operator--(int) {
  1001. auto tmp = *this;
  1002. --*this;
  1003. return tmp;
  1004. }
  1005. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1006. return idx_ == rhs.idx_;
  1007. }
  1008. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1009. return idx_ != rhs.idx_;
  1010. }
  1011. private:
  1012. friend class insertion_ordered_multimap;
  1013. template <typename> friend class iterator_t;
  1014. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1015. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1016. bool matches(size_type i) const {
  1017. return keys_equal(data_[i].first, data_[key_idx_].first);
  1018. }
  1019. V *data_;
  1020. size_type idx_;
  1021. size_type size_;
  1022. size_type key_idx_;
  1023. };
  1024. public:
  1025. using iterator = iterator_t<value_type>;
  1026. using const_iterator = iterator_t<const value_type>;
  1027. insertion_ordered_multimap() = default;
  1028. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1029. : entries_(il) {}
  1030. template <typename InputIt>
  1031. insertion_ordered_multimap(InputIt first, InputIt last)
  1032. : entries_(first, last) {}
  1033. iterator begin() { return make_iter(0, npos()); }
  1034. iterator end() { return make_iter(entries_.size(), npos()); }
  1035. const_iterator begin() const { return make_citer(0, npos()); }
  1036. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1037. const_iterator cbegin() const { return begin(); }
  1038. const_iterator cend() const { return end(); }
  1039. bool empty() const { return entries_.empty(); }
  1040. size_type size() const { return entries_.size(); }
  1041. void clear() { entries_.clear(); }
  1042. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1043. iterator insert(const value_type &val) {
  1044. entries_.push_back(val);
  1045. return make_iter(entries_.size() - 1, npos());
  1046. }
  1047. iterator insert(value_type &&val) {
  1048. entries_.push_back(std::move(val));
  1049. return make_iter(entries_.size() - 1, npos());
  1050. }
  1051. template <typename... Args> iterator emplace(Args &&...args) {
  1052. entries_.emplace_back(std::forward<Args>(args)...);
  1053. return make_iter(entries_.size() - 1, npos());
  1054. }
  1055. // For entries that have to lead the message, such as the Host header field
  1056. // (RFC 9110 5.3 recommends sending control data first).
  1057. template <typename... Args> iterator emplace_front(Args &&...args) {
  1058. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1059. return make_iter(0, npos());
  1060. }
  1061. iterator find(const std::string &key) {
  1062. auto i = index_of(key);
  1063. return i == npos() ? end() : make_iter(i, i);
  1064. }
  1065. const_iterator find(const std::string &key) const {
  1066. auto i = index_of(key);
  1067. return i == npos() ? end() : make_citer(i, i);
  1068. }
  1069. size_type count(const std::string &key) const {
  1070. size_type n = 0;
  1071. for (const auto &entry : entries_) {
  1072. if (keys_equal(entry.first, key)) { n++; }
  1073. }
  1074. return n;
  1075. }
  1076. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1077. auto i = index_of(key);
  1078. return i == npos() ? std::make_pair(end(), end())
  1079. : std::make_pair(make_iter(i, i), end());
  1080. }
  1081. std::pair<const_iterator, const_iterator>
  1082. equal_range(const std::string &key) const {
  1083. auto i = index_of(key);
  1084. return i == npos() ? std::make_pair(end(), end())
  1085. : std::make_pair(make_citer(i, i), end());
  1086. }
  1087. size_type erase(const std::string &key) {
  1088. auto before = entries_.size();
  1089. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1090. [&](const value_type &entry) {
  1091. return keys_equal(entry.first, key);
  1092. }),
  1093. entries_.end());
  1094. return before - entries_.size();
  1095. }
  1096. iterator erase(const_iterator pos) {
  1097. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1098. return make_iter(pos.idx_, npos());
  1099. }
  1100. // Erases what iterating [first, last) would actually visit, so erasing an
  1101. // equal_range() removes only the entries with that key, not everything
  1102. // positioned between them.
  1103. iterator erase(const_iterator first, const_iterator last) {
  1104. auto from = first.idx_;
  1105. auto to = last.idx_;
  1106. if (from >= to) { return make_iter(from, npos()); }
  1107. auto begin_it = entries_.begin();
  1108. auto from_it = begin_it + static_cast<difference_type>(from);
  1109. auto to_it = begin_it + static_cast<difference_type>(to);
  1110. if (first.key_idx_ == npos()) {
  1111. entries_.erase(from_it, to_it);
  1112. } else {
  1113. auto key = entries_[first.key_idx_].first;
  1114. auto keep = from_it;
  1115. for (auto it = from_it; it != to_it; ++it) {
  1116. if (!keys_equal(it->first, key)) {
  1117. if (keep != it) { *keep = std::move(*it); }
  1118. ++keep;
  1119. }
  1120. }
  1121. if (keep != to_it) {
  1122. keep = std::move(to_it, entries_.end(), keep);
  1123. } else {
  1124. keep = entries_.end();
  1125. }
  1126. entries_.erase(keep, entries_.end());
  1127. }
  1128. return make_iter(from, npos());
  1129. }
  1130. friend bool operator==(const insertion_ordered_multimap &lhs,
  1131. const insertion_ordered_multimap &rhs) {
  1132. return lhs.entries_ == rhs.entries_;
  1133. }
  1134. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1135. const insertion_ordered_multimap &rhs) {
  1136. return !(lhs == rhs);
  1137. }
  1138. private:
  1139. size_type index_of(const std::string &key) const {
  1140. for (size_type i = 0; i < entries_.size(); i++) {
  1141. if (keys_equal(entries_[i].first, key)) { return i; }
  1142. }
  1143. return npos();
  1144. }
  1145. iterator make_iter(size_type idx, size_type key_idx) {
  1146. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1147. }
  1148. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1149. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1150. }
  1151. std::vector<value_type> entries_;
  1152. };
  1153. } // namespace detail
  1154. using Headers =
  1155. detail::insertion_ordered_multimap<std::string,
  1156. detail::case_ignore::equal_to>;
  1157. // Query parameter names are case-sensitive, unlike header field names.
  1158. using Params =
  1159. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1160. using Match = std::smatch;
  1161. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1162. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1163. /*
  1164. * detail: type-erased storage used by UserData.
  1165. * ABI-stable regardless of C++ standard — always uses this custom
  1166. * implementation instead of std::any.
  1167. */
  1168. namespace detail {
  1169. using any_type_id = const void *;
  1170. template <typename T> any_type_id any_typeid() noexcept {
  1171. static const char id = 0;
  1172. return &id;
  1173. }
  1174. struct any_storage {
  1175. virtual ~any_storage() = default;
  1176. virtual std::unique_ptr<any_storage> clone() const = 0;
  1177. virtual any_type_id type_id() const noexcept = 0;
  1178. };
  1179. template <typename T> struct any_value final : any_storage {
  1180. T value;
  1181. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1182. std::unique_ptr<any_storage> clone() const override {
  1183. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1184. }
  1185. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1186. };
  1187. } // namespace detail
  1188. class UserData {
  1189. public:
  1190. UserData() = default;
  1191. UserData(UserData &&) noexcept = default;
  1192. UserData &operator=(UserData &&) noexcept = default;
  1193. UserData(const UserData &o) {
  1194. for (const auto &e : o.entries_) {
  1195. if (e.second) { entries_[e.first] = e.second->clone(); }
  1196. }
  1197. }
  1198. UserData &operator=(const UserData &o) {
  1199. if (this != &o) {
  1200. entries_.clear();
  1201. for (const auto &e : o.entries_) {
  1202. if (e.second) { entries_[e.first] = e.second->clone(); }
  1203. }
  1204. }
  1205. return *this;
  1206. }
  1207. template <typename T> void set(const std::string &key, T &&value) {
  1208. using D = typename std::decay<T>::type;
  1209. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1210. }
  1211. template <typename T> T *get(const std::string &key) noexcept {
  1212. auto it = entries_.find(key);
  1213. if (it == entries_.end() || !it->second) { return nullptr; }
  1214. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1215. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1216. }
  1217. template <typename T> const T *get(const std::string &key) const noexcept {
  1218. auto it = entries_.find(key);
  1219. if (it == entries_.end() || !it->second) { return nullptr; }
  1220. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1221. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1222. }
  1223. bool has(const std::string &key) const noexcept {
  1224. return entries_.find(key) != entries_.end();
  1225. }
  1226. void erase(const std::string &key) { entries_.erase(key); }
  1227. void clear() noexcept { entries_.clear(); }
  1228. private:
  1229. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1230. entries_;
  1231. };
  1232. struct Response;
  1233. using ResponseHandler = std::function<bool(const Response &response)>;
  1234. struct FormData {
  1235. std::string name;
  1236. std::string content;
  1237. std::string filename;
  1238. std::string content_type;
  1239. Headers headers;
  1240. };
  1241. struct FormField {
  1242. std::string name;
  1243. std::string content;
  1244. Headers headers;
  1245. };
  1246. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1247. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1248. // should see the parts as they were sent. A std::multimap sorts by field name
  1249. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1250. // than the case-insensitive predicate Headers uses.
  1251. using FormFields =
  1252. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1253. using FormFiles =
  1254. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1255. struct MultipartFormData {
  1256. FormFields fields; // Text fields from multipart
  1257. FormFiles files; // Files from multipart
  1258. // Text field access
  1259. std::string get_field(const std::string &key, size_t id = 0) const;
  1260. std::vector<std::string> get_fields(const std::string &key) const;
  1261. bool has_field(const std::string &key) const;
  1262. size_t get_field_count(const std::string &key) const;
  1263. // File access
  1264. FormData get_file(const std::string &key, size_t id = 0) const;
  1265. std::vector<FormData> get_files(const std::string &key) const;
  1266. bool has_file(const std::string &key) const;
  1267. size_t get_file_count(const std::string &key) const;
  1268. };
  1269. struct UploadFormData {
  1270. std::string name;
  1271. std::string content;
  1272. std::string filename;
  1273. std::string content_type;
  1274. };
  1275. using UploadFormDataItems = std::vector<UploadFormData>;
  1276. class DataSink {
  1277. public:
  1278. DataSink() : os(&sb_), sb_(*this) {}
  1279. DataSink(const DataSink &) = delete;
  1280. DataSink &operator=(const DataSink &) = delete;
  1281. DataSink(DataSink &&) = delete;
  1282. DataSink &operator=(DataSink &&) = delete;
  1283. std::function<bool(const char *data, size_t data_len)> write;
  1284. // Only `write` is mandatory. The rest are defaulted so that a provider
  1285. // calling one on a writer that does not set it gets sensible behaviour
  1286. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1287. // `this` is safe: DataSink is neither copyable nor movable.
  1288. std::function<bool()> is_writable = []() { return true; };
  1289. std::function<void()> done = []() {};
  1290. std::function<void(const Headers &trailer)> done_with_trailer =
  1291. [this](const Headers & /*trailer*/) { done(); };
  1292. std::ostream os;
  1293. private:
  1294. class data_sink_streambuf final : public std::streambuf {
  1295. public:
  1296. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1297. protected:
  1298. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1299. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1300. return 0;
  1301. }
  1302. private:
  1303. DataSink &sink_;
  1304. };
  1305. data_sink_streambuf sb_;
  1306. };
  1307. using ContentProvider =
  1308. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1309. using ContentProviderWithoutLength =
  1310. std::function<bool(size_t offset, DataSink &sink)>;
  1311. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1312. struct FormDataProvider {
  1313. std::string name;
  1314. ContentProviderWithoutLength provider;
  1315. std::string filename;
  1316. std::string content_type;
  1317. };
  1318. using FormDataProviderItems = std::vector<FormDataProvider>;
  1319. inline FormDataProvider
  1320. make_file_provider(const std::string &name, const std::string &filepath,
  1321. const std::string &filename = std::string(),
  1322. const std::string &content_type = std::string()) {
  1323. FormDataProvider fdp;
  1324. fdp.name = name;
  1325. fdp.filename = filename.empty() ? filepath : filename;
  1326. fdp.content_type = content_type;
  1327. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1328. std::ifstream f(filepath, std::ios::binary);
  1329. if (!f) { return false; }
  1330. if (offset > 0) {
  1331. f.seekg(static_cast<std::streamoff>(offset));
  1332. if (!f.good()) {
  1333. sink.done();
  1334. return true;
  1335. }
  1336. }
  1337. char buf[8192];
  1338. f.read(buf, sizeof(buf));
  1339. auto n = static_cast<size_t>(f.gcount());
  1340. if (n > 0) { return sink.write(buf, n); }
  1341. sink.done(); // EOF
  1342. return true;
  1343. };
  1344. return fdp;
  1345. }
  1346. inline std::pair<size_t, ContentProvider>
  1347. make_file_body(const std::string &filepath) {
  1348. size_t size = 0;
  1349. {
  1350. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1351. if (!f) { return {0, ContentProvider{}}; }
  1352. size = static_cast<size_t>(f.tellg());
  1353. }
  1354. ContentProvider provider = [filepath](size_t offset, size_t length,
  1355. DataSink &sink) -> bool {
  1356. std::ifstream f(filepath, std::ios::binary);
  1357. if (!f) { return false; }
  1358. f.seekg(static_cast<std::streamoff>(offset));
  1359. if (!f.good()) { return false; }
  1360. char buf[8192];
  1361. while (length > 0) {
  1362. auto to_read = (std::min)(sizeof(buf), length);
  1363. f.read(buf, static_cast<std::streamsize>(to_read));
  1364. auto n = static_cast<size_t>(f.gcount());
  1365. // The file is shorter than the size make_file_body() measured, which the
  1366. // caller has already committed to as Content-Length. The body cannot be
  1367. // completed, so fail as every other error here does.
  1368. if (n == 0) { return false; }
  1369. if (!sink.write(buf, n)) { return false; }
  1370. length -= n;
  1371. }
  1372. return true;
  1373. };
  1374. return {size, std::move(provider)};
  1375. }
  1376. using ContentReceiverWithProgress = std::function<bool(
  1377. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1378. using ContentReceiver =
  1379. std::function<bool(const char *data, size_t data_length)>;
  1380. using FormDataHeader = std::function<bool(const FormData &file)>;
  1381. class ContentReader {
  1382. public:
  1383. using Reader = std::function<bool(ContentReceiver receiver)>;
  1384. using FormDataReader =
  1385. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1386. ContentReader(Reader reader, FormDataReader multipart_reader)
  1387. : reader_(std::move(reader)),
  1388. formdata_reader_(std::move(multipart_reader)) {}
  1389. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1390. return formdata_reader_(std::move(header), std::move(receiver));
  1391. }
  1392. bool operator()(ContentReceiver receiver) const {
  1393. return reader_(std::move(receiver));
  1394. }
  1395. Reader reader_;
  1396. FormDataReader formdata_reader_;
  1397. };
  1398. using Range = std::pair<ssize_t, ssize_t>;
  1399. using Ranges = std::vector<Range>;
  1400. #ifdef CPPHTTPLIB_SSL_ENABLED
  1401. // TLS abstraction layer - public type definitions and API
  1402. namespace tls {
  1403. // Opaque handles (defined as void* for abstraction)
  1404. using ctx_t = void *;
  1405. using session_t = void *;
  1406. using const_session_t = const void *; // For read-only session access
  1407. using cert_t = void *;
  1408. using ca_store_t = void *;
  1409. // TLS versions
  1410. enum class Version {
  1411. TLS1_2 = 0x0303,
  1412. TLS1_3 = 0x0304,
  1413. };
  1414. // Subject Alternative Names (SAN) entry types
  1415. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1416. // SAN entry structure
  1417. struct SanEntry {
  1418. SanType type;
  1419. std::string value;
  1420. };
  1421. // Verification context for certificate verification callback
  1422. struct VerifyContext {
  1423. session_t session; // TLS session handle
  1424. cert_t cert; // Current certificate being verified
  1425. int depth; // Certificate chain depth (0 = leaf)
  1426. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1427. long error_code; // Backend-specific error code (0 = no error)
  1428. const char *error_string; // Human-readable error description
  1429. // Certificate introspection methods
  1430. std::string subject_cn() const;
  1431. std::string issuer_name() const;
  1432. bool check_hostname(const char *hostname) const;
  1433. std::vector<SanEntry> sans() const;
  1434. bool validity(time_t &not_before, time_t &not_after) const;
  1435. std::string serial() const;
  1436. };
  1437. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1438. // TlsError codes for TLS operations (backend-independent)
  1439. enum class ErrorCode : int {
  1440. Success = 0,
  1441. WantRead, // Non-blocking: need to wait for read
  1442. WantWrite, // Non-blocking: need to wait for write
  1443. PeerClosed, // Peer closed the connection
  1444. Fatal, // Unrecoverable error
  1445. SyscallError, // System call error (check sys_errno)
  1446. CertVerifyFailed, // Certificate verification failed
  1447. HostnameMismatch, // Hostname verification failed
  1448. };
  1449. // TLS error information
  1450. struct TlsError {
  1451. ErrorCode code = ErrorCode::Fatal;
  1452. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1453. int sys_errno = 0; // errno when SyscallError
  1454. // Convert verification error code to human-readable string
  1455. static std::string verify_error_to_string(long error_code);
  1456. };
  1457. // RAII wrapper for peer certificate
  1458. class PeerCert {
  1459. public:
  1460. PeerCert();
  1461. PeerCert(PeerCert &&other) noexcept;
  1462. PeerCert &operator=(PeerCert &&other) noexcept;
  1463. ~PeerCert();
  1464. PeerCert(const PeerCert &) = delete;
  1465. PeerCert &operator=(const PeerCert &) = delete;
  1466. explicit operator bool() const;
  1467. std::string subject_cn() const;
  1468. std::string issuer_name() const;
  1469. bool check_hostname(const char *hostname) const;
  1470. std::vector<SanEntry> sans() const;
  1471. bool validity(time_t &not_before, time_t &not_after) const;
  1472. std::string serial() const;
  1473. private:
  1474. explicit PeerCert(cert_t cert);
  1475. cert_t cert_ = nullptr;
  1476. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1477. };
  1478. // Callback for TLS context setup (used by SSLServer constructor)
  1479. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1480. } // namespace tls
  1481. #endif
  1482. struct Request {
  1483. std::string method;
  1484. std::string path;
  1485. std::string matched_route;
  1486. Params params;
  1487. Headers headers;
  1488. Headers trailers;
  1489. std::string body;
  1490. std::string remote_addr;
  1491. int remote_port = -1;
  1492. std::string local_addr;
  1493. int local_port = -1;
  1494. // for server
  1495. std::string version;
  1496. std::string target;
  1497. MultipartFormData form;
  1498. Ranges ranges;
  1499. Match matches;
  1500. std::unordered_map<std::string, std::string> path_params;
  1501. std::function<bool()> is_connection_closed = []() { return true; };
  1502. // for client
  1503. std::vector<std::string> accept_content_types;
  1504. ResponseHandler response_handler;
  1505. ContentReceiverWithProgress content_receiver;
  1506. DownloadProgress download_progress;
  1507. UploadProgress upload_progress;
  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. bool has_param(const std::string &key) const;
  1519. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1520. std::vector<std::string> get_param_values(const std::string &key) const;
  1521. size_t get_param_value_count(const std::string &key) const;
  1522. bool is_multipart_form_data() const;
  1523. // private members...
  1524. bool body_read_started_ = false;
  1525. bool body_consumed_ = false;
  1526. bool expect_100_continue_pending_ = false;
  1527. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1528. size_t content_length_ = 0;
  1529. ContentProvider content_provider_;
  1530. bool is_chunked_content_provider_ = false;
  1531. size_t authorization_count_ = 0;
  1532. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1533. (std::chrono::steady_clock::time_point::min)();
  1534. #ifdef CPPHTTPLIB_SSL_ENABLED
  1535. tls::const_session_t ssl = nullptr;
  1536. tls::PeerCert peer_cert() const;
  1537. std::string sni() const;
  1538. #endif
  1539. };
  1540. namespace detail {
  1541. // Declared up here, away from the rest of the compression helpers, because
  1542. // `Response` stores one.
  1543. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1544. } // namespace detail
  1545. struct Response {
  1546. std::string version;
  1547. int status = -1;
  1548. std::string reason;
  1549. Headers headers;
  1550. Headers trailers;
  1551. std::string body;
  1552. std::string location; // Redirect location
  1553. // User-defined context — set by pre-routing/pre-request handlers and read
  1554. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1555. UserData user_data;
  1556. bool has_header(const std::string &key) const;
  1557. std::string get_header_value(const std::string &key, const char *def = "",
  1558. size_t id = 0) const;
  1559. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1560. size_t id = 0) const;
  1561. size_t get_header_value_count(const std::string &key) const;
  1562. void set_header(const std::string &key, const std::string &val);
  1563. bool has_trailer(const std::string &key) const;
  1564. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1565. size_t get_trailer_value_count(const std::string &key) const;
  1566. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1567. void set_content(const char *s, size_t n, const std::string &content_type);
  1568. void set_content(const std::string &s, const std::string &content_type);
  1569. void set_content(std::string &&s, const std::string &content_type);
  1570. void set_content_provider(
  1571. size_t length, const std::string &content_type, ContentProvider provider,
  1572. ContentProviderResourceReleaser resource_releaser = nullptr);
  1573. void set_content_provider(
  1574. const std::string &content_type, ContentProviderWithoutLength provider,
  1575. ContentProviderResourceReleaser resource_releaser = nullptr);
  1576. void set_chunked_content_provider(
  1577. const std::string &content_type, ContentProviderWithoutLength provider,
  1578. ContentProviderResourceReleaser resource_releaser = nullptr);
  1579. void set_file_content(const std::string &path,
  1580. const std::string &content_type);
  1581. void set_file_content(const std::string &path);
  1582. Response() = default;
  1583. Response(const Response &) = default;
  1584. Response &operator=(const Response &) = default;
  1585. Response(Response &&) = default;
  1586. Response &operator=(Response &&) = default;
  1587. ~Response() {
  1588. if (content_provider_resource_releaser_) {
  1589. content_provider_resource_releaser_(content_provider_success_);
  1590. }
  1591. }
  1592. // private members...
  1593. size_t content_length_ = 0;
  1594. ContentProvider content_provider_;
  1595. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1596. bool is_chunked_content_provider_ = false;
  1597. bool is_file_content_provider_ = false;
  1598. bool content_provider_success_ = false;
  1599. std::string file_content_path_;
  1600. std::string file_content_content_type_;
  1601. // Content coding chosen for the response body, decided once so that the
  1602. // headers and the body cannot disagree: where the file is opened for a
  1603. // file-backed content provider (keeping the ETag honest), and in
  1604. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1605. // for every other kind of response.
  1606. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1607. };
  1608. enum class Error {
  1609. Success = 0,
  1610. Unknown,
  1611. Connection,
  1612. BindIPAddress,
  1613. Read,
  1614. Write,
  1615. ExceedRedirectCount,
  1616. Canceled,
  1617. SSLConnection,
  1618. SSLLoadingCerts,
  1619. SSLServerVerification,
  1620. SSLServerHostnameVerification,
  1621. UnsupportedMultipartBoundaryChars,
  1622. Compression,
  1623. ConnectionTimeout,
  1624. ProxyConnection,
  1625. ConnectionClosed,
  1626. Timeout,
  1627. ResourceExhaustion,
  1628. TooManyFormDataFiles,
  1629. ExceedMaxPayloadSize,
  1630. ExceedUriMaxLength,
  1631. ExceedMaxSocketDescriptorCount,
  1632. InvalidRequestLine,
  1633. InvalidHTTPMethod,
  1634. InvalidHTTPVersion,
  1635. InvalidHeaders,
  1636. MultipartParsing,
  1637. OpenFile,
  1638. Listen,
  1639. GetSockName,
  1640. UnsupportedAddressFamily,
  1641. HTTPParsing,
  1642. InvalidRangeHeader,
  1643. UnsupportedContentEncoding,
  1644. WebSocketHandshake,
  1645. UserCallbackException,
  1646. // For internal use only
  1647. SSLPeerCouldBeClosed_,
  1648. };
  1649. std::string to_string(Error error);
  1650. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1651. class Stream {
  1652. public:
  1653. virtual ~Stream() = default;
  1654. virtual bool is_readable() const = 0;
  1655. virtual bool wait_readable() const = 0;
  1656. virtual bool wait_writable() const = 0;
  1657. virtual bool is_peer_alive() const { return wait_writable(); }
  1658. virtual ssize_t read(char *ptr, size_t size) = 0;
  1659. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1660. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1661. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1662. virtual socket_t socket() const = 0;
  1663. virtual time_t duration() const = 0;
  1664. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1665. (void)sec;
  1666. (void)usec;
  1667. }
  1668. // Bytes already pulled off the socket and sitting in this stream's own
  1669. // buffer. Exposing them lets a line reader scan for a terminator in one
  1670. // pass instead of asking for a byte at a time. A stream that does no
  1671. // buffering of its own reports none, and readers fall back to read().
  1672. virtual const char *buffered_data(size_t &size) const {
  1673. size = 0;
  1674. return nullptr;
  1675. }
  1676. // Discards `size` bytes previously returned by buffered_data().
  1677. virtual void consume_buffered(size_t size) { (void)size; }
  1678. ssize_t write(const char *ptr);
  1679. ssize_t write(const std::string &s);
  1680. Error get_error() const { return error_; }
  1681. protected:
  1682. Error error_ = Error::Success;
  1683. };
  1684. class TaskQueue {
  1685. public:
  1686. TaskQueue() = default;
  1687. virtual ~TaskQueue() = default;
  1688. virtual bool enqueue(std::function<void()> fn) = 0;
  1689. virtual void shutdown() = 0;
  1690. virtual void on_idle() {}
  1691. };
  1692. class ThreadPool final : public TaskQueue {
  1693. public:
  1694. explicit ThreadPool(
  1695. size_t n, size_t max_n = 0, size_t mqr = 0,
  1696. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1697. ThreadPool(const ThreadPool &) = delete;
  1698. ~ThreadPool() override = default;
  1699. bool enqueue(std::function<void()> fn) override;
  1700. void shutdown() override;
  1701. private:
  1702. void worker(bool is_dynamic);
  1703. void move_to_finished(std::thread::id id);
  1704. void cleanup_finished_threads();
  1705. size_t base_thread_count_;
  1706. size_t max_thread_count_;
  1707. size_t max_queued_requests_;
  1708. time_t idle_timeout_sec_;
  1709. size_t idle_thread_count_;
  1710. bool shutdown_;
  1711. std::list<std::function<void()>> jobs_;
  1712. std::vector<std::thread> threads_; // base threads
  1713. std::list<std::thread> dynamic_threads_; // dynamic threads
  1714. std::vector<std::thread>
  1715. finished_threads_; // exited dynamic threads awaiting join
  1716. std::condition_variable cond_;
  1717. std::mutex mutex_;
  1718. };
  1719. using Logger = std::function<void(const Request &, const Response &)>;
  1720. // Forward declaration for Error type
  1721. enum class Error;
  1722. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1723. using SocketOptions = std::function<void(socket_t sock)>;
  1724. void default_socket_options(socket_t sock);
  1725. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1726. const char *status_message(int status);
  1727. std::string to_string(Error error);
  1728. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1729. std::string get_bearer_token_auth(const Request &req);
  1730. namespace detail {
  1731. class MatcherBase {
  1732. public:
  1733. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1734. virtual ~MatcherBase() = default;
  1735. const std::string &pattern() const { return pattern_; }
  1736. // Match request path and populate its matches and
  1737. virtual bool match(Request &request) const = 0;
  1738. private:
  1739. std::string pattern_;
  1740. };
  1741. /**
  1742. * Captures parameters in request path and stores them in Request::path_params
  1743. *
  1744. * Capture name is a substring of a pattern from : to /.
  1745. * The rest of the pattern is matched against the request path directly
  1746. * Parameters are captured starting from the next character after
  1747. * the end of the last matched static pattern fragment until the next /.
  1748. *
  1749. * Example pattern:
  1750. * "/path/fragments/:capture/more/fragments/:second_capture"
  1751. * Static fragments:
  1752. * "/path/fragments/", "more/fragments/"
  1753. *
  1754. * Given the following request path:
  1755. * "/path/fragments/:1/more/fragments/:2"
  1756. * the resulting capture will be
  1757. * {{"capture", "1"}, {"second_capture", "2"}}
  1758. */
  1759. class PathParamsMatcher final : public MatcherBase {
  1760. public:
  1761. PathParamsMatcher(const std::string &pattern);
  1762. bool match(Request &request) const override;
  1763. private:
  1764. // Treat segment separators as the end of path parameter capture
  1765. // Does not need to handle query parameters as they are parsed before path
  1766. // matching
  1767. static constexpr char separator = '/';
  1768. // Contains static path fragments to match against, excluding the '/' after
  1769. // path params
  1770. // Fragments are separated by path params
  1771. std::vector<std::string> static_fragments_;
  1772. // Stores the names of the path parameters to be used as keys in the
  1773. // Request::path_params map
  1774. std::vector<std::string> param_names_;
  1775. };
  1776. /**
  1777. * Performs std::regex_match on request path
  1778. * and stores the result in Request::matches
  1779. *
  1780. * Note that regex match is performed directly on the whole request.
  1781. * This means that wildcard patterns may match multiple path segments with /:
  1782. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1783. */
  1784. class RegexMatcher final : public MatcherBase {
  1785. public:
  1786. RegexMatcher(const std::string &pattern)
  1787. : MatcherBase(pattern), regex_(pattern) {}
  1788. bool match(Request &request) const override;
  1789. private:
  1790. std::regex regex_;
  1791. };
  1792. int close_socket(socket_t sock) noexcept;
  1793. bool is_accept_resource_error();
  1794. bool is_accept_transient_error();
  1795. ssize_t write_headers(Stream &strm, const Headers &headers);
  1796. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1797. time_t usec);
  1798. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1799. const std::string &boundary);
  1800. ContentProvider
  1801. make_multipart_content_provider(const UploadFormDataItems &items,
  1802. const std::string &boundary);
  1803. } // namespace detail
  1804. bool is_valid_multipart_boundary(const std::string &boundary);
  1805. // Serializer for multipart/form-data request bodies. The boundary is owned
  1806. // by the writer so that per-part framing and the final terminator always
  1807. // agree. Field names and filenames are escaped following the WHATWG HTML
  1808. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1809. // in content types.
  1810. class MultipartFormDataWriter {
  1811. public:
  1812. MultipartFormDataWriter();
  1813. // precondition: is_valid_multipart_boundary(boundary)
  1814. explicit MultipartFormDataWriter(std::string boundary);
  1815. const std::string &boundary() const;
  1816. std::string content_type() const;
  1817. // In-memory items -> whole body (known length)
  1818. std::string serialize(const UploadFormDataItems &items) const;
  1819. size_t content_length(const UploadFormDataItems &items) const;
  1820. // Per-part framing for streaming via a content provider
  1821. std::string item_begin(const UploadFormData &item) const;
  1822. static std::string item_end();
  1823. std::string finish() const;
  1824. private:
  1825. std::string boundary_;
  1826. };
  1827. class Server {
  1828. public:
  1829. using Handler = std::function<void(const Request &, Response &)>;
  1830. using ExceptionHandler =
  1831. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1832. enum class HandlerResponse {
  1833. Handled,
  1834. Unhandled,
  1835. };
  1836. using HandlerWithResponse =
  1837. std::function<HandlerResponse(const Request &, Response &)>;
  1838. using HandlerWithContentReader = std::function<void(
  1839. const Request &, Response &, const ContentReader &content_reader)>;
  1840. using Expect100ContinueHandler =
  1841. std::function<int(const Request &, Response &)>;
  1842. using StartHandler = std::function<void()>;
  1843. using WebSocketHandler =
  1844. std::function<void(const Request &, ws::WebSocket &)>;
  1845. using SubProtocolSelector =
  1846. std::function<std::string(const std::vector<std::string> &protocols)>;
  1847. Server();
  1848. virtual ~Server();
  1849. virtual bool is_valid() const;
  1850. Server &Get(const std::string &pattern, Handler handler);
  1851. Server &Post(const std::string &pattern, Handler handler);
  1852. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1853. Server &Put(const std::string &pattern, Handler handler);
  1854. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1855. Server &Patch(const std::string &pattern, Handler handler);
  1856. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1857. Server &Delete(const std::string &pattern, Handler handler);
  1858. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1859. Server &Options(const std::string &pattern, Handler handler);
  1860. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1861. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1862. // server accept it; an unregistered method is still rejected with 400.
  1863. // `method` must be a valid HTTP method token and must not be one of the
  1864. // built-in methods, which have their own registration functions above. A
  1865. // rejected registration makes is_valid() return false, so listen() fails.
  1866. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1867. Handler handler);
  1868. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1869. HandlerWithContentReader handler);
  1870. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1871. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1872. SubProtocolSelector sub_protocol_selector);
  1873. bool set_base_dir(const std::string &dir,
  1874. const std::string &mount_point = std::string());
  1875. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1876. Headers headers = Headers());
  1877. bool remove_mount_point(const std::string &mount_point);
  1878. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1879. const std::string &mime);
  1880. Server &set_default_file_mimetype(const std::string &mime);
  1881. Server &set_file_request_handler(Handler handler);
  1882. template <class ErrorHandlerFunc>
  1883. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1884. return set_error_handler_core(
  1885. std::forward<ErrorHandlerFunc>(handler),
  1886. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1887. }
  1888. Server &set_exception_handler(ExceptionHandler handler);
  1889. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1890. Server &set_post_routing_handler(Handler handler);
  1891. Server &set_pre_request_handler(HandlerWithResponse handler);
  1892. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1893. Server &set_start_handler(StartHandler handler);
  1894. Server &set_logger(Logger logger);
  1895. Server &set_pre_compression_logger(Logger logger);
  1896. Server &set_error_logger(ErrorLogger error_logger);
  1897. Server &set_address_family(int family);
  1898. Server &set_tcp_nodelay(bool on);
  1899. Server &set_ipv6_v6only(bool on);
  1900. Server &set_socket_options(SocketOptions socket_options);
  1901. Server &set_default_headers(Headers headers);
  1902. Server &
  1903. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1904. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1905. Server &set_keep_alive_max_count(size_t count);
  1906. Server &set_keep_alive_timeout(time_t sec);
  1907. template <class Rep, class Period>
  1908. Server &
  1909. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1910. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1911. template <class Rep, class Period>
  1912. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1913. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1914. template <class Rep, class Period>
  1915. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1916. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1917. template <class Rep, class Period>
  1918. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1919. Server &set_payload_max_length(size_t length);
  1920. Server &set_static_file_compression(bool on);
  1921. Server &set_static_file_compression_min_length(size_t length);
  1922. Server &set_static_file_compression_max_length(size_t length);
  1923. Server &set_websocket_ping_interval(time_t sec);
  1924. template <class Rep, class Period>
  1925. Server &set_websocket_ping_interval(
  1926. const std::chrono::duration<Rep, Period> &duration);
  1927. Server &set_websocket_max_missed_pongs(int count);
  1928. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1929. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1930. bool listen_after_bind();
  1931. bool listen(const std::string &host, int port, int socket_flags = 0);
  1932. bool is_running() const;
  1933. void wait_until_ready() const;
  1934. void stop() noexcept;
  1935. void decommission();
  1936. std::function<TaskQueue *(void)> new_task_queue;
  1937. protected:
  1938. bool process_request(Stream &strm, const std::string &remote_addr,
  1939. int remote_port, const std::string &local_addr,
  1940. int local_port, bool close_connection,
  1941. bool &connection_closed,
  1942. const std::function<void(Request &)> &setup_request,
  1943. bool *websocket_upgraded = nullptr);
  1944. // Runs the per-connection serving loop and stops an exception thrown by a
  1945. // user callback from escaping the worker thread.
  1946. //
  1947. // process_request() wraps only routing() in a try/catch. Content providers,
  1948. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1949. // handlers all run outside it, and the task queue calls the job without a
  1950. // catch, so an exception from any of those would terminate the process.
  1951. //
  1952. // No 500 is possible here: by the time a content provider runs, the status
  1953. // line and headers are already on the wire. Report it through the error
  1954. // logger and drop the connection, which is what the peer observes either
  1955. // way. Other connections are unaffected.
  1956. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1957. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1958. return serve();
  1959. #else
  1960. try {
  1961. return serve();
  1962. } catch (...) {
  1963. // The error logger is a user callback too, so it must not be able to
  1964. // throw the guard back open.
  1965. try {
  1966. output_error_log(Error::UserCallbackException, nullptr);
  1967. } catch (...) {}
  1968. return false;
  1969. }
  1970. #endif
  1971. }
  1972. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1973. std::vector<std::string> trusted_proxies_;
  1974. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1975. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1976. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1977. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1978. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1979. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1980. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1981. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1982. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1983. bool static_file_compression_ = false;
  1984. size_t static_file_compression_min_length_ =
  1985. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1986. size_t static_file_compression_max_length_ =
  1987. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1988. time_t websocket_ping_interval_sec_ =
  1989. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1990. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1991. private:
  1992. using Handlers =
  1993. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1994. using HandlersForContentReader =
  1995. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1996. HandlerWithContentReader>>;
  1997. // Both handler tables for one custom method live in a single entry, so that
  1998. // routing() needs only one map lookup per request to reach either of them.
  1999. struct CustomHandlerEntry {
  2000. Handlers handlers;
  2001. HandlersForContentReader handlers_for_content_reader;
  2002. };
  2003. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2004. static std::unique_ptr<detail::MatcherBase>
  2005. make_matcher(const std::string &pattern);
  2006. static const std::set<std::string> &builtin_methods();
  2007. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2008. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2009. template <typename H>
  2010. Server &add_handler(
  2011. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2012. const std::string &pattern, H handler) {
  2013. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2014. return *this;
  2015. }
  2016. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2017. Server &set_error_handler_core(Handler handler, std::false_type);
  2018. socket_t create_server_socket(const std::string &host, int port,
  2019. int socket_flags,
  2020. SocketOptions socket_options) const;
  2021. int bind_internal(const std::string &host, int port, int socket_flags);
  2022. bool listen_internal();
  2023. bool routing(Request &req, Response &res, Stream &strm);
  2024. bool handle_file_request(Request &req, Response &res);
  2025. bool check_if_not_modified(const Request &req, Response &res,
  2026. const std::string &etag, time_t mtime) const;
  2027. bool check_if_range(Request &req, const std::string &etag,
  2028. time_t mtime) const;
  2029. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2030. Stream &strm);
  2031. bool dispatch_request_for_content_reader(
  2032. Request &req, Response &res, ContentReader content_reader,
  2033. const HandlersForContentReader &handlers) const;
  2034. bool parse_request_line(const char *s, Request &req) const;
  2035. detail::EncodingType static_file_encoding(const Request &req,
  2036. const Response &res,
  2037. const std::string &content_type,
  2038. size_t length) const;
  2039. bool apply_static_file_compression(const Request &req, Response &res) const;
  2040. void apply_ranges(const Request &req, Response &res,
  2041. std::string &content_type, std::string &boundary) const;
  2042. bool write_response(Stream &strm, bool close_connection, Request &req,
  2043. Response &res);
  2044. bool write_response_with_content(Stream &strm, bool close_connection,
  2045. const Request &req, Response &res);
  2046. bool write_response_core(Stream &strm, bool close_connection,
  2047. const Request &req, Response &res,
  2048. bool need_apply_ranges);
  2049. bool write_content_with_provider(Stream &strm, const Request &req,
  2050. Response &res, const std::string &boundary,
  2051. const std::string &content_type);
  2052. bool read_content(Stream &strm, Request &req, Response &res);
  2053. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2054. Response &res,
  2055. ContentReceiver receiver,
  2056. FormDataHeader multipart_header,
  2057. ContentReceiver multipart_receiver);
  2058. bool read_content_core(Stream &strm, Request &req, Response &res,
  2059. ContentReceiver receiver,
  2060. FormDataHeader multipart_header,
  2061. ContentReceiver multipart_receiver) const;
  2062. virtual bool process_and_close_socket(socket_t sock);
  2063. void output_log(const Request &req, const Response &res) const;
  2064. void output_pre_compression_log(const Request &req,
  2065. const Response &res) const;
  2066. void output_error_log(const Error &err, const Request *req) const;
  2067. std::atomic<bool> is_running_{false};
  2068. std::atomic<bool> is_decommissioned{false};
  2069. // Set when CustomRoute() refuses a registration. Written before listen(),
  2070. // read by is_valid() on the same thread, so it needs no synchronization.
  2071. bool has_invalid_registration_ = false;
  2072. struct MountPointEntry {
  2073. std::string mount_point;
  2074. std::string base_dir;
  2075. std::string resolved_base_dir;
  2076. Headers headers;
  2077. };
  2078. std::vector<MountPointEntry> base_dirs_;
  2079. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2080. std::string default_file_mimetype_ = "application/octet-stream";
  2081. Handler file_request_handler_;
  2082. Handlers get_handlers_;
  2083. Handlers post_handlers_;
  2084. HandlersForContentReader post_handlers_for_content_reader_;
  2085. Handlers put_handlers_;
  2086. HandlersForContentReader put_handlers_for_content_reader_;
  2087. Handlers patch_handlers_;
  2088. HandlersForContentReader patch_handlers_for_content_reader_;
  2089. Handlers delete_handlers_;
  2090. HandlersForContentReader delete_handlers_for_content_reader_;
  2091. Handlers options_handlers_;
  2092. CustomHandlers custom_handlers_;
  2093. struct WebSocketHandlerEntry {
  2094. std::unique_ptr<detail::MatcherBase> matcher;
  2095. WebSocketHandler handler;
  2096. SubProtocolSelector sub_protocol_selector;
  2097. };
  2098. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2099. WebSocketHandlers websocket_handlers_;
  2100. HandlerWithResponse error_handler_;
  2101. ExceptionHandler exception_handler_;
  2102. HandlerWithResponse pre_routing_handler_;
  2103. Handler post_routing_handler_;
  2104. HandlerWithResponse pre_request_handler_;
  2105. Expect100ContinueHandler expect_100_continue_handler_;
  2106. StartHandler start_handler_;
  2107. mutable std::mutex logger_mutex_;
  2108. Logger logger_;
  2109. Logger pre_compression_logger_;
  2110. ErrorLogger error_logger_;
  2111. int address_family_ = AF_UNSPEC;
  2112. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2113. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2114. SocketOptions socket_options_ = default_socket_options;
  2115. Headers default_headers_;
  2116. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2117. detail::write_headers;
  2118. };
  2119. class Result {
  2120. public:
  2121. Result() = default;
  2122. Result(std::unique_ptr<Response> &&res, Error err,
  2123. Headers &&request_headers = Headers{})
  2124. : res_(std::move(res)), err_(err),
  2125. request_headers_(std::move(request_headers)) {}
  2126. // Response
  2127. operator bool() const { return res_ != nullptr; }
  2128. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2129. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2130. const Response &value() const { return *res_; }
  2131. Response &value() { return *res_; }
  2132. const Response &operator*() const { return *res_; }
  2133. Response &operator*() { return *res_; }
  2134. const Response *operator->() const { return res_.get(); }
  2135. Response *operator->() { return res_.get(); }
  2136. // Error
  2137. Error error() const { return err_; }
  2138. // Request Headers
  2139. bool has_request_header(const std::string &key) const;
  2140. std::string get_request_header_value(const std::string &key,
  2141. const char *def = "",
  2142. size_t id = 0) const;
  2143. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2144. size_t id = 0) const;
  2145. size_t get_request_header_value_count(const std::string &key) const;
  2146. private:
  2147. std::unique_ptr<Response> res_;
  2148. Error err_ = Error::Unknown;
  2149. Headers request_headers_;
  2150. #ifdef CPPHTTPLIB_SSL_ENABLED
  2151. public:
  2152. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2153. int ssl_error)
  2154. : res_(std::move(res)), err_(err),
  2155. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2156. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2157. int ssl_error, uint64_t ssl_backend_error)
  2158. : res_(std::move(res)), err_(err),
  2159. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2160. ssl_backend_error_(ssl_backend_error) {}
  2161. int ssl_error() const { return ssl_error_; }
  2162. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2163. private:
  2164. int ssl_error_ = 0;
  2165. uint64_t ssl_backend_error_ = 0;
  2166. #endif
  2167. };
  2168. struct ClientConnection {
  2169. socket_t sock = INVALID_SOCKET;
  2170. bool is_open() const { return sock != INVALID_SOCKET; }
  2171. ClientConnection() = default;
  2172. ~ClientConnection();
  2173. ClientConnection(const ClientConnection &) = delete;
  2174. ClientConnection &operator=(const ClientConnection &) = delete;
  2175. ClientConnection(ClientConnection &&other) noexcept
  2176. : sock(other.sock)
  2177. #ifdef CPPHTTPLIB_SSL_ENABLED
  2178. ,
  2179. session(other.session)
  2180. #endif
  2181. {
  2182. other.sock = INVALID_SOCKET;
  2183. #ifdef CPPHTTPLIB_SSL_ENABLED
  2184. other.session = nullptr;
  2185. #endif
  2186. }
  2187. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2188. if (this != &other) {
  2189. sock = other.sock;
  2190. other.sock = INVALID_SOCKET;
  2191. #ifdef CPPHTTPLIB_SSL_ENABLED
  2192. session = other.session;
  2193. other.session = nullptr;
  2194. #endif
  2195. }
  2196. return *this;
  2197. }
  2198. #ifdef CPPHTTPLIB_SSL_ENABLED
  2199. tls::session_t session = nullptr;
  2200. #endif
  2201. };
  2202. namespace detail {
  2203. struct ChunkedDecoder;
  2204. struct BodyReader {
  2205. Stream *stream = nullptr;
  2206. bool has_content_length = false;
  2207. size_t content_length = 0;
  2208. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2209. size_t bytes_read = 0;
  2210. bool chunked = false;
  2211. bool eof = false;
  2212. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2213. Error last_error = Error::Success;
  2214. ssize_t read(char *buf, size_t len);
  2215. bool has_error() const { return last_error != Error::Success; }
  2216. };
  2217. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2218. size_t len) {
  2219. (void)stream;
  2220. return br.read(buf, len);
  2221. }
  2222. class decompressor;
  2223. enum class NoProxyKind {
  2224. Wildcard, // "*"
  2225. HostnameSuffix, // "example.com" or ".example.com"
  2226. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2227. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2228. };
  2229. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2230. // Lets one CIDR matcher cover both families.
  2231. using IPBytes = std::array<uint8_t, 16>;
  2232. struct NoProxyEntry {
  2233. NoProxyKind kind = NoProxyKind::Wildcard;
  2234. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2235. IPBytes net{};
  2236. int prefix_bits = 0;
  2237. };
  2238. struct NormalizedTarget {
  2239. std::string hostname; // lowercase; brackets and trailing dot removed
  2240. bool is_ipv4 = false;
  2241. bool is_ipv6 = false;
  2242. IPBytes ip{};
  2243. };
  2244. } // namespace detail
  2245. class ClientImpl {
  2246. public:
  2247. explicit ClientImpl(const std::string &host);
  2248. explicit ClientImpl(const std::string &host, int port);
  2249. explicit ClientImpl(const std::string &host, int port,
  2250. const std::string &client_cert_path,
  2251. const std::string &client_key_path);
  2252. virtual ~ClientImpl();
  2253. virtual bool is_valid() const;
  2254. struct StreamHandle {
  2255. std::unique_ptr<Response> response;
  2256. Error error = Error::Success;
  2257. StreamHandle() = default;
  2258. StreamHandle(const StreamHandle &) = delete;
  2259. StreamHandle &operator=(const StreamHandle &) = delete;
  2260. StreamHandle(StreamHandle &&) = default;
  2261. StreamHandle &operator=(StreamHandle &&) = default;
  2262. ~StreamHandle() = default;
  2263. bool is_valid() const {
  2264. return response != nullptr && error == Error::Success;
  2265. }
  2266. ssize_t read(char *buf, size_t len);
  2267. void parse_trailers_if_needed();
  2268. Error get_read_error() const { return body_reader_.last_error; }
  2269. bool has_read_error() const { return body_reader_.has_error(); }
  2270. bool trailers_parsed_ = false;
  2271. private:
  2272. friend class ClientImpl;
  2273. ssize_t read_with_decompression(char *buf, size_t len);
  2274. std::unique_ptr<ClientConnection> connection_;
  2275. std::unique_ptr<Stream> socket_stream_;
  2276. Stream *stream_ = nullptr;
  2277. detail::BodyReader body_reader_;
  2278. std::unique_ptr<detail::decompressor> decompressor_;
  2279. std::string decompress_buffer_;
  2280. size_t decompress_offset_ = 0;
  2281. size_t decompressed_bytes_read_ = 0;
  2282. };
  2283. // clang-format off
  2284. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2285. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2286. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2287. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2288. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2289. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2290. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2291. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2292. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2293. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2294. Result Head(const std::string &path);
  2295. Result Head(const std::string &path, const Headers &headers);
  2296. Result Post(const std::string &path);
  2297. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2298. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2299. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2300. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2301. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2302. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2303. Result Post(const std::string &path, const Params &params);
  2304. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2305. Result Post(const std::string &path, const Headers &headers);
  2306. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2307. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2308. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2309. 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);
  2310. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2311. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2312. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2313. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2314. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2315. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2316. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2317. Result Put(const std::string &path);
  2318. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2319. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2320. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2321. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2322. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2323. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2324. Result Put(const std::string &path, const Params &params);
  2325. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2326. Result Put(const std::string &path, const Headers &headers);
  2327. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2328. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2329. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2330. 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);
  2331. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2332. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2333. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2334. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2335. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2336. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2337. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2338. Result Patch(const std::string &path);
  2339. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2340. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2341. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2342. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2343. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2344. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2345. Result Patch(const std::string &path, const Params &params);
  2346. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2347. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2348. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2349. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2350. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2351. 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);
  2352. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2353. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2354. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2355. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2356. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2357. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2358. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2359. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2360. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2361. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2362. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2363. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2364. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2365. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2366. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2367. Result Options(const std::string &path);
  2368. Result Options(const std::string &path, const Headers &headers);
  2369. // clang-format on
  2370. // Streaming API: Open a stream for reading response body incrementally
  2371. // Socket ownership is transferred to StreamHandle for true streaming
  2372. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2373. StreamHandle open_stream(const std::string &method, const std::string &path,
  2374. const Params &params = {},
  2375. const Headers &headers = {},
  2376. const std::string &body = {},
  2377. const std::string &content_type = {});
  2378. bool send(Request &req, Response &res, Error &error);
  2379. Result send(const Request &req);
  2380. void stop();
  2381. std::string host() const;
  2382. int port() const;
  2383. size_t is_socket_open() const;
  2384. socket_t socket() const;
  2385. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2386. void set_default_headers(Headers headers);
  2387. void
  2388. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2389. void set_address_family(int family);
  2390. void set_tcp_nodelay(bool on);
  2391. void set_ipv6_v6only(bool on);
  2392. void set_socket_options(SocketOptions socket_options);
  2393. void set_connection_timeout(time_t sec, time_t usec = 0);
  2394. template <class Rep, class Period>
  2395. void
  2396. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2397. void set_read_timeout(time_t sec, time_t usec = 0);
  2398. template <class Rep, class Period>
  2399. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2400. void set_write_timeout(time_t sec, time_t usec = 0);
  2401. template <class Rep, class Period>
  2402. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2403. void set_max_timeout(time_t msec);
  2404. template <class Rep, class Period>
  2405. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2406. void set_basic_auth(const std::string &username, const std::string &password);
  2407. void set_bearer_token_auth(const std::string &token);
  2408. void set_keep_alive(bool on);
  2409. void set_follow_location(bool on);
  2410. void set_path_encode(bool on);
  2411. void set_compress(bool on);
  2412. void set_decompress(bool on);
  2413. void set_payload_max_length(size_t length);
  2414. void set_interface(const std::string &intf);
  2415. void set_proxy(const std::string &host, int port);
  2416. void set_proxy_basic_auth(const std::string &username,
  2417. const std::string &password);
  2418. void set_proxy_bearer_token_auth(const std::string &token);
  2419. void set_no_proxy(const std::vector<std::string> &patterns);
  2420. void set_logger(Logger logger);
  2421. void set_error_logger(ErrorLogger error_logger);
  2422. protected:
  2423. struct Socket {
  2424. socket_t sock = INVALID_SOCKET;
  2425. // For Mbed TLS compatibility: start_time for request timeout tracking
  2426. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2427. bool is_open() const { return sock != INVALID_SOCKET; }
  2428. #ifdef CPPHTTPLIB_SSL_ENABLED
  2429. tls::session_t ssl = nullptr;
  2430. #endif
  2431. };
  2432. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2433. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2434. virtual bool setup_proxy_connection(
  2435. Socket &socket,
  2436. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2437. Response &res, bool &success, Error &error);
  2438. bool is_proxy_enabled_for_host(const std::string &host) const;
  2439. // All of:
  2440. // shutdown_ssl
  2441. // shutdown_socket
  2442. // close_socket
  2443. // disconnect
  2444. // should ONLY be called when socket_mutex_ is locked, and only when
  2445. // no other thread is using the socket.
  2446. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2447. void shutdown_socket(Socket &socket) const;
  2448. void close_socket(Socket &socket);
  2449. void disconnect(bool gracefully);
  2450. bool process_request(Stream &strm, Request &req, Response &res,
  2451. bool close_connection, Error &error);
  2452. bool write_content_with_provider(Stream &strm, const Request &req,
  2453. Error &error) const;
  2454. void copy_settings(const ClientImpl &rhs);
  2455. void output_log(const Request &req, const Response &res) const;
  2456. void output_error_log(const Error &err, const Request *req) const;
  2457. // Socket endpoint information
  2458. const std::string host_;
  2459. const int port_;
  2460. // Current open socket
  2461. Socket socket_;
  2462. mutable std::mutex socket_mutex_;
  2463. std::recursive_mutex request_mutex_;
  2464. // These are all protected under socket_mutex
  2465. size_t socket_requests_in_flight_ = 0;
  2466. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2467. bool socket_should_be_closed_when_request_is_done_ = false;
  2468. // Hostname to connection target map. The value is an IP literal or another
  2469. // hostname; only the connection target changes, never the identity.
  2470. std::map<std::string, std::string> addr_map_;
  2471. // Default headers
  2472. Headers default_headers_;
  2473. // Header writer
  2474. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2475. detail::write_headers;
  2476. // Settings
  2477. std::string client_cert_path_;
  2478. std::string client_key_path_;
  2479. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2480. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2481. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2482. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2483. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2484. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2485. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2486. std::string basic_auth_username_;
  2487. std::string basic_auth_password_;
  2488. std::string bearer_token_auth_token_;
  2489. bool keep_alive_ = false;
  2490. bool follow_location_ = false;
  2491. bool path_encode_ = true;
  2492. int address_family_ = AF_UNSPEC;
  2493. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2494. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2495. SocketOptions socket_options_ = nullptr;
  2496. bool compress_ = false;
  2497. bool decompress_ = true;
  2498. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2499. bool has_payload_max_length_ = false;
  2500. std::string interface_;
  2501. std::string proxy_host_;
  2502. int proxy_port_ = -1;
  2503. std::string proxy_basic_auth_username_;
  2504. std::string proxy_basic_auth_password_;
  2505. std::string proxy_bearer_token_auth_token_;
  2506. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2507. mutable detail::NormalizedTarget host_normalized_;
  2508. mutable bool host_normalized_valid_ = false;
  2509. mutable std::mutex logger_mutex_;
  2510. Logger logger_;
  2511. ErrorLogger error_logger_;
  2512. private:
  2513. bool send_(Request &req, Response &res, Error &error);
  2514. Result send_(Request &&req);
  2515. socket_t create_client_socket(Error &error) const;
  2516. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2517. bool skip_100_continue = true) const;
  2518. bool write_request(Stream &strm, Request &req, bool close_connection,
  2519. Error &error, bool skip_body, bool &rejected_locally);
  2520. bool write_request_body(Stream &strm, Request &req, Error &error);
  2521. void prepare_default_headers(Request &r, bool for_stream,
  2522. const std::string &ct);
  2523. bool redirect(Request &req, Response &res, Error &error);
  2524. bool create_redirect_client(const std::string &scheme,
  2525. const std::string &host, int port, Request &req,
  2526. Response &res, const std::string &path,
  2527. const std::string &location, Error &error);
  2528. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2529. bool handle_request(Stream &strm, Request &req, Response &res,
  2530. bool close_connection, Error &error);
  2531. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2532. Request &req, const char *body, size_t content_length,
  2533. ContentProvider content_provider,
  2534. ContentProviderWithoutLength content_provider_without_length,
  2535. const std::string &content_type, ContentReceiver content_receiver,
  2536. Error &error);
  2537. Result send_with_content_provider_and_receiver(
  2538. const std::string &method, const std::string &path,
  2539. const Headers &headers, const char *body, size_t content_length,
  2540. ContentProvider content_provider,
  2541. ContentProviderWithoutLength content_provider_without_length,
  2542. const std::string &content_type, ContentReceiver content_receiver,
  2543. UploadProgress progress);
  2544. ContentProviderWithoutLength get_multipart_content_provider(
  2545. const std::string &boundary, const UploadFormDataItems &items,
  2546. const FormDataProviderItems &provider_items) const;
  2547. virtual bool
  2548. process_socket(const Socket &socket,
  2549. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2550. std::function<bool(Stream &strm)> callback);
  2551. virtual bool is_ssl() const;
  2552. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2553. #ifdef CPPHTTPLIB_SSL_ENABLED
  2554. public:
  2555. void set_digest_auth(const std::string &username,
  2556. const std::string &password);
  2557. void set_proxy_digest_auth(const std::string &username,
  2558. const std::string &password);
  2559. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2560. const std::string &ca_cert_dir_path = std::string());
  2561. void enable_server_certificate_verification(bool enabled);
  2562. void enable_server_hostname_verification(bool enabled);
  2563. void enable_system_ca(bool enabled);
  2564. protected:
  2565. std::string digest_auth_username_;
  2566. std::string digest_auth_password_;
  2567. std::string proxy_digest_auth_username_;
  2568. std::string proxy_digest_auth_password_;
  2569. std::string ca_cert_file_path_;
  2570. std::string ca_cert_dir_path_;
  2571. bool server_certificate_verification_ = true;
  2572. bool server_hostname_verification_ = true;
  2573. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2574. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2575. int last_ssl_error_ = 0;
  2576. uint64_t last_backend_error_ = 0;
  2577. #endif
  2578. };
  2579. class Client {
  2580. public:
  2581. // Universal interface
  2582. explicit Client(const std::string &scheme_host_port);
  2583. explicit Client(const std::string &scheme_host_port,
  2584. const std::string &client_cert_path,
  2585. const std::string &client_key_path);
  2586. // HTTP only interface
  2587. explicit Client(const std::string &host, int port);
  2588. explicit Client(const std::string &host, int port,
  2589. const std::string &client_cert_path,
  2590. const std::string &client_key_path);
  2591. Client(Client &&) = default;
  2592. Client &operator=(Client &&) = default;
  2593. ~Client();
  2594. bool is_valid() const;
  2595. // clang-format off
  2596. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2597. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2598. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2599. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2600. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2601. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2602. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2603. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2604. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2605. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2606. Result Head(const std::string &path);
  2607. Result Head(const std::string &path, const Headers &headers);
  2608. Result Post(const std::string &path);
  2609. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2610. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2611. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2612. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2613. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2614. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2615. Result Post(const std::string &path, const Params &params);
  2616. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2617. Result Post(const std::string &path, const Headers &headers);
  2618. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2619. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2620. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2621. 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);
  2622. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2623. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2624. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2625. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2626. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2627. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2628. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2629. Result Put(const std::string &path);
  2630. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2631. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2632. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2633. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2634. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2635. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2636. Result Put(const std::string &path, const Params &params);
  2637. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2638. Result Put(const std::string &path, const Headers &headers);
  2639. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2640. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2641. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2642. 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);
  2643. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2644. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2645. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2646. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2647. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2648. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2649. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2650. Result Patch(const std::string &path);
  2651. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2652. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2653. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2654. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2655. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2656. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2657. Result Patch(const std::string &path, const Params &params);
  2658. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2659. Result Patch(const std::string &path, const Headers &headers);
  2660. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2661. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2662. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2663. 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);
  2664. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2665. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2666. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2667. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2668. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2669. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2670. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2671. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2672. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2673. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2674. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2675. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2676. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2677. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2678. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2679. Result Options(const std::string &path);
  2680. Result Options(const std::string &path, const Headers &headers);
  2681. // clang-format on
  2682. // Streaming API: Open a stream for reading response body incrementally
  2683. // Socket ownership is transferred to StreamHandle for true streaming
  2684. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2685. ClientImpl::StreamHandle open_stream(const std::string &method,
  2686. const std::string &path,
  2687. const Params &params = {},
  2688. const Headers &headers = {},
  2689. const std::string &body = {},
  2690. const std::string &content_type = {});
  2691. bool send(Request &req, Response &res, Error &error);
  2692. Result send(const Request &req);
  2693. void stop();
  2694. std::string host() const;
  2695. int port() const;
  2696. size_t is_socket_open() const;
  2697. socket_t socket() const;
  2698. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2699. void set_default_headers(Headers headers);
  2700. void
  2701. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2702. void set_address_family(int family);
  2703. void set_tcp_nodelay(bool on);
  2704. void set_socket_options(SocketOptions socket_options);
  2705. void set_connection_timeout(time_t sec, time_t usec = 0);
  2706. template <class Rep, class Period>
  2707. void
  2708. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2709. void set_read_timeout(time_t sec, time_t usec = 0);
  2710. template <class Rep, class Period>
  2711. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2712. void set_write_timeout(time_t sec, time_t usec = 0);
  2713. template <class Rep, class Period>
  2714. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2715. void set_max_timeout(time_t msec);
  2716. template <class Rep, class Period>
  2717. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2718. void set_basic_auth(const std::string &username, const std::string &password);
  2719. void set_bearer_token_auth(const std::string &token);
  2720. void set_keep_alive(bool on);
  2721. void set_follow_location(bool on);
  2722. void set_path_encode(bool on);
  2723. void set_compress(bool on);
  2724. void set_decompress(bool on);
  2725. void set_payload_max_length(size_t length);
  2726. void set_interface(const std::string &intf);
  2727. void set_proxy(const std::string &host, int port);
  2728. void set_proxy_basic_auth(const std::string &username,
  2729. const std::string &password);
  2730. void set_proxy_bearer_token_auth(const std::string &token);
  2731. void set_no_proxy(const std::vector<std::string> &patterns);
  2732. void set_logger(Logger logger);
  2733. void set_error_logger(ErrorLogger error_logger);
  2734. private:
  2735. std::unique_ptr<ClientImpl> cli_;
  2736. #ifdef CPPHTTPLIB_SSL_ENABLED
  2737. public:
  2738. void set_digest_auth(const std::string &username,
  2739. const std::string &password);
  2740. void set_proxy_digest_auth(const std::string &username,
  2741. const std::string &password);
  2742. void enable_server_certificate_verification(bool enabled);
  2743. void enable_server_hostname_verification(bool enabled);
  2744. void enable_system_ca(bool enabled);
  2745. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2746. const std::string &ca_cert_dir_path = std::string());
  2747. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2748. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2749. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2750. void set_session_verifier(
  2751. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2752. tls::ctx_t tls_context() const;
  2753. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2754. void enable_windows_certificate_verification(bool enabled);
  2755. #endif
  2756. private:
  2757. bool is_ssl_ = false;
  2758. #endif
  2759. };
  2760. #ifdef CPPHTTPLIB_SSL_ENABLED
  2761. class SSLServer : public Server {
  2762. public:
  2763. SSLServer(const char *cert_path, const char *private_key_path,
  2764. const char *client_ca_cert_file_path = nullptr,
  2765. const char *client_ca_cert_dir_path = nullptr,
  2766. const char *private_key_password = nullptr);
  2767. struct PemMemory {
  2768. const char *cert_pem;
  2769. size_t cert_pem_len;
  2770. const char *key_pem;
  2771. size_t key_pem_len;
  2772. const char *client_ca_pem;
  2773. size_t client_ca_pem_len;
  2774. const char *private_key_password;
  2775. };
  2776. explicit SSLServer(const PemMemory &pem);
  2777. // The callback receives the ctx_t handle which can be cast to the
  2778. // appropriate backend type (SSL_CTX* for OpenSSL,
  2779. // tls::impl::MbedTlsContext* for Mbed TLS)
  2780. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2781. ~SSLServer() override;
  2782. bool is_valid() const override;
  2783. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2784. const char *client_ca_pem = nullptr,
  2785. const char *password = nullptr);
  2786. tls::ctx_t tls_context() const { return ctx_; }
  2787. int ssl_last_error() const { return last_ssl_error_; }
  2788. private:
  2789. bool process_and_close_socket(socket_t sock) override;
  2790. tls::ctx_t ctx_ = nullptr;
  2791. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2792. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2793. // bounds, and new ones wait while it is pending so that they cannot keep it
  2794. // waiting.
  2795. std::mutex ctx_mutex_;
  2796. std::condition_variable ctx_cv_;
  2797. size_t handshakes_in_progress_ = 0;
  2798. size_t updates_pending_ = 0;
  2799. int last_ssl_error_ = 0;
  2800. };
  2801. class SSLClient final : public ClientImpl {
  2802. public:
  2803. explicit SSLClient(const std::string &host);
  2804. explicit SSLClient(const std::string &host, int port);
  2805. explicit SSLClient(const std::string &host, int port,
  2806. const std::string &client_cert_path,
  2807. const std::string &client_key_path,
  2808. const std::string &private_key_password = std::string());
  2809. struct PemMemory {
  2810. const char *cert_pem;
  2811. size_t cert_pem_len;
  2812. const char *key_pem;
  2813. size_t key_pem_len;
  2814. const char *private_key_password;
  2815. };
  2816. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2817. ~SSLClient() override;
  2818. bool is_valid() const override;
  2819. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2820. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2821. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2822. // Post-handshake session verifier (backend-independent)
  2823. void set_session_verifier(
  2824. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2825. tls::ctx_t tls_context() const { return ctx_; }
  2826. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2827. void enable_windows_certificate_verification(bool enabled);
  2828. #endif
  2829. private:
  2830. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2831. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2832. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2833. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2834. bool
  2835. process_socket(const Socket &socket,
  2836. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2837. std::function<bool(Stream &strm)> callback) override;
  2838. bool is_ssl() const override;
  2839. bool setup_proxy_connection(
  2840. Socket &socket,
  2841. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2842. Response &res, bool &success, Error &error) override;
  2843. bool connect_with_proxy(
  2844. Socket &sock,
  2845. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2846. Response &res, bool &success, Error &error);
  2847. bool initialize_ssl(Socket &socket, Error &error);
  2848. void init_ctx();
  2849. void reset_ctx_on_error();
  2850. bool load_certs();
  2851. tls::ctx_t ctx_ = nullptr;
  2852. std::mutex ctx_mutex_;
  2853. std::once_flag initialize_cert_;
  2854. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2855. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2856. // Used to keep custom CA configuration exclusive with system CA loading.
  2857. bool ca_cert_store_set_ = false;
  2858. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2859. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2860. // set_server_certificate_verifier() installed there.
  2861. tls::VerifyCallback server_certificate_verifier_;
  2862. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2863. bool enable_windows_cert_verification_ = true;
  2864. #endif
  2865. friend class ClientImpl;
  2866. };
  2867. #endif // CPPHTTPLIB_SSL_ENABLED
  2868. namespace detail {
  2869. template <typename T, typename U>
  2870. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2871. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2872. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2873. duration - std::chrono::seconds(sec))
  2874. .count();
  2875. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2876. }
  2877. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2878. return N - 1;
  2879. }
  2880. inline bool is_numeric(const std::string &str) {
  2881. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2882. }
  2883. // std::ranges::next(first, n, last) for C++11
  2884. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2885. for (; n > 0 && first != last; --n) {
  2886. ++first;
  2887. }
  2888. return first;
  2889. }
  2890. inline size_t get_header_value_u64(const Headers &headers,
  2891. const std::string &key, size_t def,
  2892. size_t id, bool &is_invalid_value) {
  2893. is_invalid_value = false;
  2894. auto rng = headers.equal_range(key);
  2895. auto it = bounded_next(rng.first, id, rng.second);
  2896. if (it != rng.second) {
  2897. if (is_numeric(it->second)) {
  2898. // Parse at size_t width so an out-of-range Content-Length is reported
  2899. // rather than silently saturated/truncated (a value above 2^32 would
  2900. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2901. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2902. size_t val = 0;
  2903. const auto &s = it->second;
  2904. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2905. if (r.ec == std::errc::result_out_of_range) {
  2906. is_invalid_value = true;
  2907. return (std::numeric_limits<size_t>::max)();
  2908. }
  2909. return val;
  2910. } else {
  2911. is_invalid_value = true;
  2912. }
  2913. }
  2914. return def;
  2915. }
  2916. inline size_t get_header_value_u64(const Headers &headers,
  2917. const std::string &key, size_t def,
  2918. size_t id) {
  2919. auto dummy = false;
  2920. return get_header_value_u64(headers, key, def, id, dummy);
  2921. }
  2922. } // namespace detail
  2923. template <class Rep, class Period>
  2924. inline Server &
  2925. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2926. detail::duration_to_sec_and_usec(
  2927. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2928. return *this;
  2929. }
  2930. template <class Rep, class Period>
  2931. inline Server &
  2932. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2933. detail::duration_to_sec_and_usec(
  2934. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2935. return *this;
  2936. }
  2937. template <class Rep, class Period>
  2938. inline Server &
  2939. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2940. detail::duration_to_sec_and_usec(
  2941. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2942. return *this;
  2943. }
  2944. template <class Rep, class Period>
  2945. inline void ClientImpl::set_connection_timeout(
  2946. const std::chrono::duration<Rep, Period> &duration) {
  2947. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2948. set_connection_timeout(sec, usec);
  2949. });
  2950. }
  2951. template <class Rep, class Period>
  2952. inline void ClientImpl::set_read_timeout(
  2953. const std::chrono::duration<Rep, Period> &duration) {
  2954. detail::duration_to_sec_and_usec(
  2955. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2956. }
  2957. template <class Rep, class Period>
  2958. inline void ClientImpl::set_write_timeout(
  2959. const std::chrono::duration<Rep, Period> &duration) {
  2960. detail::duration_to_sec_and_usec(
  2961. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2962. }
  2963. template <class Rep, class Period>
  2964. inline void ClientImpl::set_max_timeout(
  2965. const std::chrono::duration<Rep, Period> &duration) {
  2966. auto msec =
  2967. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2968. set_max_timeout(msec);
  2969. }
  2970. template <class Rep, class Period>
  2971. inline void Client::set_connection_timeout(
  2972. const std::chrono::duration<Rep, Period> &duration) {
  2973. cli_->set_connection_timeout(duration);
  2974. }
  2975. template <class Rep, class Period>
  2976. inline void
  2977. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2978. cli_->set_read_timeout(duration);
  2979. }
  2980. template <class Rep, class Period>
  2981. inline void
  2982. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2983. cli_->set_write_timeout(duration);
  2984. }
  2985. inline void Client::set_max_timeout(time_t msec) {
  2986. cli_->set_max_timeout(msec);
  2987. }
  2988. template <class Rep, class Period>
  2989. inline void
  2990. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2991. cli_->set_max_timeout(duration);
  2992. }
  2993. /*
  2994. * Forward declarations and types that will be part of the .h file if split into
  2995. * .h + .cc.
  2996. */
  2997. std::string hosted_at(const std::string &hostname);
  2998. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2999. // JavaScript-style URL encoding/decoding functions
  3000. std::string encode_uri_component(const std::string &value);
  3001. std::string encode_uri(const std::string &value);
  3002. std::string decode_uri_component(const std::string &value);
  3003. std::string decode_uri(const std::string &value);
  3004. // RFC 3986 compliant URL component encoding/decoding functions
  3005. std::string encode_path_component(const std::string &component);
  3006. std::string decode_path_component(const std::string &component);
  3007. std::string encode_query_component(const std::string &component,
  3008. bool space_as_plus = true);
  3009. std::string decode_query_component(const std::string &component,
  3010. bool plus_as_space = true);
  3011. std::string sanitize_filename(const std::string &filename);
  3012. std::string append_query_params(const std::string &path, const Params &params);
  3013. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3014. std::pair<std::string, std::string>
  3015. make_basic_authentication_header(const std::string &username,
  3016. const std::string &password,
  3017. bool is_proxy = false);
  3018. namespace detail {
  3019. #if defined(_WIN32)
  3020. inline std::wstring u8string_to_wstring(const char *s) {
  3021. if (!s) { return std::wstring(); }
  3022. auto len = static_cast<int>(strlen(s));
  3023. if (!len) { return std::wstring(); }
  3024. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3025. if (!wlen) { return std::wstring(); }
  3026. std::wstring ws;
  3027. ws.resize(wlen);
  3028. wlen = ::MultiByteToWideChar(
  3029. CP_UTF8, 0, s, len,
  3030. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3031. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3032. return ws;
  3033. }
  3034. #endif
  3035. struct FileStat {
  3036. FileStat(const std::string &path);
  3037. bool is_file() const;
  3038. bool is_dir() const;
  3039. time_t mtime() const;
  3040. size_t size() const;
  3041. private:
  3042. #if defined(_WIN32)
  3043. struct _stat st_;
  3044. #else
  3045. struct stat st_;
  3046. #endif
  3047. int ret_ = -1;
  3048. };
  3049. std::string make_host_and_port_string(const std::string &host, int port,
  3050. bool is_ssl);
  3051. template <typename T>
  3052. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3053. Error &error);
  3054. std::string trim_copy(const std::string &s);
  3055. void divide(
  3056. const char *data, std::size_t size, char d,
  3057. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3058. fn);
  3059. void divide(
  3060. const std::string &str, char d,
  3061. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3062. fn);
  3063. void split(const char *b, const char *e, char d,
  3064. std::function<void(const char *, const char *)> fn);
  3065. void split(const char *b, const char *e, char d, size_t m,
  3066. std::function<void(const char *, const char *)> fn);
  3067. bool split_find(const char *b, const char *e, char d,
  3068. std::function<bool(const char *, const char *)> fn);
  3069. bool has_header_token(const Headers &headers, const std::string &key,
  3070. const std::string &token);
  3071. std::string websocket_accept_key(const std::string &client_key);
  3072. bool is_websocket_upgrade(const Request &req);
  3073. bool process_client_socket(
  3074. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3075. time_t write_timeout_sec, time_t write_timeout_usec,
  3076. time_t max_timeout_msec,
  3077. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3078. std::function<bool(Stream &)> callback);
  3079. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3080. int port, int address_family, bool tcp_nodelay,
  3081. bool ipv6_v6only, SocketOptions socket_options,
  3082. time_t connection_timeout_sec,
  3083. time_t connection_timeout_usec,
  3084. time_t read_timeout_sec, time_t read_timeout_usec,
  3085. time_t write_timeout_sec,
  3086. time_t write_timeout_usec,
  3087. const std::string &intf, Error &error);
  3088. const char *get_header_value(const Headers &headers, const std::string &key,
  3089. const char *def, size_t id);
  3090. std::string get_combined_header_value(const Headers &headers,
  3091. const std::string &key);
  3092. std::string params_to_query_str(const Params &params);
  3093. void parse_query_text(const char *data, std::size_t size, Params &params);
  3094. void parse_query_text(const std::string &s, Params &params);
  3095. bool parse_multipart_boundary(const std::string &content_type,
  3096. std::string &boundary);
  3097. bool parse_range_header(const std::string &s, Ranges &ranges);
  3098. bool parse_accept_header(const std::string &s,
  3099. std::vector<std::string> &content_types);
  3100. void parse_disposition_params(const std::string &s, Params &params);
  3101. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3102. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3103. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3104. EncodingType encoding_type(const Request &req, const Response &res,
  3105. const std::string &content_type);
  3106. EncodingType encoding_type(const Request &req, const Response &res);
  3107. class BufferStream final : public Stream {
  3108. public:
  3109. BufferStream() = default;
  3110. ~BufferStream() override = default;
  3111. bool is_readable() const override;
  3112. bool wait_readable() const override;
  3113. bool wait_writable() const override;
  3114. ssize_t read(char *ptr, size_t size) override;
  3115. ssize_t write(const char *ptr, size_t size) override;
  3116. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3117. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3118. socket_t socket() const override;
  3119. time_t duration() const override;
  3120. const std::string &get_buffer() const;
  3121. private:
  3122. std::string buffer;
  3123. size_t position = 0;
  3124. };
  3125. class compressor {
  3126. public:
  3127. virtual ~compressor() = default;
  3128. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3129. virtual bool compress(const char *data, size_t data_length, bool last,
  3130. Callback callback) = 0;
  3131. };
  3132. class decompressor {
  3133. public:
  3134. virtual ~decompressor() = default;
  3135. virtual bool is_valid() const = 0;
  3136. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3137. virtual bool decompress(const char *data, size_t data_length,
  3138. Callback callback) = 0;
  3139. };
  3140. class nocompressor final : public compressor {
  3141. public:
  3142. ~nocompressor() override = default;
  3143. bool compress(const char *data, size_t data_length, bool /*last*/,
  3144. Callback callback) override;
  3145. };
  3146. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3147. class gzip_compressor final : public compressor {
  3148. public:
  3149. gzip_compressor();
  3150. ~gzip_compressor() override;
  3151. bool compress(const char *data, size_t data_length, bool last,
  3152. Callback callback) override;
  3153. private:
  3154. bool is_valid_ = false;
  3155. z_stream strm_;
  3156. };
  3157. class gzip_decompressor final : public decompressor {
  3158. public:
  3159. gzip_decompressor();
  3160. ~gzip_decompressor() override;
  3161. bool is_valid() const override;
  3162. bool decompress(const char *data, size_t data_length,
  3163. Callback callback) override;
  3164. private:
  3165. bool is_valid_ = false;
  3166. z_stream strm_;
  3167. };
  3168. #endif
  3169. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3170. class brotli_compressor final : public compressor {
  3171. public:
  3172. brotli_compressor();
  3173. ~brotli_compressor();
  3174. bool compress(const char *data, size_t data_length, bool last,
  3175. Callback callback) override;
  3176. private:
  3177. BrotliEncoderState *state_ = nullptr;
  3178. };
  3179. class brotli_decompressor final : public decompressor {
  3180. public:
  3181. brotli_decompressor();
  3182. ~brotli_decompressor();
  3183. bool is_valid() const override;
  3184. bool decompress(const char *data, size_t data_length,
  3185. Callback callback) override;
  3186. private:
  3187. BrotliDecoderResult decoder_r;
  3188. BrotliDecoderState *decoder_s = nullptr;
  3189. };
  3190. #endif
  3191. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3192. class zstd_compressor : public compressor {
  3193. public:
  3194. zstd_compressor();
  3195. ~zstd_compressor();
  3196. bool compress(const char *data, size_t data_length, bool last,
  3197. Callback callback) override;
  3198. private:
  3199. ZSTD_CCtx *ctx_ = nullptr;
  3200. };
  3201. class zstd_decompressor : public decompressor {
  3202. public:
  3203. zstd_decompressor();
  3204. ~zstd_decompressor();
  3205. bool is_valid() const override;
  3206. bool decompress(const char *data, size_t data_length,
  3207. Callback callback) override;
  3208. private:
  3209. ZSTD_DCtx *ctx_ = nullptr;
  3210. };
  3211. #endif
  3212. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3213. // to store data. The call can set memory on stack for performance.
  3214. class stream_line_reader {
  3215. public:
  3216. stream_line_reader(Stream &strm, char *fixed_buffer,
  3217. size_t fixed_buffer_size);
  3218. const char *ptr() const;
  3219. size_t size() const;
  3220. bool end_with_crlf() const;
  3221. bool getline();
  3222. private:
  3223. void append(char c);
  3224. void append(const char *data, size_t size);
  3225. Stream &strm_;
  3226. char *fixed_buffer_;
  3227. const size_t fixed_buffer_size_;
  3228. size_t fixed_buffer_used_size_ = 0;
  3229. std::string growable_buffer_;
  3230. };
  3231. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3232. const Headers &src_headers);
  3233. struct ChunkedDecoder {
  3234. Stream &strm;
  3235. size_t chunk_remaining = 0;
  3236. bool finished = false;
  3237. char line_buf[64];
  3238. size_t last_chunk_total = 0;
  3239. size_t last_chunk_offset = 0;
  3240. explicit ChunkedDecoder(Stream &s);
  3241. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3242. size_t &out_chunk_total);
  3243. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3244. };
  3245. class mmap {
  3246. public:
  3247. mmap(const char *path);
  3248. ~mmap();
  3249. bool open(const char *path);
  3250. void close();
  3251. bool is_open() const;
  3252. size_t size() const;
  3253. const char *data() const;
  3254. private:
  3255. #if defined(_WIN32)
  3256. HANDLE hFile_ = NULL;
  3257. HANDLE hMapping_ = NULL;
  3258. #else
  3259. int fd_ = -1;
  3260. #endif
  3261. size_t size_ = 0;
  3262. void *addr_ = nullptr;
  3263. bool is_open_empty_file = false;
  3264. };
  3265. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3266. namespace fields {
  3267. bool is_token_char(char c);
  3268. bool is_token(const std::string &s);
  3269. bool is_field_name(const std::string &s);
  3270. bool is_vchar(char c);
  3271. bool is_obs_text(char c);
  3272. bool is_field_vchar(char c);
  3273. bool is_field_content(const std::string &s);
  3274. bool is_field_value(const std::string &s);
  3275. bool is_field_valid(const std::string &name, const std::string &value);
  3276. bool is_request_target(const std::string &s);
  3277. bool is_host(const std::string &s);
  3278. } // namespace fields
  3279. } // namespace detail
  3280. /*
  3281. * TLS Abstraction Layer Declarations
  3282. */
  3283. #ifdef CPPHTTPLIB_SSL_ENABLED
  3284. // TLS abstraction layer - backend-specific type declarations
  3285. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3286. namespace tls {
  3287. namespace impl {
  3288. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3289. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3290. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3291. struct MbedTlsContext {
  3292. mbedtls_ssl_config conf;
  3293. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3294. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3295. mbedtls_entropy_context entropy;
  3296. mbedtls_ctr_drbg_context ctr_drbg;
  3297. #endif
  3298. mbedtls_x509_crt ca_chain;
  3299. mbedtls_x509_crt own_cert;
  3300. mbedtls_pk_context own_key;
  3301. bool is_server = false;
  3302. bool verify_client = false;
  3303. VerifyCallback verify_callback;
  3304. MbedTlsContext();
  3305. ~MbedTlsContext();
  3306. MbedTlsContext(const MbedTlsContext &) = delete;
  3307. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3308. };
  3309. } // namespace impl
  3310. } // namespace tls
  3311. #endif
  3312. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3313. namespace tls {
  3314. namespace impl {
  3315. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3316. // This struct is accessible via tls::impl for use in SSL context
  3317. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3318. struct WolfSSLContext {
  3319. WOLFSSL_CTX *ctx = nullptr;
  3320. bool is_server = false;
  3321. bool verify_client = false;
  3322. VerifyCallback verify_callback;
  3323. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3324. WolfSSLContext();
  3325. ~WolfSSLContext();
  3326. WolfSSLContext(const WolfSSLContext &) = delete;
  3327. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3328. };
  3329. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3330. struct WolfSSLCAStore {
  3331. std::string pem_data;
  3332. };
  3333. } // namespace impl
  3334. } // namespace tls
  3335. #endif
  3336. #endif // CPPHTTPLIB_SSL_ENABLED
  3337. namespace stream {
  3338. class Result {
  3339. public:
  3340. Result();
  3341. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3342. Result(Result &&other) noexcept;
  3343. Result &operator=(Result &&other) noexcept;
  3344. Result(const Result &) = delete;
  3345. Result &operator=(const Result &) = delete;
  3346. // Response info
  3347. bool is_valid() const;
  3348. explicit operator bool() const;
  3349. int status() const;
  3350. const Headers &headers() const;
  3351. std::string get_header_value(const std::string &key,
  3352. const char *def = "") const;
  3353. bool has_header(const std::string &key) const;
  3354. Error error() const;
  3355. Error read_error() const;
  3356. bool has_read_error() const;
  3357. // Stream reading
  3358. bool next();
  3359. const char *data() const;
  3360. size_t size() const;
  3361. std::string read_all();
  3362. private:
  3363. ClientImpl::StreamHandle handle_;
  3364. std::string buffer_;
  3365. size_t current_size_ = 0;
  3366. size_t chunk_size_;
  3367. bool finished_ = false;
  3368. };
  3369. // GET
  3370. template <typename ClientType>
  3371. inline Result Get(ClientType &cli, const std::string &path,
  3372. size_t chunk_size = 8192) {
  3373. return Result{cli.open_stream("GET", path), chunk_size};
  3374. }
  3375. template <typename ClientType>
  3376. inline Result Get(ClientType &cli, const std::string &path,
  3377. const Headers &headers, size_t chunk_size = 8192) {
  3378. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3379. }
  3380. template <typename ClientType>
  3381. inline Result Get(ClientType &cli, const std::string &path,
  3382. const Params &params, size_t chunk_size = 8192) {
  3383. return Result{cli.open_stream("GET", path, params), chunk_size};
  3384. }
  3385. template <typename ClientType>
  3386. inline Result Get(ClientType &cli, const std::string &path,
  3387. const Params &params, const Headers &headers,
  3388. size_t chunk_size = 8192) {
  3389. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3390. }
  3391. // POST
  3392. template <typename ClientType>
  3393. inline Result Post(ClientType &cli, const std::string &path,
  3394. const std::string &body, const std::string &content_type,
  3395. size_t chunk_size = 8192) {
  3396. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3397. chunk_size};
  3398. }
  3399. template <typename ClientType>
  3400. inline Result Post(ClientType &cli, const std::string &path,
  3401. const Headers &headers, const std::string &body,
  3402. const std::string &content_type, size_t chunk_size = 8192) {
  3403. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3404. chunk_size};
  3405. }
  3406. template <typename ClientType>
  3407. inline Result Post(ClientType &cli, const std::string &path,
  3408. const Params &params, const std::string &body,
  3409. const std::string &content_type, size_t chunk_size = 8192) {
  3410. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3411. chunk_size};
  3412. }
  3413. template <typename ClientType>
  3414. inline Result Post(ClientType &cli, const std::string &path,
  3415. const Params &params, const Headers &headers,
  3416. const std::string &body, const std::string &content_type,
  3417. size_t chunk_size = 8192) {
  3418. return Result{
  3419. cli.open_stream("POST", path, params, headers, body, content_type),
  3420. chunk_size};
  3421. }
  3422. // PUT
  3423. template <typename ClientType>
  3424. inline Result Put(ClientType &cli, const std::string &path,
  3425. const std::string &body, const std::string &content_type,
  3426. size_t chunk_size = 8192) {
  3427. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3428. chunk_size};
  3429. }
  3430. template <typename ClientType>
  3431. inline Result Put(ClientType &cli, const std::string &path,
  3432. const Headers &headers, const std::string &body,
  3433. const std::string &content_type, size_t chunk_size = 8192) {
  3434. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3435. chunk_size};
  3436. }
  3437. template <typename ClientType>
  3438. inline Result Put(ClientType &cli, const std::string &path,
  3439. const Params &params, const std::string &body,
  3440. const std::string &content_type, size_t chunk_size = 8192) {
  3441. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3442. chunk_size};
  3443. }
  3444. template <typename ClientType>
  3445. inline Result Put(ClientType &cli, const std::string &path,
  3446. const Params &params, const Headers &headers,
  3447. const std::string &body, const std::string &content_type,
  3448. size_t chunk_size = 8192) {
  3449. return Result{
  3450. cli.open_stream("PUT", path, params, headers, body, content_type),
  3451. chunk_size};
  3452. }
  3453. // PATCH
  3454. template <typename ClientType>
  3455. inline Result Patch(ClientType &cli, const std::string &path,
  3456. const std::string &body, const std::string &content_type,
  3457. size_t chunk_size = 8192) {
  3458. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3459. chunk_size};
  3460. }
  3461. template <typename ClientType>
  3462. inline Result Patch(ClientType &cli, const std::string &path,
  3463. const Headers &headers, const std::string &body,
  3464. const std::string &content_type, size_t chunk_size = 8192) {
  3465. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3466. chunk_size};
  3467. }
  3468. template <typename ClientType>
  3469. inline Result Patch(ClientType &cli, const std::string &path,
  3470. const Params &params, const std::string &body,
  3471. const std::string &content_type, size_t chunk_size = 8192) {
  3472. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3473. chunk_size};
  3474. }
  3475. template <typename ClientType>
  3476. inline Result Patch(ClientType &cli, const std::string &path,
  3477. const Params &params, const Headers &headers,
  3478. const std::string &body, const std::string &content_type,
  3479. size_t chunk_size = 8192) {
  3480. return Result{
  3481. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3482. chunk_size};
  3483. }
  3484. // DELETE
  3485. template <typename ClientType>
  3486. inline Result Delete(ClientType &cli, const std::string &path,
  3487. size_t chunk_size = 8192) {
  3488. return Result{cli.open_stream("DELETE", path), chunk_size};
  3489. }
  3490. template <typename ClientType>
  3491. inline Result Delete(ClientType &cli, const std::string &path,
  3492. const Headers &headers, size_t chunk_size = 8192) {
  3493. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3494. }
  3495. template <typename ClientType>
  3496. inline Result Delete(ClientType &cli, const std::string &path,
  3497. const std::string &body, const std::string &content_type,
  3498. size_t chunk_size = 8192) {
  3499. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3500. chunk_size};
  3501. }
  3502. template <typename ClientType>
  3503. inline Result Delete(ClientType &cli, const std::string &path,
  3504. const Headers &headers, const std::string &body,
  3505. const std::string &content_type,
  3506. size_t chunk_size = 8192) {
  3507. return Result{
  3508. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3509. chunk_size};
  3510. }
  3511. template <typename ClientType>
  3512. inline Result Delete(ClientType &cli, const std::string &path,
  3513. const Params &params, size_t chunk_size = 8192) {
  3514. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3515. }
  3516. template <typename ClientType>
  3517. inline Result Delete(ClientType &cli, const std::string &path,
  3518. const Params &params, const Headers &headers,
  3519. size_t chunk_size = 8192) {
  3520. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3521. }
  3522. template <typename ClientType>
  3523. inline Result Delete(ClientType &cli, const std::string &path,
  3524. const Params &params, const std::string &body,
  3525. const std::string &content_type,
  3526. size_t chunk_size = 8192) {
  3527. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3528. chunk_size};
  3529. }
  3530. template <typename ClientType>
  3531. inline Result Delete(ClientType &cli, const std::string &path,
  3532. const Params &params, const Headers &headers,
  3533. const std::string &body, const std::string &content_type,
  3534. size_t chunk_size = 8192) {
  3535. return Result{
  3536. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3537. chunk_size};
  3538. }
  3539. // HEAD
  3540. template <typename ClientType>
  3541. inline Result Head(ClientType &cli, const std::string &path,
  3542. size_t chunk_size = 8192) {
  3543. return Result{cli.open_stream("HEAD", path), chunk_size};
  3544. }
  3545. template <typename ClientType>
  3546. inline Result Head(ClientType &cli, const std::string &path,
  3547. const Headers &headers, size_t chunk_size = 8192) {
  3548. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3549. }
  3550. template <typename ClientType>
  3551. inline Result Head(ClientType &cli, const std::string &path,
  3552. const Params &params, size_t chunk_size = 8192) {
  3553. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3554. }
  3555. template <typename ClientType>
  3556. inline Result Head(ClientType &cli, const std::string &path,
  3557. const Params &params, const Headers &headers,
  3558. size_t chunk_size = 8192) {
  3559. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3560. }
  3561. // OPTIONS
  3562. template <typename ClientType>
  3563. inline Result Options(ClientType &cli, const std::string &path,
  3564. size_t chunk_size = 8192) {
  3565. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3566. }
  3567. template <typename ClientType>
  3568. inline Result Options(ClientType &cli, const std::string &path,
  3569. const Headers &headers, size_t chunk_size = 8192) {
  3570. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3571. }
  3572. template <typename ClientType>
  3573. inline Result Options(ClientType &cli, const std::string &path,
  3574. const Params &params, size_t chunk_size = 8192) {
  3575. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3576. }
  3577. template <typename ClientType>
  3578. inline Result Options(ClientType &cli, const std::string &path,
  3579. const Params &params, const Headers &headers,
  3580. size_t chunk_size = 8192) {
  3581. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3582. }
  3583. } // namespace stream
  3584. namespace sse {
  3585. struct SSEMessage {
  3586. std::string event; // Event type (default: "message")
  3587. std::string data; // Event payload
  3588. std::string id; // Event ID for Last-Event-ID header
  3589. SSEMessage();
  3590. void clear();
  3591. };
  3592. class SSEClient {
  3593. public:
  3594. using MessageHandler = std::function<void(const SSEMessage &)>;
  3595. using ErrorHandler = std::function<void(Error)>;
  3596. using OpenHandler = std::function<void()>;
  3597. SSEClient(Client &client, const std::string &path);
  3598. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3599. ~SSEClient();
  3600. SSEClient(const SSEClient &) = delete;
  3601. SSEClient &operator=(const SSEClient &) = delete;
  3602. // Event handlers
  3603. SSEClient &on_message(MessageHandler handler);
  3604. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3605. SSEClient &on_open(OpenHandler handler);
  3606. SSEClient &on_error(ErrorHandler handler);
  3607. SSEClient &set_reconnect_interval(int ms);
  3608. SSEClient &set_max_reconnect_attempts(int n);
  3609. // Update headers (thread-safe)
  3610. SSEClient &set_headers(const Headers &headers);
  3611. // State accessors
  3612. bool is_connected() const;
  3613. const std::string &last_event_id() const;
  3614. // Blocking start - runs event loop with auto-reconnect
  3615. void start();
  3616. // Non-blocking start - runs in background thread
  3617. void start_async();
  3618. // Stop the client (thread-safe)
  3619. void stop();
  3620. private:
  3621. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3622. bool &has_data, bool &has_id);
  3623. void run_event_loop();
  3624. void dispatch_event(const SSEMessage &msg);
  3625. bool should_reconnect(int count) const;
  3626. void wait_for_reconnect();
  3627. // Client and path
  3628. Client &client_;
  3629. std::string path_;
  3630. Headers headers_;
  3631. mutable std::mutex headers_mutex_;
  3632. // Callbacks
  3633. MessageHandler on_message_;
  3634. std::map<std::string, MessageHandler> event_handlers_;
  3635. OpenHandler on_open_;
  3636. ErrorHandler on_error_;
  3637. // Configuration
  3638. int reconnect_interval_ms_ = 3000;
  3639. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3640. // State
  3641. std::atomic<bool> running_{false};
  3642. std::atomic<bool> connected_{false};
  3643. std::string last_event_id_;
  3644. // Async support
  3645. std::thread async_thread_;
  3646. };
  3647. } // namespace sse
  3648. namespace ws {
  3649. class WebSocketClient;
  3650. enum class Opcode : uint8_t {
  3651. Continuation = 0x0,
  3652. Text = 0x1,
  3653. Binary = 0x2,
  3654. Close = 0x8,
  3655. Ping = 0x9,
  3656. Pong = 0xA,
  3657. };
  3658. enum class CloseStatus : uint16_t {
  3659. Normal = 1000,
  3660. GoingAway = 1001,
  3661. ProtocolError = 1002,
  3662. UnsupportedData = 1003,
  3663. NoStatus = 1005,
  3664. Abnormal = 1006,
  3665. InvalidPayload = 1007,
  3666. PolicyViolation = 1008,
  3667. MessageTooBig = 1009,
  3668. MandatoryExtension = 1010,
  3669. InternalError = 1011,
  3670. };
  3671. // Timeout is returned only when a read timeout was set and it elapsed before
  3672. // any byte of a frame arrived: nothing was consumed and the connection is
  3673. // still open, so the caller can send on it and read again. `msg` is left
  3674. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3675. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3676. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3677. // upgrade handshake fully succeeded. On failure error() identifies the
  3678. // failing layer; status()/headers() expose the server's upgrade response
  3679. // when one was received (status() is -1 otherwise).
  3680. class Result {
  3681. public:
  3682. Result() = default;
  3683. Result(Error err, int status, Headers &&headers)
  3684. : err_(err), status_(status), headers_(std::move(headers)) {}
  3685. explicit operator bool() const { return err_ == Error::Success; }
  3686. Error error() const { return err_; }
  3687. // Upgrade response info
  3688. int status() const { return status_; }
  3689. const Headers &headers() const { return headers_; }
  3690. std::string get_header_value(const std::string &key,
  3691. const char *def = "") const {
  3692. return detail::get_header_value(headers_, key, def, 0);
  3693. }
  3694. bool has_header(const std::string &key) const {
  3695. return headers_.find(key) != headers_.end();
  3696. }
  3697. #ifdef CPPHTTPLIB_SSL_ENABLED
  3698. Result(Error err, int status, Headers &&headers, int ssl_error,
  3699. uint64_t ssl_backend_error)
  3700. : err_(err), status_(status), headers_(std::move(headers)),
  3701. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3702. int ssl_error() const { return ssl_error_; }
  3703. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3704. #endif
  3705. private:
  3706. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3707. int status_ = -1;
  3708. Headers headers_;
  3709. #ifdef CPPHTTPLIB_SSL_ENABLED
  3710. int ssl_error_ = 0;
  3711. uint64_t ssl_backend_error_ = 0;
  3712. #endif
  3713. };
  3714. class WebSocket {
  3715. public:
  3716. WebSocket(const WebSocket &) = delete;
  3717. WebSocket &operator=(const WebSocket &) = delete;
  3718. ~WebSocket();
  3719. ReadResult read(std::string &msg);
  3720. bool send(const std::string &data);
  3721. bool send(const char *data, size_t len);
  3722. void close(CloseStatus status = CloseStatus::Normal,
  3723. const std::string &reason = "");
  3724. const Request &request() const;
  3725. bool is_open() const;
  3726. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3727. // A server handler owns its connection's timeout this way; a client sets it
  3728. // through WebSocketClient. Safe to call while another thread is in read().
  3729. //
  3730. // Only a timeout set here is reported as Timeout. The compile-time default
  3731. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3732. // than a request for control, so when it elapses read() returns Fail and
  3733. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3734. void set_read_timeout(time_t sec, time_t usec = 0);
  3735. template <class Rep, class Period>
  3736. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3737. private:
  3738. friend class httplib::Server;
  3739. friend class httplib::ws::WebSocketClient;
  3740. WebSocket(
  3741. Stream &strm, const Request &req, bool is_server,
  3742. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3743. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3744. : strm_(strm), req_(req), is_server_(is_server),
  3745. ping_interval_sec_(ping_interval_sec),
  3746. max_missed_pongs_(max_missed_pongs) {
  3747. start_heartbeat();
  3748. }
  3749. WebSocket(
  3750. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3751. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3752. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3753. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3754. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3755. max_missed_pongs_(max_missed_pongs) {
  3756. start_heartbeat();
  3757. }
  3758. void start_heartbeat();
  3759. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3760. Stream &strm_;
  3761. std::unique_ptr<Stream> owned_strm_;
  3762. Request req_;
  3763. bool is_server_;
  3764. time_t ping_interval_sec_;
  3765. int max_missed_pongs_;
  3766. int unacked_pings_ = 0;
  3767. std::atomic<bool> closed_{false};
  3768. // Set once the caller has bounded read() through set_read_timeout(). Until
  3769. // then the timeout in effect is the compile-time default, and elapsing it
  3770. // is a failure that closes the connection, not a Timeout.
  3771. std::atomic<bool> read_timeout_set_{false};
  3772. std::mutex write_mutex_;
  3773. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3774. // may do so: read_websocket_frame() reads a payload until it has the whole
  3775. // declared length, so a second parser stealing bytes silently corrupts the
  3776. // message the first one is assembling.
  3777. std::mutex read_mutex_;
  3778. std::thread ping_thread_;
  3779. std::mutex ping_mutex_;
  3780. std::condition_variable ping_cv_;
  3781. };
  3782. class WebSocketClient {
  3783. public:
  3784. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3785. const Headers &headers = {});
  3786. ~WebSocketClient();
  3787. WebSocketClient(const WebSocketClient &) = delete;
  3788. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3789. bool is_valid() const;
  3790. Result connect();
  3791. ReadResult read(std::string &msg);
  3792. bool send(const std::string &data);
  3793. bool send(const char *data, size_t len);
  3794. void close(CloseStatus status = CloseStatus::Normal,
  3795. const std::string &reason = "");
  3796. bool is_open() const;
  3797. const std::string &subprotocol() const;
  3798. void set_read_timeout(time_t sec, time_t usec = 0);
  3799. template <class Rep, class Period>
  3800. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3801. void set_write_timeout(time_t sec, time_t usec = 0);
  3802. template <class Rep, class Period>
  3803. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3804. void set_websocket_ping_interval(time_t sec);
  3805. void set_websocket_max_missed_pongs(int count);
  3806. void set_tcp_nodelay(bool on);
  3807. void set_address_family(int family);
  3808. void set_ipv6_v6only(bool on);
  3809. void set_socket_options(SocketOptions socket_options);
  3810. void set_connection_timeout(time_t sec, time_t usec = 0);
  3811. template <class Rep, class Period>
  3812. void
  3813. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3814. void set_interface(const std::string &intf);
  3815. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3816. #ifdef CPPHTTPLIB_SSL_ENABLED
  3817. struct PemMemory {
  3818. const char *cert_pem;
  3819. size_t cert_pem_len;
  3820. const char *key_pem;
  3821. size_t key_pem_len;
  3822. const char *private_key_password;
  3823. };
  3824. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3825. const PemMemory &pem, const Headers &headers = {});
  3826. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3827. const std::string &ca_cert_dir_path = std::string());
  3828. void set_ca_cert_store(tls::ca_store_t store);
  3829. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3830. void enable_server_certificate_verification(bool enabled);
  3831. void enable_server_hostname_verification(bool enabled);
  3832. void enable_system_ca(bool enabled);
  3833. #endif
  3834. private:
  3835. void shutdown_and_close();
  3836. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3837. int &ssl_error, uint64_t &ssl_backend_error);
  3838. void prepare_default_headers(Request &req);
  3839. std::string host_;
  3840. int port_;
  3841. std::string path_;
  3842. Headers headers_;
  3843. std::string subprotocol_;
  3844. bool is_valid_ = false;
  3845. socket_t sock_ = INVALID_SOCKET;
  3846. std::unique_ptr<WebSocket> ws_;
  3847. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3848. time_t read_timeout_usec_ = 0;
  3849. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3850. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3851. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3852. time_t websocket_ping_interval_sec_ =
  3853. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3854. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3855. int address_family_ = AF_UNSPEC;
  3856. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3857. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3858. SocketOptions socket_options_ = nullptr;
  3859. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3860. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3861. std::string interface_;
  3862. // Hostname to connection target map. The value is an IP literal or another
  3863. // hostname; only the connection target changes, never the identity.
  3864. std::map<std::string, std::string> addr_map_;
  3865. #ifdef CPPHTTPLIB_SSL_ENABLED
  3866. bool is_ssl_ = false;
  3867. tls::ctx_t tls_ctx_ = nullptr;
  3868. tls::session_t tls_session_ = nullptr;
  3869. std::string ca_cert_file_path_;
  3870. std::string ca_cert_dir_path_;
  3871. bool custom_ca_loaded_ = false;
  3872. bool certs_loaded_ = false;
  3873. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3874. bool server_certificate_verification_ = true;
  3875. bool server_hostname_verification_ = true;
  3876. #endif
  3877. };
  3878. template <class Rep, class Period>
  3879. inline void WebSocket::set_read_timeout(
  3880. const std::chrono::duration<Rep, Period> &duration) {
  3881. detail::duration_to_sec_and_usec(
  3882. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3883. }
  3884. template <class Rep, class Period>
  3885. inline void WebSocketClient::set_read_timeout(
  3886. const std::chrono::duration<Rep, Period> &duration) {
  3887. detail::duration_to_sec_and_usec(
  3888. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3889. }
  3890. template <class Rep, class Period>
  3891. inline void WebSocketClient::set_write_timeout(
  3892. const std::chrono::duration<Rep, Period> &duration) {
  3893. detail::duration_to_sec_and_usec(
  3894. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3895. }
  3896. template <class Rep, class Period>
  3897. inline void WebSocketClient::set_connection_timeout(
  3898. const std::chrono::duration<Rep, Period> &duration) {
  3899. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3900. set_connection_timeout(sec, usec);
  3901. });
  3902. }
  3903. namespace impl {
  3904. bool is_valid_utf8(const std::string &s);
  3905. // Three states, because a failure that consumed bytes and one that consumed
  3906. // none are not the same thing: the first has left the stream in the middle of
  3907. // a frame and the connection cannot be reused, the second can just be retried.
  3908. enum class FrameRead { Ok, Fail, Timeout };
  3909. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3910. std::string &payload, bool &fin,
  3911. bool expect_masked, size_t max_len);
  3912. } // namespace impl
  3913. } // namespace ws
  3914. // ----------------------------------------------------------------------------
  3915. /*
  3916. * Implementation that will be part of the .cc file if split into .h + .cc.
  3917. */
  3918. namespace stream {
  3919. // stream::Result implementations
  3920. inline Result::Result() : chunk_size_(8192) {}
  3921. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3922. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3923. inline Result::Result(Result &&other) noexcept
  3924. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3925. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3926. finished_(other.finished_) {
  3927. other.current_size_ = 0;
  3928. other.finished_ = true;
  3929. }
  3930. inline Result &Result::operator=(Result &&other) noexcept {
  3931. if (this != &other) {
  3932. handle_ = std::move(other.handle_);
  3933. buffer_ = std::move(other.buffer_);
  3934. current_size_ = other.current_size_;
  3935. chunk_size_ = other.chunk_size_;
  3936. finished_ = other.finished_;
  3937. other.current_size_ = 0;
  3938. other.finished_ = true;
  3939. }
  3940. return *this;
  3941. }
  3942. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3943. inline Result::operator bool() const { return is_valid(); }
  3944. inline int Result::status() const {
  3945. return handle_.response ? handle_.response->status : -1;
  3946. }
  3947. inline const Headers &Result::headers() const {
  3948. static const Headers empty_headers;
  3949. return handle_.response ? handle_.response->headers : empty_headers;
  3950. }
  3951. inline std::string Result::get_header_value(const std::string &key,
  3952. const char *def) const {
  3953. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3954. }
  3955. inline bool Result::has_header(const std::string &key) const {
  3956. return handle_.response ? handle_.response->has_header(key) : false;
  3957. }
  3958. inline Error Result::error() const { return handle_.error; }
  3959. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3960. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3961. inline bool Result::next() {
  3962. if (!handle_.is_valid() || finished_) { return false; }
  3963. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3964. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3965. if (n > 0) {
  3966. current_size_ = static_cast<size_t>(n);
  3967. return true;
  3968. }
  3969. current_size_ = 0;
  3970. finished_ = true;
  3971. return false;
  3972. }
  3973. inline const char *Result::data() const { return buffer_.data(); }
  3974. inline size_t Result::size() const { return current_size_; }
  3975. inline std::string Result::read_all() {
  3976. std::string result;
  3977. while (next()) {
  3978. result.append(data(), size());
  3979. }
  3980. return result;
  3981. }
  3982. } // namespace stream
  3983. namespace sse {
  3984. // SSEMessage implementations
  3985. inline SSEMessage::SSEMessage() : event("message") {}
  3986. inline void SSEMessage::clear() {
  3987. event = "message";
  3988. data.clear();
  3989. id.clear();
  3990. }
  3991. // SSEClient implementations
  3992. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3993. : client_(client), path_(path) {}
  3994. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3995. const Headers &headers)
  3996. : client_(client), path_(path), headers_(headers) {}
  3997. inline SSEClient::~SSEClient() { stop(); }
  3998. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3999. on_message_ = std::move(handler);
  4000. return *this;
  4001. }
  4002. inline SSEClient &SSEClient::on_event(const std::string &type,
  4003. MessageHandler handler) {
  4004. event_handlers_[type] = std::move(handler);
  4005. return *this;
  4006. }
  4007. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4008. on_open_ = std::move(handler);
  4009. return *this;
  4010. }
  4011. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4012. on_error_ = std::move(handler);
  4013. return *this;
  4014. }
  4015. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4016. reconnect_interval_ms_ = ms;
  4017. return *this;
  4018. }
  4019. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4020. max_reconnect_attempts_ = n;
  4021. return *this;
  4022. }
  4023. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4024. std::lock_guard<std::mutex> lock(headers_mutex_);
  4025. headers_ = headers;
  4026. return *this;
  4027. }
  4028. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4029. inline const std::string &SSEClient::last_event_id() const {
  4030. return last_event_id_;
  4031. }
  4032. inline void SSEClient::start() {
  4033. running_.store(true);
  4034. run_event_loop();
  4035. }
  4036. inline void SSEClient::start_async() {
  4037. running_.store(true);
  4038. async_thread_ = std::thread([this]() { run_event_loop(); });
  4039. }
  4040. inline void SSEClient::stop() {
  4041. running_.store(false);
  4042. client_.stop(); // Cancel any pending operations
  4043. if (async_thread_.joinable()) { async_thread_.join(); }
  4044. }
  4045. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4046. int &retry_ms, bool &has_data,
  4047. bool &has_id) {
  4048. // Blank line signals end of event
  4049. if (line.empty()) { return true; }
  4050. // Lines starting with ':' are comments (ignored)
  4051. if (line[0] == ':') { return false; }
  4052. // Find the colon separator
  4053. auto colon_pos = line.find(':');
  4054. auto field = line.substr(0, colon_pos);
  4055. std::string value;
  4056. // Value starts after colon, skip optional single space
  4057. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4058. auto value_start = colon_pos + 1;
  4059. if (line[value_start] == ' ') { value_start++; }
  4060. value = line.substr(value_start);
  4061. }
  4062. // Handle known fields
  4063. if (field == "event") {
  4064. msg.event = value;
  4065. } else if (field == "data") {
  4066. // Multiple data lines are concatenated with newlines
  4067. if (has_data) { msg.data += "\n"; }
  4068. msg.data += value;
  4069. has_data = true;
  4070. } else if (field == "id") {
  4071. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4072. // valid (clears the last event ID)
  4073. if (detail::fields::is_field_value(value)) {
  4074. msg.id = value;
  4075. has_id = true;
  4076. }
  4077. } else if (field == "retry") {
  4078. // Parse retry interval in milliseconds
  4079. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4080. if (detail::is_numeric(value)) {
  4081. int v = 0;
  4082. auto res =
  4083. detail::from_chars(value.data(), value.data() + value.size(), v);
  4084. if (res.ec == std::errc{}) { retry_ms = v; }
  4085. }
  4086. }
  4087. // Unknown fields are ignored per SSE spec
  4088. return false;
  4089. }
  4090. inline void SSEClient::run_event_loop() {
  4091. auto reconnect_count = 0;
  4092. while (running_.load()) {
  4093. // Build headers, including Last-Event-ID if we have one
  4094. Headers request_headers;
  4095. {
  4096. std::lock_guard<std::mutex> lock(headers_mutex_);
  4097. request_headers = headers_;
  4098. }
  4099. if (!last_event_id_.empty()) {
  4100. request_headers.emplace("Last-Event-ID", last_event_id_);
  4101. }
  4102. // Open streaming connection
  4103. auto result = stream::Get(client_, path_, request_headers);
  4104. // Connection error handling
  4105. if (!result) {
  4106. connected_.store(false);
  4107. if (on_error_) { on_error_(result.error()); }
  4108. if (!should_reconnect(reconnect_count)) { break; }
  4109. wait_for_reconnect();
  4110. reconnect_count++;
  4111. continue;
  4112. }
  4113. if (result.status() != StatusCode::OK_200) {
  4114. connected_.store(false);
  4115. if (on_error_) { on_error_(Error::Connection); }
  4116. // For certain errors, don't reconnect.
  4117. // Note: 401 is intentionally absent so that handlers can refresh
  4118. // credentials via set_headers() and let the client reconnect.
  4119. if (result.status() == StatusCode::NoContent_204 ||
  4120. result.status() == StatusCode::NotFound_404 ||
  4121. result.status() == StatusCode::Forbidden_403) {
  4122. break;
  4123. }
  4124. if (!should_reconnect(reconnect_count)) { break; }
  4125. wait_for_reconnect();
  4126. reconnect_count++;
  4127. continue;
  4128. }
  4129. // Connection successful
  4130. connected_.store(true);
  4131. reconnect_count = 0;
  4132. if (on_open_) { on_open_(); }
  4133. // Event receiving loop
  4134. std::string buffer;
  4135. SSEMessage current_msg;
  4136. auto has_data = false;
  4137. auto has_id = false;
  4138. auto first_line = true;
  4139. auto after_cr = false;
  4140. while (running_.load() && result.next()) {
  4141. // What is left in the buffer has no line ending
  4142. auto search_pos = buffer.size();
  4143. buffer.append(result.data(), result.size());
  4144. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4145. // per the SSE spec
  4146. size_t line_start = 0;
  4147. size_t eol_pos;
  4148. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4149. std::string::npos) {
  4150. auto line = buffer.substr(line_start, eol_pos - line_start);
  4151. line_start = eol_pos + 1;
  4152. search_pos = line_start;
  4153. // The \n of a \r\n may arrive in a later chunk than its \r
  4154. auto is_lf_of_crlf =
  4155. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4156. after_cr = buffer[eol_pos] == '\r';
  4157. if (is_lf_of_crlf) { continue; }
  4158. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4159. if (first_line) {
  4160. first_line = false;
  4161. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4162. }
  4163. // Parse the line and check if event is complete
  4164. auto event_complete = parse_sse_line(
  4165. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4166. if (event_complete) {
  4167. // Update last_event_id for reconnection, even for an event that
  4168. // has no data. An empty id clears it.
  4169. if (has_id) { last_event_id_ = current_msg.id; }
  4170. // An event without a data field is not dispatched
  4171. if (has_data) { dispatch_event(current_msg); }
  4172. // Reset the message for the next event either way
  4173. current_msg.clear();
  4174. has_data = false;
  4175. has_id = false;
  4176. }
  4177. }
  4178. // Keep unprocessed data in buffer
  4179. buffer.erase(0, line_start);
  4180. }
  4181. // Connection ended
  4182. connected_.store(false);
  4183. if (!running_.load()) { break; }
  4184. // Check for read errors
  4185. if (result.has_read_error()) {
  4186. if (on_error_) { on_error_(result.read_error()); }
  4187. }
  4188. if (!should_reconnect(reconnect_count)) { break; }
  4189. wait_for_reconnect();
  4190. reconnect_count++;
  4191. }
  4192. connected_.store(false);
  4193. }
  4194. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4195. // Check for specific event type handler first
  4196. auto it = event_handlers_.find(msg.event);
  4197. if (it != event_handlers_.end()) {
  4198. it->second(msg);
  4199. return;
  4200. }
  4201. // Fall back to generic message handler
  4202. if (on_message_) { on_message_(msg); }
  4203. }
  4204. inline bool SSEClient::should_reconnect(int count) const {
  4205. if (!running_.load()) { return false; }
  4206. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4207. return count < max_reconnect_attempts_;
  4208. }
  4209. inline void SSEClient::wait_for_reconnect() {
  4210. // Use small increments to check running_ flag frequently.
  4211. // Always wait at least one increment, so that a zero interval (e.g.
  4212. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4213. const auto step_ms = 100;
  4214. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4215. auto waited = 0;
  4216. while (running_.load() && waited < interval_ms) {
  4217. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4218. waited += step_ms;
  4219. }
  4220. }
  4221. } // namespace sse
  4222. #ifdef CPPHTTPLIB_SSL_ENABLED
  4223. /*
  4224. * TLS abstraction layer - internal function declarations
  4225. * These are implementation details and not part of the public API.
  4226. */
  4227. namespace tls {
  4228. // Client context
  4229. ctx_t create_client_context();
  4230. void free_context(ctx_t ctx);
  4231. bool set_min_version(ctx_t ctx, Version version);
  4232. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4233. bool load_ca_file(ctx_t ctx, const char *file_path);
  4234. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4235. bool load_system_certs(ctx_t ctx);
  4236. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4237. const char *password);
  4238. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4239. const char *key_path, const char *password);
  4240. // Server context
  4241. ctx_t create_server_context();
  4242. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4243. const char *password);
  4244. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4245. const char *key_path, const char *password);
  4246. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4247. void set_verify_client(ctx_t ctx, bool require);
  4248. // Session management
  4249. session_t create_session(ctx_t ctx, socket_t sock);
  4250. void free_session(session_t session);
  4251. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4252. // Handshake (non-blocking capable)
  4253. TlsError connect(session_t session);
  4254. TlsError accept(session_t session);
  4255. // Handshake with timeout (blocking until timeout)
  4256. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4257. time_t timeout_usec, TlsError *err);
  4258. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4259. time_t timeout_usec, TlsError *err);
  4260. // I/O (non-blocking capable)
  4261. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4262. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4263. int pending(const_session_t session);
  4264. void shutdown(session_t session, bool graceful);
  4265. // Connection state
  4266. bool is_peer_closed(session_t session, socket_t sock);
  4267. // Certificate verification
  4268. cert_t get_peer_cert(const_session_t session);
  4269. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4270. // do not use them after free_session(), as with get_peer_cert().
  4271. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4272. void free_cert(cert_t cert);
  4273. bool verify_hostname(cert_t cert, const char *hostname);
  4274. uint64_t hostname_mismatch_code();
  4275. long get_verify_result(const_session_t session);
  4276. // Certificate introspection
  4277. std::string get_cert_subject_cn(cert_t cert);
  4278. std::string get_cert_issuer_name(cert_t cert);
  4279. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4280. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4281. std::string get_cert_serial(cert_t cert);
  4282. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4283. const char *get_sni(const_session_t session);
  4284. // CA store management
  4285. ca_store_t create_ca_store(const char *pem, size_t len);
  4286. void free_ca_store(ca_store_t store);
  4287. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4288. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4289. std::vector<std::string> get_ca_names(ctx_t ctx);
  4290. // Dynamic certificate update (for servers)
  4291. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4292. const char *password);
  4293. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4294. // Certificate verification callback
  4295. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4296. long get_verify_error(const_session_t session);
  4297. std::string verify_error_string(long error_code);
  4298. // TlsError information
  4299. uint64_t peek_error();
  4300. uint64_t get_error();
  4301. std::string error_string(uint64_t code);
  4302. } // namespace tls
  4303. #endif // CPPHTTPLIB_SSL_ENABLED
  4304. /*
  4305. * Group 1: detail namespace - Non-SSL utilities
  4306. */
  4307. namespace detail {
  4308. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4309. const void *optval, socklen_t optlen) {
  4310. return setsockopt(sock, level, optname,
  4311. #ifdef _WIN32
  4312. reinterpret_cast<const char *>(optval),
  4313. #else
  4314. optval,
  4315. #endif
  4316. optlen) == 0;
  4317. }
  4318. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4319. time_t sec, time_t usec) {
  4320. #ifdef _WIN32
  4321. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4322. #else
  4323. timeval timeout;
  4324. timeout.tv_sec = static_cast<long>(sec);
  4325. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4326. #endif
  4327. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4328. }
  4329. inline bool is_hex(char c, int &v) {
  4330. if (is_ascii_digit(c)) {
  4331. v = c - '0';
  4332. return true;
  4333. } else if ('A' <= c && c <= 'F') {
  4334. v = c - 'A' + 10;
  4335. return true;
  4336. } else if ('a' <= c && c <= 'f') {
  4337. v = c - 'a' + 10;
  4338. return true;
  4339. }
  4340. return false;
  4341. }
  4342. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4343. int &val) {
  4344. if (i >= s.size()) { return false; }
  4345. val = 0;
  4346. for (; cnt; i++, cnt--) {
  4347. if (!s[i]) { return false; }
  4348. auto v = 0;
  4349. if (is_hex(s[i], v)) {
  4350. val = val * 16 + v;
  4351. } else {
  4352. return false;
  4353. }
  4354. }
  4355. return true;
  4356. }
  4357. inline std::string from_i_to_hex(size_t n) {
  4358. static const auto charset = "0123456789abcdef";
  4359. std::string ret;
  4360. do {
  4361. ret = charset[n & 15] + ret;
  4362. n >>= 4;
  4363. } while (n > 0);
  4364. return ret;
  4365. }
  4366. inline std::string compute_etag(const FileStat &fs,
  4367. const std::string &suffix = std::string()) {
  4368. if (!fs.is_file()) { return std::string(); }
  4369. // If mtime cannot be determined (negative value indicates an error
  4370. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4371. // value like 0 could collide with a real file that legitimately has
  4372. // mtime == 0 (epoch) and lead to misleading validators.
  4373. auto mtime_raw = fs.mtime();
  4374. if (mtime_raw < 0) { return std::string(); }
  4375. auto mtime = static_cast<size_t>(mtime_raw);
  4376. auto size = fs.size();
  4377. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4378. from_i_to_hex(size) + suffix + "\"";
  4379. }
  4380. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4381. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4382. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4383. inline std::string file_mtime_to_http_date(time_t mtime) {
  4384. if (mtime < 0) { return std::string(); }
  4385. struct tm tm_buf;
  4386. #ifdef _WIN32
  4387. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4388. #else
  4389. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4390. #endif
  4391. char buf[64];
  4392. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4393. return std::string();
  4394. }
  4395. return std::string(buf);
  4396. }
  4397. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4398. inline time_t parse_http_date(const std::string &date_str) {
  4399. struct tm tm_buf;
  4400. // Create a classic locale object once for all parsing attempts
  4401. const std::locale classic_locale = std::locale::classic();
  4402. // Try to parse using std::get_time (C++11, cross-platform)
  4403. auto try_parse = [&](const char *fmt) -> bool {
  4404. std::istringstream ss(date_str);
  4405. ss.imbue(classic_locale);
  4406. memset(&tm_buf, 0, sizeof(tm_buf));
  4407. ss >> std::get_time(&tm_buf, fmt);
  4408. return !ss.fail();
  4409. };
  4410. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4411. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4412. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4413. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4414. // asctime format: "Sun Nov 6 08:49:37 1994"
  4415. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4416. return static_cast<time_t>(-1);
  4417. }
  4418. }
  4419. }
  4420. #ifdef _WIN32
  4421. return _mkgmtime(&tm_buf);
  4422. #elif defined _AIX
  4423. return mktime(&tm_buf);
  4424. #else
  4425. return timegm(&tm_buf);
  4426. #endif
  4427. }
  4428. inline bool is_weak_etag(const std::string &s) {
  4429. // Check if the string is a weak ETag (starts with 'W/"')
  4430. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4431. }
  4432. inline bool is_strong_etag(const std::string &s) {
  4433. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4434. // chars)
  4435. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4436. }
  4437. inline size_t to_utf8(int code, char *buff) {
  4438. if (code < 0x0080) {
  4439. buff[0] = static_cast<char>(code & 0x7F);
  4440. return 1;
  4441. } else if (code < 0x0800) {
  4442. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4443. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4444. return 2;
  4445. } else if (code < 0xD800) {
  4446. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4447. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4448. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4449. return 3;
  4450. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4451. return 0;
  4452. } else if (code < 0x10000) {
  4453. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4454. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4455. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4456. return 3;
  4457. } else if (code < 0x110000) {
  4458. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4459. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4460. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4461. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4462. return 4;
  4463. }
  4464. // NOTREACHED
  4465. return 0;
  4466. }
  4467. } // namespace detail
  4468. namespace ws {
  4469. namespace impl {
  4470. inline bool is_valid_utf8(const std::string &s) {
  4471. size_t i = 0;
  4472. auto n = s.size();
  4473. while (i < n) {
  4474. auto c = static_cast<unsigned char>(s[i]);
  4475. size_t len;
  4476. uint32_t cp;
  4477. if (c < 0x80) {
  4478. i++;
  4479. continue;
  4480. } else if ((c & 0xE0) == 0xC0) {
  4481. len = 2;
  4482. cp = c & 0x1F;
  4483. } else if ((c & 0xF0) == 0xE0) {
  4484. len = 3;
  4485. cp = c & 0x0F;
  4486. } else if ((c & 0xF8) == 0xF0) {
  4487. len = 4;
  4488. cp = c & 0x07;
  4489. } else {
  4490. return false;
  4491. }
  4492. if (i + len > n) { return false; }
  4493. for (size_t j = 1; j < len; j++) {
  4494. auto b = static_cast<unsigned char>(s[i + j]);
  4495. if ((b & 0xC0) != 0x80) { return false; }
  4496. cp = (cp << 6) | (b & 0x3F);
  4497. }
  4498. // Overlong encoding check
  4499. if (len == 2 && cp < 0x80) { return false; }
  4500. if (len == 3 && cp < 0x800) { return false; }
  4501. if (len == 4 && cp < 0x10000) { return false; }
  4502. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4503. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4504. if (cp > 0x10FFFF) { return false; }
  4505. i += len;
  4506. }
  4507. return true;
  4508. }
  4509. } // namespace impl
  4510. } // namespace ws
  4511. namespace detail {
  4512. // NOTE: This code came up with the following stackoverflow post:
  4513. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4514. inline std::string base64_encode(const std::string &in) {
  4515. static const auto lookup =
  4516. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4517. std::string out;
  4518. out.reserve(in.size());
  4519. // Unsigned: the accumulator is never masked, so with a signed int the
  4520. // `val << 8` below overflows once enough bytes are folded in (undefined
  4521. // behaviour before C++20). Only the low bits are ever emitted, so the
  4522. // wrap-around of an unsigned accumulator does not affect the output.
  4523. uint32_t val = 0;
  4524. auto valb = -6;
  4525. for (auto c : in) {
  4526. val = (val << 8) + static_cast<uint8_t>(c);
  4527. valb += 8;
  4528. while (valb >= 0) {
  4529. out.push_back(lookup[(val >> valb) & 0x3F]);
  4530. valb -= 6;
  4531. }
  4532. }
  4533. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4534. while (out.size() % 4) {
  4535. out.push_back('=');
  4536. }
  4537. return out;
  4538. }
  4539. inline std::string sha1(const std::string &input) {
  4540. // RFC 3174 SHA-1 implementation
  4541. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4542. return (x << n) | (x >> (32 - n));
  4543. };
  4544. uint32_t h0 = 0x67452301;
  4545. uint32_t h1 = 0xEFCDAB89;
  4546. uint32_t h2 = 0x98BADCFE;
  4547. uint32_t h3 = 0x10325476;
  4548. uint32_t h4 = 0xC3D2E1F0;
  4549. // Pre-processing: adding padding bits
  4550. std::string msg = input;
  4551. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4552. msg.push_back(static_cast<char>(0x80u));
  4553. while (msg.size() % 64 != 56) {
  4554. msg.push_back(0);
  4555. }
  4556. // Append original length in bits as 64-bit big-endian
  4557. for (int i = 56; i >= 0; i -= 8) {
  4558. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4559. }
  4560. // Process each 512-bit chunk
  4561. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4562. uint32_t w[80];
  4563. for (size_t i = 0; i < 16; i++) {
  4564. w[i] =
  4565. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4566. << 24) |
  4567. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4568. << 16) |
  4569. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4570. << 8) |
  4571. (static_cast<uint32_t>(
  4572. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4573. }
  4574. for (int i = 16; i < 80; i++) {
  4575. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4576. }
  4577. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4578. for (int i = 0; i < 80; i++) {
  4579. uint32_t f, k;
  4580. if (i < 20) {
  4581. f = (b & c) | ((~b) & d);
  4582. k = 0x5A827999;
  4583. } else if (i < 40) {
  4584. f = b ^ c ^ d;
  4585. k = 0x6ED9EBA1;
  4586. } else if (i < 60) {
  4587. f = (b & c) | (b & d) | (c & d);
  4588. k = 0x8F1BBCDC;
  4589. } else {
  4590. f = b ^ c ^ d;
  4591. k = 0xCA62C1D6;
  4592. }
  4593. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4594. e = d;
  4595. d = c;
  4596. c = left_rotate(b, 30);
  4597. b = a;
  4598. a = temp;
  4599. }
  4600. h0 += a;
  4601. h1 += b;
  4602. h2 += c;
  4603. h3 += d;
  4604. h4 += e;
  4605. }
  4606. // Produce the final hash as a 20-byte binary string
  4607. std::string hash(20, '\0');
  4608. for (size_t i = 0; i < 4; i++) {
  4609. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4610. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4611. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4612. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4613. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4614. }
  4615. return hash;
  4616. }
  4617. inline std::string websocket_accept_key(const std::string &client_key) {
  4618. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4619. return base64_encode(sha1(client_key + magic));
  4620. }
  4621. inline bool is_websocket_upgrade(const Request &req) {
  4622. if (req.method != "GET") { return false; }
  4623. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4624. // list of protocols and asks recipients to match each name
  4625. // case-insensitively, so look for the token rather than compare the whole
  4626. // field value.
  4627. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4628. // Check Connection: Upgrade
  4629. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4630. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4631. // RFC 6455 Section 4.2.1
  4632. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4633. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4634. return false;
  4635. }
  4636. static const std::string b64chars =
  4637. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4638. for (size_t i = 0; i < 22; i++) {
  4639. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4640. }
  4641. // Check Sec-WebSocket-Version: 13
  4642. auto version = req.get_header_value("Sec-WebSocket-Version");
  4643. if (version != "13") { return false; }
  4644. return true;
  4645. }
  4646. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4647. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4648. thread_local std::random_device rd;
  4649. size_t filled = 0;
  4650. while (filled < n) {
  4651. auto v = rd();
  4652. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4653. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4654. }
  4655. }
  4656. }
  4657. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4658. const char *data, size_t len, bool fin,
  4659. bool mask) {
  4660. // First byte: FIN + opcode
  4661. uint8_t header[2];
  4662. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4663. (static_cast<uint8_t>(opcode) & 0x0F));
  4664. // Second byte: MASK + payload length
  4665. if (len < 126) {
  4666. header[1] = static_cast<uint8_t>(len);
  4667. if (mask) { header[1] |= 0x80; }
  4668. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4669. } else if (len <= 0xFFFF) {
  4670. header[1] = 126;
  4671. if (mask) { header[1] |= 0x80; }
  4672. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4673. uint8_t ext[2];
  4674. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4675. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4676. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4677. } else {
  4678. header[1] = 127;
  4679. if (mask) { header[1] |= 0x80; }
  4680. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4681. uint8_t ext[8];
  4682. for (int i = 7; i >= 0; i--) {
  4683. ext[7 - i] =
  4684. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4685. }
  4686. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4687. }
  4688. if (mask) {
  4689. // Generate random mask key
  4690. uint8_t mask_key[4];
  4691. fill_random_bytes(mask_key, sizeof(mask_key));
  4692. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4693. // Write masked payload in chunks
  4694. const size_t chunk_size = 4096;
  4695. std::vector<char> buf((std::min)(len, chunk_size));
  4696. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4697. size_t n = (std::min)(chunk_size, len - offset);
  4698. for (size_t i = 0; i < n; i++) {
  4699. buf[i] =
  4700. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4701. }
  4702. if (strm.write(buf.data(), n) < 0) { return false; }
  4703. }
  4704. } else {
  4705. if (len > 0) {
  4706. if (strm.write(data, len) < 0) { return false; }
  4707. }
  4708. }
  4709. return true;
  4710. }
  4711. } // namespace detail
  4712. namespace ws {
  4713. namespace impl {
  4714. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4715. // hands back whatever its buffer already holds -- so every multi-byte field has
  4716. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4717. // header straddles the read buffer's boundary.
  4718. //
  4719. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4720. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4721. // there is a failure like any other. (When read() fails it always records why,
  4722. // so the error belongs to this call and not to an earlier one.)
  4723. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4724. auto p = static_cast<char *>(buf);
  4725. size_t total = 0;
  4726. while (total < size) {
  4727. auto n = strm.read(p + total, size - total);
  4728. if (n <= 0) {
  4729. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4730. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4731. }
  4732. total += static_cast<size_t>(n);
  4733. }
  4734. return FrameRead::Ok;
  4735. }
  4736. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4737. std::string &payload, bool &fin,
  4738. bool expect_masked, size_t max_len) {
  4739. // Read first 2 bytes. This is the only read that may report a timeout: it
  4740. // sits on a frame boundary, where nothing has been consumed yet.
  4741. uint8_t header[2];
  4742. FrameRead first = read_exact(strm, header, 2);
  4743. if (first != FrameRead::Ok) { return first; }
  4744. fin = (header[0] & 0x80) != 0;
  4745. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4746. if (header[0] & 0x70) { return FrameRead::Fail; }
  4747. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4748. bool masked = (header[1] & 0x80) != 0;
  4749. uint64_t payload_len = header[1] & 0x7F;
  4750. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4751. // MUST have a payload length of 125 bytes or less
  4752. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4753. if (is_control) {
  4754. if (!fin) { return FrameRead::Fail; }
  4755. if (payload_len > 125) { return FrameRead::Fail; }
  4756. }
  4757. if (masked != expect_masked) { return FrameRead::Fail; }
  4758. // Extended payload length
  4759. if (payload_len == 126) {
  4760. uint8_t ext[2];
  4761. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4762. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4763. } else if (payload_len == 127) {
  4764. uint8_t ext[8];
  4765. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4766. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4767. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4768. payload_len = 0;
  4769. for (int i = 0; i < 8; i++) {
  4770. payload_len = (payload_len << 8) | ext[i];
  4771. }
  4772. }
  4773. if (payload_len > max_len) { return FrameRead::Fail; }
  4774. // Read mask key if present
  4775. uint8_t mask_key[4] = {0};
  4776. if (masked) {
  4777. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4778. return FrameRead::Fail;
  4779. }
  4780. }
  4781. // Grow the payload only as it arrives, since a header alone can announce
  4782. // max_len bytes that never come.
  4783. payload.clear();
  4784. auto len = static_cast<size_t>(payload_len);
  4785. while (payload.size() < len) {
  4786. auto offset = payload.size();
  4787. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4788. payload.resize(offset + n);
  4789. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4790. return FrameRead::Fail;
  4791. }
  4792. }
  4793. // Unmask if needed
  4794. if (masked) {
  4795. for (size_t i = 0; i < payload.size(); i++) {
  4796. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4797. }
  4798. }
  4799. return FrameRead::Ok;
  4800. }
  4801. } // namespace impl
  4802. } // namespace ws
  4803. namespace detail {
  4804. inline bool is_valid_path(const std::string &path) {
  4805. size_t level = 0;
  4806. size_t i = 0;
  4807. // Skip slash
  4808. while (i < path.size() && path[i] == '/') {
  4809. i++;
  4810. }
  4811. while (i < path.size()) {
  4812. // Read component
  4813. auto beg = i;
  4814. while (i < path.size() && path[i] != '/') {
  4815. if (path[i] == '\0') {
  4816. return false;
  4817. } else if (path[i] == '\\') {
  4818. return false;
  4819. }
  4820. i++;
  4821. }
  4822. auto len = i - beg;
  4823. assert(len > 0);
  4824. if (!path.compare(beg, len, ".")) {
  4825. ;
  4826. } else if (!path.compare(beg, len, "..")) {
  4827. if (level == 0) { return false; }
  4828. level--;
  4829. } else {
  4830. level++;
  4831. }
  4832. // Skip slash
  4833. while (i < path.size() && path[i] == '/') {
  4834. i++;
  4835. }
  4836. }
  4837. return true;
  4838. }
  4839. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4840. #if defined(_WIN32)
  4841. char buf[_MAX_PATH];
  4842. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4843. resolved = buf;
  4844. #elif defined(PATH_MAX)
  4845. char buf[PATH_MAX];
  4846. if (realpath(path, buf) == nullptr) { return false; }
  4847. resolved = buf;
  4848. #else
  4849. auto buf = realpath(path, nullptr);
  4850. auto guard = scope_exit([&]() { std::free(buf); });
  4851. if (buf == nullptr) { return false; }
  4852. resolved = buf;
  4853. #endif
  4854. return true;
  4855. }
  4856. inline bool is_path_within_base(const std::string &resolved_path,
  4857. const std::string &resolved_base) {
  4858. #if defined(_WIN32)
  4859. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4860. resolved_base.size()) == 0;
  4861. #else
  4862. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4863. resolved_base.size()) == 0;
  4864. #endif
  4865. }
  4866. inline FileStat::FileStat(const std::string &path) {
  4867. #if defined(_WIN32)
  4868. auto wpath = u8string_to_wstring(path.c_str());
  4869. ret_ = _wstat(wpath.c_str(), &st_);
  4870. #else
  4871. ret_ = stat(path.c_str(), &st_);
  4872. #endif
  4873. }
  4874. inline bool FileStat::is_file() const {
  4875. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4876. }
  4877. inline bool FileStat::is_dir() const {
  4878. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4879. }
  4880. inline time_t FileStat::mtime() const {
  4881. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4882. : static_cast<time_t>(-1);
  4883. }
  4884. inline size_t FileStat::size() const {
  4885. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4886. }
  4887. inline std::string encode_path(const std::string &s) {
  4888. std::string result;
  4889. result.reserve(s.size());
  4890. for (size_t i = 0; s[i]; i++) {
  4891. switch (s[i]) {
  4892. case ' ': result += "%20"; break;
  4893. case '+': result += "%2B"; break;
  4894. case '\'': result += "%27"; break;
  4895. case ',': result += "%2C"; break;
  4896. // case ':': result += "%3A"; break; // ok? probably...
  4897. case ';': result += "%3B"; break;
  4898. default:
  4899. auto c = static_cast<uint8_t>(s[i]);
  4900. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4901. // in a request-target as-is.
  4902. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4903. result += '%';
  4904. char hex[4];
  4905. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4906. assert(len == 2);
  4907. result.append(hex, static_cast<size_t>(len));
  4908. } else {
  4909. result += s[i];
  4910. }
  4911. break;
  4912. }
  4913. }
  4914. return result;
  4915. }
  4916. inline std::string file_extension(const std::string &path) {
  4917. auto i = path.size();
  4918. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  4919. i--;
  4920. }
  4921. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  4922. return std::string();
  4923. }
  4924. return path.substr(i);
  4925. }
  4926. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4927. template <typename T>
  4928. inline bool parse_header(const char *beg, const char *end, T fn);
  4929. template <typename T>
  4930. inline bool parse_header(const char *beg, const char *end, T fn) {
  4931. // Skip trailing spaces and tabs.
  4932. while (beg < end && is_space_or_tab(end[-1])) {
  4933. end--;
  4934. }
  4935. auto p = beg;
  4936. while (p < end && *p != ':') {
  4937. p++;
  4938. }
  4939. auto name = std::string(beg, p);
  4940. if (!detail::fields::is_field_name(name)) { return false; }
  4941. if (p == end) { return false; }
  4942. auto key_end = p;
  4943. if (*p++ != ':') { return false; }
  4944. while (p < end && is_space_or_tab(*p)) {
  4945. p++;
  4946. }
  4947. if (p <= end) {
  4948. auto key_len = key_end - beg;
  4949. if (!key_len) { return false; }
  4950. auto key = std::string(beg, key_end);
  4951. auto val = std::string(p, end);
  4952. if (!detail::fields::is_field_value(val)) { return false; }
  4953. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4954. // percent-decoded by the recipient. Applications that need to interpret a
  4955. // value as a URI component should call httplib::decode_uri_component()
  4956. // (or decode_path_component()) explicitly.
  4957. fn(key, val);
  4958. return true;
  4959. }
  4960. return false;
  4961. }
  4962. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4963. const Headers &src_headers) {
  4964. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4965. // transfer coding is complete when a chunk with a chunk-size of zero is
  4966. // received, possibly followed by a trailer section, and finally terminated by
  4967. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4968. //
  4969. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4970. // doesn't care for the existence of the final CRLF. In other words, it seems
  4971. // to be ok whether the final CRLF exists or not in the chunked data.
  4972. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4973. //
  4974. // According to the reference code in RFC 9112, cpp-httplib now allows
  4975. // chunked transfer coding data without the final CRLF.
  4976. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4977. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4978. "transfer-encoding",
  4979. "content-length",
  4980. "host",
  4981. "authorization",
  4982. "www-authenticate",
  4983. "proxy-authenticate",
  4984. "proxy-authorization",
  4985. "cookie",
  4986. "set-cookie",
  4987. "cache-control",
  4988. "expect",
  4989. "max-forwards",
  4990. "pragma",
  4991. "range",
  4992. "te",
  4993. "age",
  4994. "expires",
  4995. "date",
  4996. "location",
  4997. "retry-after",
  4998. "vary",
  4999. "warning",
  5000. "content-encoding",
  5001. "content-type",
  5002. "content-range",
  5003. "trailer"};
  5004. case_ignore::unordered_set<std::string> declared_trailers;
  5005. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5006. if (!trailer_header.empty()) {
  5007. // split() trims each token and skips empty ones, so the name arrives ready
  5008. // to look up.
  5009. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5010. ',', [&](const char *b, const char *e) {
  5011. // A legitimate message declares only a handful of trailers. Cap the
  5012. // set so a peer cannot grow it without bound: an oversized set only
  5013. // arises from an attempt to force many colliding names into
  5014. // quadratic lookups (case_ignore::hash is unkeyed).
  5015. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5016. return;
  5017. }
  5018. std::string key(b, e);
  5019. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5020. declared_trailers.insert(key);
  5021. }
  5022. });
  5023. }
  5024. size_t trailer_header_count = 0;
  5025. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5026. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5027. // Count every received trailer field, not only the declared ones stored in
  5028. // dest, so undeclared fields cannot keep this loop running past the limit.
  5029. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5030. constexpr auto line_terminator_len = 2;
  5031. auto line_beg = line_reader.ptr();
  5032. auto line_end =
  5033. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5034. if (!parse_header(line_beg, line_end,
  5035. [&](const std::string &key, const std::string &val) {
  5036. if (declared_trailers.find(key) !=
  5037. declared_trailers.end()) {
  5038. dest.emplace(key, val);
  5039. }
  5040. })) {
  5041. return false;
  5042. }
  5043. trailer_header_count++;
  5044. if (!line_reader.getline()) { return false; }
  5045. }
  5046. return true;
  5047. }
  5048. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5049. size_t right) {
  5050. while (b + left < e && is_space_or_tab(b[left])) {
  5051. left++;
  5052. }
  5053. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5054. right--;
  5055. }
  5056. return std::make_pair(left, right);
  5057. }
  5058. inline std::string trim_copy(const std::string &s) {
  5059. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5060. return s.substr(r.first, r.second - r.first);
  5061. }
  5062. inline std::string trim_double_quotes_copy(const std::string &s) {
  5063. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5064. return s.substr(1, s.size() - 2);
  5065. }
  5066. return s;
  5067. }
  5068. inline void
  5069. divide(const char *data, std::size_t size, char d,
  5070. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5071. fn) {
  5072. const auto it = std::find(data, data + size, d);
  5073. const auto found = static_cast<std::size_t>(it != data + size);
  5074. const auto lhs_data = data;
  5075. const auto lhs_size = static_cast<std::size_t>(it - data);
  5076. const auto rhs_data = it + found;
  5077. const auto rhs_size = size - lhs_size - found;
  5078. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5079. }
  5080. inline void
  5081. divide(const std::string &str, char d,
  5082. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5083. fn) {
  5084. divide(str.data(), str.size(), d, std::move(fn));
  5085. }
  5086. inline void split(const char *b, const char *e, char d,
  5087. std::function<void(const char *, const char *)> fn) {
  5088. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5089. }
  5090. inline void split(const char *b, const char *e, char d, size_t m,
  5091. std::function<void(const char *, const char *)> fn) {
  5092. size_t i = 0;
  5093. size_t beg = 0;
  5094. size_t count = 1;
  5095. while (e ? (b + i < e) : (b[i] != '\0')) {
  5096. if (b[i] == d && count < m) {
  5097. auto r = trim(b, e, beg, i);
  5098. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5099. beg = i + 1;
  5100. count++;
  5101. }
  5102. i++;
  5103. }
  5104. if (i) {
  5105. auto r = trim(b, e, beg, i);
  5106. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5107. }
  5108. }
  5109. // Same contract as split(), except that a delimiter inside a quoted-string is
  5110. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5111. // quoted-string, and ';' and '=' are legal characters inside one.
  5112. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5113. std::function<void(const char *, const char *)> fn) {
  5114. size_t i = 0;
  5115. size_t beg = 0;
  5116. size_t count = 1;
  5117. auto in_quotes = false;
  5118. while (e ? (b + i < e) : (b[i] != '\0')) {
  5119. if (b[i] == '"') {
  5120. in_quotes = !in_quotes;
  5121. } else if (b[i] == d && !in_quotes && count < m) {
  5122. auto r = trim(b, e, beg, i);
  5123. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5124. beg = i + 1;
  5125. count++;
  5126. }
  5127. i++;
  5128. }
  5129. if (i) {
  5130. auto r = trim(b, e, beg, i);
  5131. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5132. }
  5133. }
  5134. inline void split_unquoted(const char *b, const char *e, char d,
  5135. std::function<void(const char *, const char *)> fn) {
  5136. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5137. std::move(fn));
  5138. }
  5139. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5140. // key a token, so the first '=' is the separator even when the value is a
  5141. // quoted-string carrying more of them.
  5142. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5143. std::string &val) {
  5144. divide(
  5145. b, static_cast<std::size_t>(e - b), '=',
  5146. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5147. const auto kr = trim(kb, kb + klen, 0, klen);
  5148. key.assign(kb + kr.first, kb + kr.second);
  5149. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5150. val.assign(vb + vr.first, vb + vr.second);
  5151. });
  5152. }
  5153. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5154. std::function<bool(const char *, const char *)> fn) {
  5155. size_t i = 0;
  5156. size_t beg = 0;
  5157. size_t count = 1;
  5158. while (e ? (b + i < e) : (b[i] != '\0')) {
  5159. if (b[i] == d && count < m) {
  5160. auto r = trim(b, e, beg, i);
  5161. if (r.first < r.second) {
  5162. auto found = fn(&b[r.first], &b[r.second]);
  5163. if (found) { return true; }
  5164. }
  5165. beg = i + 1;
  5166. count++;
  5167. }
  5168. i++;
  5169. }
  5170. if (i) {
  5171. auto r = trim(b, e, beg, i);
  5172. if (r.first < r.second) {
  5173. auto found = fn(&b[r.first], &b[r.second]);
  5174. if (found) { return true; }
  5175. }
  5176. }
  5177. return false;
  5178. }
  5179. inline bool split_find(const char *b, const char *e, char d,
  5180. std::function<bool(const char *, const char *)> fn) {
  5181. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5182. std::move(fn));
  5183. }
  5184. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5185. size_t fixed_buffer_size)
  5186. : strm_(strm), fixed_buffer_(fixed_buffer),
  5187. fixed_buffer_size_(fixed_buffer_size) {}
  5188. inline const char *stream_line_reader::ptr() const {
  5189. if (growable_buffer_.empty()) {
  5190. return fixed_buffer_;
  5191. } else {
  5192. return growable_buffer_.data();
  5193. }
  5194. }
  5195. inline size_t stream_line_reader::size() const {
  5196. if (growable_buffer_.empty()) {
  5197. return fixed_buffer_used_size_;
  5198. } else {
  5199. return growable_buffer_.size();
  5200. }
  5201. }
  5202. inline bool stream_line_reader::end_with_crlf() const {
  5203. auto end = ptr() + size();
  5204. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5205. }
  5206. inline bool stream_line_reader::getline() {
  5207. fixed_buffer_used_size_ = 0;
  5208. growable_buffer_.clear();
  5209. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5210. char prev_byte = 0;
  5211. #endif
  5212. for (size_t i = 0;; i++) {
  5213. // Fast path: whatever the stream has already buffered can be scanned for
  5214. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5215. // call, a bounds check and a one-byte copy per character of the request.
  5216. size_t buffered_size = 0;
  5217. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5218. auto take = buffered_size;
  5219. auto terminated = false;
  5220. for (size_t at = 0; at < buffered_size;) {
  5221. auto nl = static_cast<const char *>(
  5222. memchr(buffered + at, '\n', buffered_size - at));
  5223. if (!nl) { break; }
  5224. auto pos = static_cast<size_t>(nl - buffered);
  5225. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5226. take = pos + 1;
  5227. terminated = true;
  5228. break;
  5229. #else
  5230. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5231. // be the last byte of an earlier chunk, hence prev_byte.
  5232. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5233. take = pos + 1;
  5234. terminated = true;
  5235. break;
  5236. }
  5237. at = pos + 1;
  5238. #endif
  5239. }
  5240. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5241. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5242. prev_byte = buffered[take - 1];
  5243. #endif
  5244. append(buffered, take);
  5245. strm_.consume_buffered(take);
  5246. i += take;
  5247. if (terminated) { return true; }
  5248. continue;
  5249. }
  5250. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5251. // Treat exceptionally long lines as an error to
  5252. // prevent infinite loops/memory exhaustion
  5253. return false;
  5254. }
  5255. char byte;
  5256. auto n = strm_.read(&byte, 1);
  5257. if (n < 0) {
  5258. return false;
  5259. } else if (n == 0) {
  5260. if (i == 0) {
  5261. return false;
  5262. } else {
  5263. break;
  5264. }
  5265. }
  5266. append(byte);
  5267. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5268. if (byte == '\n') { break; }
  5269. #else
  5270. if (prev_byte == '\r' && byte == '\n') { break; }
  5271. prev_byte = byte;
  5272. #endif
  5273. }
  5274. return true;
  5275. }
  5276. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5277. inline void stream_line_reader::append(const char *data, size_t size) {
  5278. // Once the line has outgrown the fixed buffer everything must keep going to
  5279. // the growable one, even if a later chunk would have fit. Without the
  5280. // emptiness check a short append after a long one would land in the fixed
  5281. // buffer, which ptr() and size() no longer look at, and be lost.
  5282. if (growable_buffer_.empty() &&
  5283. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5284. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5285. fixed_buffer_used_size_ += size;
  5286. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5287. } else {
  5288. // Unlike the per-character overload, this can be the very first append of
  5289. // the line, so the fixed buffer may hold nothing and carry no terminator
  5290. // yet. assign() takes an explicit length and does not need one.
  5291. if (growable_buffer_.empty()) {
  5292. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5293. }
  5294. growable_buffer_.append(data, size);
  5295. }
  5296. }
  5297. inline mmap::mmap(const char *path) { open(path); }
  5298. inline mmap::~mmap() { close(); }
  5299. inline bool mmap::open(const char *path) {
  5300. close();
  5301. #if defined(_WIN32)
  5302. auto wpath = u8string_to_wstring(path);
  5303. if (wpath.empty()) { return false; }
  5304. hFile_ =
  5305. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5306. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5307. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5308. LARGE_INTEGER size{};
  5309. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5310. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5311. // See:
  5312. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5313. if (static_cast<ULONGLONG>(size.QuadPart) >
  5314. (std::numeric_limits<decltype(size_)>::max)()) {
  5315. // `size_t` might be 32-bits, on 32-bits Windows.
  5316. return false;
  5317. }
  5318. size_ = static_cast<size_t>(size.QuadPart);
  5319. hMapping_ =
  5320. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5321. // Special treatment for an empty file...
  5322. if (hMapping_ == NULL && size_ == 0) {
  5323. close();
  5324. is_open_empty_file = true;
  5325. return true;
  5326. }
  5327. if (hMapping_ == NULL) {
  5328. close();
  5329. return false;
  5330. }
  5331. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5332. if (addr_ == nullptr) {
  5333. close();
  5334. return false;
  5335. }
  5336. #else
  5337. fd_ = ::open(path, O_RDONLY);
  5338. if (fd_ == -1) { return false; }
  5339. struct stat sb;
  5340. if (fstat(fd_, &sb) == -1) {
  5341. close();
  5342. return false;
  5343. }
  5344. size_ = static_cast<size_t>(sb.st_size);
  5345. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5346. // Special treatment for an empty file...
  5347. if (addr_ == MAP_FAILED && size_ == 0) {
  5348. close();
  5349. is_open_empty_file = true;
  5350. return false;
  5351. }
  5352. if (addr_ == MAP_FAILED) {
  5353. // Clear the sentinel before `close()`, since `is_open()` only checks
  5354. // `addr_` against nullptr and `munmap()` must not be called with it.
  5355. addr_ = nullptr;
  5356. close();
  5357. return false;
  5358. }
  5359. #endif
  5360. return true;
  5361. }
  5362. inline bool mmap::is_open() const {
  5363. return is_open_empty_file ? true : addr_ != nullptr;
  5364. }
  5365. inline size_t mmap::size() const { return size_; }
  5366. inline const char *mmap::data() const {
  5367. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5368. }
  5369. inline void mmap::close() {
  5370. #if defined(_WIN32)
  5371. if (addr_) {
  5372. ::UnmapViewOfFile(addr_);
  5373. addr_ = nullptr;
  5374. }
  5375. if (hMapping_) {
  5376. ::CloseHandle(hMapping_);
  5377. hMapping_ = NULL;
  5378. }
  5379. if (hFile_ != INVALID_HANDLE_VALUE) {
  5380. ::CloseHandle(hFile_);
  5381. hFile_ = INVALID_HANDLE_VALUE;
  5382. }
  5383. is_open_empty_file = false;
  5384. #else
  5385. if (addr_ != nullptr) {
  5386. munmap(addr_, size_);
  5387. addr_ = nullptr;
  5388. }
  5389. if (fd_ != -1) {
  5390. ::close(fd_);
  5391. fd_ = -1;
  5392. }
  5393. #endif
  5394. size_ = 0;
  5395. }
  5396. inline int close_socket(socket_t sock) noexcept {
  5397. #ifdef _WIN32
  5398. return closesocket(sock);
  5399. #else
  5400. return close(sock);
  5401. #endif
  5402. }
  5403. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5404. ssize_t res = 0;
  5405. while (true) {
  5406. res = fn();
  5407. if (res < 0 && errno == EINTR) {
  5408. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5409. continue;
  5410. }
  5411. break;
  5412. }
  5413. return res;
  5414. }
  5415. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5416. return handle_EINTR([&]() {
  5417. return recv(sock,
  5418. #ifdef _WIN32
  5419. static_cast<char *>(ptr), static_cast<int>(size),
  5420. #else
  5421. ptr, size,
  5422. #endif
  5423. flags);
  5424. });
  5425. }
  5426. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5427. int flags) {
  5428. return handle_EINTR([&]() {
  5429. return send(sock,
  5430. #ifdef _WIN32
  5431. static_cast<const char *>(ptr), static_cast<int>(size),
  5432. #else
  5433. ptr, size,
  5434. #endif
  5435. flags);
  5436. });
  5437. }
  5438. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5439. #ifdef _WIN32
  5440. return ::WSAPoll(fds, nfds, timeout);
  5441. #else
  5442. return ::poll(fds, nfds, timeout);
  5443. #endif
  5444. }
  5445. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5446. time_t usec) {
  5447. struct pollfd pfd;
  5448. pfd.fd = sock;
  5449. pfd.events = events;
  5450. pfd.revents = 0;
  5451. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5452. // "return immediately", which callers here rely on to probe a socket.
  5453. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5454. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5455. }
  5456. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5457. return select_impl(sock, POLLIN, sec, usec);
  5458. }
  5459. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5460. return select_impl(sock, POLLOUT, sec, usec);
  5461. }
  5462. // The point sec and usec from now, for select_until(). A negative sec never
  5463. // comes, as a negative timeout waits forever in select_impl().
  5464. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5465. time_t usec) {
  5466. if (sec < 0) { return std::chrono::steady_clock::time_point::max(); }
  5467. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5468. std::chrono::microseconds(usec);
  5469. }
  5470. // Waits only for the time left until deadline, so that all the waits of one
  5471. // TLS handshake come out of a single timeout.
  5472. inline ssize_t select_until(socket_t sock, short events,
  5473. std::chrono::steady_clock::time_point deadline) {
  5474. if (deadline == std::chrono::steady_clock::time_point::max()) {
  5475. return select_impl(sock, events, -1, 0);
  5476. }
  5477. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5478. deadline - std::chrono::steady_clock::now())
  5479. .count();
  5480. if (left <= 0) { return 0; }
  5481. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5482. static_cast<time_t>(left % 1000000));
  5483. }
  5484. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5485. time_t usec) {
  5486. struct pollfd pfd_read;
  5487. pfd_read.fd = sock;
  5488. pfd_read.events = POLLIN | POLLOUT;
  5489. pfd_read.revents = 0;
  5490. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5491. auto poll_res =
  5492. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5493. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5494. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5495. auto error = 0;
  5496. socklen_t len = sizeof(error);
  5497. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5498. reinterpret_cast<char *>(&error), &len);
  5499. auto successful = res >= 0 && !error;
  5500. return successful ? Error::Success : Error::Connection;
  5501. }
  5502. return Error::Connection;
  5503. }
  5504. inline bool is_socket_alive(socket_t sock) {
  5505. const auto val = detail::select_read(sock, 0, 0);
  5506. if (val == 0) {
  5507. return true;
  5508. } else if (val < 0 && errno == EBADF) {
  5509. return false;
  5510. }
  5511. char buf[1];
  5512. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5513. }
  5514. class SocketStream final : public Stream {
  5515. public:
  5516. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5517. time_t write_timeout_sec, time_t write_timeout_usec,
  5518. time_t max_timeout_msec = 0,
  5519. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5520. (std::chrono::steady_clock::time_point::min)());
  5521. ~SocketStream() override;
  5522. bool is_readable() const override;
  5523. bool wait_readable() const override;
  5524. bool wait_writable() const override;
  5525. bool is_peer_alive() const override;
  5526. ssize_t read(char *ptr, size_t size) override;
  5527. ssize_t write(const char *ptr, size_t size) override;
  5528. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5529. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5530. socket_t socket() const override;
  5531. time_t duration() const override;
  5532. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5533. const char *buffered_data(size_t &size) const override;
  5534. void consume_buffered(size_t size) override;
  5535. // The caller has just seen this socket become readable. Lets the next read
  5536. // skip its own readiness wait, which would otherwise ask the kernel a
  5537. // question that was answered a moment ago. Consumed by that read.
  5538. void set_readable_hint() { readable_hint_ = true; }
  5539. private:
  5540. bool ensure_readable();
  5541. socket_t sock_;
  5542. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5543. // thread while a read is in flight -- that is the point of it, for a caller
  5544. // holding one connection and wanting control back to send on it.
  5545. std::atomic<time_t> read_timeout_sec_;
  5546. std::atomic<time_t> read_timeout_usec_;
  5547. time_t write_timeout_sec_;
  5548. time_t write_timeout_usec_;
  5549. time_t max_timeout_msec_;
  5550. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5551. std::vector<char> read_buff_;
  5552. size_t read_buff_off_ = 0;
  5553. size_t read_buff_content_size_ = 0;
  5554. bool readable_hint_ = false;
  5555. static const size_t read_buff_size_ = 1024l * 4;
  5556. };
  5557. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5558. time_t keep_alive_timeout_sec) {
  5559. using namespace std::chrono;
  5560. const auto interval_usec =
  5561. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5562. // Avoid expensive `steady_clock::now()` call for the first time
  5563. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5564. const auto start = steady_clock::now() - microseconds{interval_usec};
  5565. const auto timeout = seconds{keep_alive_timeout_sec};
  5566. while (true) {
  5567. if (svr_sock == INVALID_SOCKET) {
  5568. break; // Server socket is closed
  5569. }
  5570. auto val = select_read(sock, 0, interval_usec);
  5571. if (val < 0) {
  5572. break; // Ssocket error
  5573. } else if (val == 0) {
  5574. if (steady_clock::now() - start > timeout) {
  5575. break; // Timeout
  5576. }
  5577. } else {
  5578. return true; // Ready for read
  5579. }
  5580. }
  5581. return false;
  5582. }
  5583. // `has_buffered_request` reports whether the connection's stream already holds
  5584. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5585. // 9.3.2), so reading one request can pull the start of the next one into the
  5586. // stream's buffer; that request must be served without waiting for the socket
  5587. // to become readable again, since its bytes are no longer on the socket.
  5588. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5589. template <typename P, typename T>
  5590. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5591. socket_t sock,
  5592. size_t keep_alive_max_count,
  5593. time_t keep_alive_timeout_sec,
  5594. P has_buffered_request, T callback) {
  5595. assert(keep_alive_max_count > 0);
  5596. auto ret = false;
  5597. auto count = keep_alive_max_count;
  5598. while (count > 0) {
  5599. auto socket_readable = false;
  5600. if (!has_buffered_request()) {
  5601. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5602. socket_readable = true;
  5603. }
  5604. auto close_connection = count == 1;
  5605. auto connection_closed = false;
  5606. ret = callback(socket_readable, close_connection, connection_closed);
  5607. if (!ret || connection_closed) { break; }
  5608. count--;
  5609. }
  5610. return ret;
  5611. }
  5612. template <typename T>
  5613. inline bool
  5614. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5615. size_t keep_alive_max_count,
  5616. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5617. time_t read_timeout_usec, time_t write_timeout_sec,
  5618. time_t write_timeout_usec, T callback) {
  5619. // One stream per connection: its read buffer can already hold the start of
  5620. // the next, pipelined request.
  5621. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5622. write_timeout_sec, write_timeout_usec);
  5623. return process_server_socket_core(
  5624. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5625. [&]() { return strm.is_readable(); },
  5626. [&](bool socket_readable, bool close_connection,
  5627. bool &connection_closed) {
  5628. if (socket_readable) { strm.set_readable_hint(); }
  5629. return callback(strm, close_connection, connection_closed);
  5630. });
  5631. }
  5632. inline bool process_client_socket(
  5633. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5634. time_t write_timeout_sec, time_t write_timeout_usec,
  5635. time_t max_timeout_msec,
  5636. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5637. std::function<bool(Stream &)> callback) {
  5638. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5639. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5640. start_time);
  5641. return callback(strm);
  5642. }
  5643. inline int shutdown_socket(socket_t sock) noexcept {
  5644. #ifdef _WIN32
  5645. return shutdown(sock, SD_BOTH);
  5646. #else
  5647. return shutdown(sock, SHUT_RDWR);
  5648. #endif
  5649. }
  5650. // Half-closes the write side and drains any in-flight/queued bytes before
  5651. // the final shutdown+close. Closing with unread data in the receive queue
  5652. // (or bytes arriving after the receive side is closed) makes the stack send
  5653. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5654. // response as a failed read even though it was fully written.
  5655. inline void drain_and_close_socket(socket_t sock) noexcept {
  5656. #ifdef _WIN32
  5657. shutdown(sock, SD_SEND);
  5658. #else
  5659. shutdown(sock, SHUT_WR);
  5660. #endif
  5661. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5662. size_t total = 0;
  5663. const auto deadline = std::chrono::steady_clock::now() +
  5664. std::chrono::milliseconds(100); // bound #1
  5665. while (total < size_t(1024u * 1024u)) { // bound #2
  5666. const auto remaining =
  5667. std::chrono::duration_cast<std::chrono::microseconds>(
  5668. deadline - std::chrono::steady_clock::now())
  5669. .count();
  5670. if (remaining <= 0) { break; }
  5671. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5672. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5673. if (n <= 0) { break; }
  5674. total += static_cast<size_t>(n);
  5675. }
  5676. shutdown_socket(sock);
  5677. close_socket(sock);
  5678. }
  5679. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5680. if (s.size() > 1 && s[0] == '\0') {
  5681. auto ret = s;
  5682. ret[0] = '@';
  5683. return ret;
  5684. }
  5685. return s;
  5686. }
  5687. inline std::string
  5688. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5689. if (s.size() > 1 && s[0] == '@') {
  5690. auto ret = s;
  5691. ret[0] = '\0';
  5692. return ret;
  5693. }
  5694. return s;
  5695. }
  5696. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5697. const struct addrinfo *hints,
  5698. struct addrinfo **res, time_t timeout_sec) {
  5699. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5700. if (timeout_sec <= 0) {
  5701. // No timeout specified, use standard getaddrinfo
  5702. return getaddrinfo(node, service, hints, res);
  5703. }
  5704. #ifdef _WIN32
  5705. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5706. OVERLAPPED overlapped = {};
  5707. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5708. if (!event) { return EAI_FAIL; }
  5709. overlapped.hEvent = event;
  5710. PADDRINFOEXW result_addrinfo = nullptr;
  5711. HANDLE cancel_handle = nullptr;
  5712. ADDRINFOEXW hints_ex = {};
  5713. if (hints) {
  5714. hints_ex.ai_flags = hints->ai_flags;
  5715. hints_ex.ai_family = hints->ai_family;
  5716. hints_ex.ai_socktype = hints->ai_socktype;
  5717. hints_ex.ai_protocol = hints->ai_protocol;
  5718. }
  5719. auto wnode = u8string_to_wstring(node);
  5720. auto wservice = u8string_to_wstring(service);
  5721. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5722. hints ? &hints_ex : nullptr, &result_addrinfo,
  5723. nullptr, &overlapped, nullptr, &cancel_handle);
  5724. if (ret == WSA_IO_PENDING) {
  5725. auto wait_result =
  5726. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5727. if (wait_result == WAIT_TIMEOUT) {
  5728. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5729. ::CloseHandle(event);
  5730. return EAI_AGAIN;
  5731. }
  5732. DWORD bytes_returned;
  5733. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5734. &bytes_returned, FALSE)) {
  5735. ::CloseHandle(event);
  5736. return ::WSAGetLastError();
  5737. }
  5738. }
  5739. ::CloseHandle(event);
  5740. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5741. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5742. return 0;
  5743. }
  5744. return ret;
  5745. #elif TARGET_OS_MAC && defined(__clang__)
  5746. if (!node) { return EAI_NONAME; }
  5747. // macOS implementation using CFHost API for asynchronous DNS resolution
  5748. CFStringRef hostname_ref = CFStringCreateWithCString(
  5749. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5750. if (!hostname_ref) { return EAI_MEMORY; }
  5751. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5752. CFRelease(hostname_ref);
  5753. if (!host_ref) { return EAI_MEMORY; }
  5754. // Set up context for callback
  5755. struct CFHostContext {
  5756. bool completed = false;
  5757. bool success = false;
  5758. CFArrayRef addresses = nullptr;
  5759. std::mutex mutex;
  5760. std::condition_variable cv;
  5761. } context;
  5762. CFHostClientContext client_context;
  5763. memset(&client_context, 0, sizeof(client_context));
  5764. client_context.info = &context;
  5765. // Set callback
  5766. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5767. const CFStreamError *error, void *info) {
  5768. auto ctx = static_cast<CFHostContext *>(info);
  5769. std::lock_guard<std::mutex> lock(ctx->mutex);
  5770. if (error && error->error != 0) {
  5771. ctx->success = false;
  5772. } else {
  5773. Boolean hasBeenResolved;
  5774. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5775. if (ctx->addresses && hasBeenResolved) {
  5776. CFRetain(ctx->addresses);
  5777. ctx->success = true;
  5778. } else {
  5779. ctx->success = false;
  5780. }
  5781. }
  5782. ctx->completed = true;
  5783. ctx->cv.notify_one();
  5784. };
  5785. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5786. CFRelease(host_ref);
  5787. return EAI_SYSTEM;
  5788. }
  5789. // Schedule on run loop
  5790. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5791. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5792. // Start resolution
  5793. CFStreamError stream_error;
  5794. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5795. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5796. CFRelease(host_ref);
  5797. return EAI_FAIL;
  5798. }
  5799. // Wait for completion with timeout
  5800. auto timeout_time =
  5801. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5802. bool timed_out = false;
  5803. {
  5804. std::unique_lock<std::mutex> lock(context.mutex);
  5805. while (!context.completed) {
  5806. auto now = std::chrono::steady_clock::now();
  5807. if (now >= timeout_time) {
  5808. timed_out = true;
  5809. break;
  5810. }
  5811. // Run the runloop for a short time
  5812. lock.unlock();
  5813. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5814. lock.lock();
  5815. }
  5816. }
  5817. // Clean up
  5818. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5819. CFHostSetClient(host_ref, nullptr, nullptr);
  5820. if (timed_out || !context.completed) {
  5821. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5822. CFRelease(host_ref);
  5823. return EAI_AGAIN;
  5824. }
  5825. if (!context.success || !context.addresses) {
  5826. CFRelease(host_ref);
  5827. return EAI_NODATA;
  5828. }
  5829. // Convert CFArray to addrinfo
  5830. CFIndex count = CFArrayGetCount(context.addresses);
  5831. if (count == 0) {
  5832. CFRelease(context.addresses);
  5833. CFRelease(host_ref);
  5834. return EAI_NODATA;
  5835. }
  5836. struct addrinfo *result_addrinfo = nullptr;
  5837. struct addrinfo **current = &result_addrinfo;
  5838. for (CFIndex i = 0; i < count; i++) {
  5839. CFDataRef addr_data =
  5840. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5841. if (!addr_data) continue;
  5842. const struct sockaddr *sockaddr_ptr =
  5843. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5844. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5845. // Allocate addrinfo structure
  5846. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5847. if (!*current) {
  5848. freeaddrinfo(result_addrinfo);
  5849. CFRelease(context.addresses);
  5850. CFRelease(host_ref);
  5851. return EAI_MEMORY;
  5852. }
  5853. memset(*current, 0, sizeof(struct addrinfo));
  5854. // Set up addrinfo fields
  5855. (*current)->ai_family = sockaddr_ptr->sa_family;
  5856. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5857. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5858. (*current)->ai_addrlen = sockaddr_len;
  5859. // Copy sockaddr
  5860. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5861. if (!(*current)->ai_addr) {
  5862. freeaddrinfo(result_addrinfo);
  5863. CFRelease(context.addresses);
  5864. CFRelease(host_ref);
  5865. return EAI_MEMORY;
  5866. }
  5867. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5868. // Set port if service is specified
  5869. if (service && *service) {
  5870. int port = 0;
  5871. if (parse_port(service, strlen(service), port)) {
  5872. if (sockaddr_ptr->sa_family == AF_INET) {
  5873. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5874. ->sin_port = htons(static_cast<uint16_t>(port));
  5875. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5876. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5877. ->sin6_port = htons(static_cast<uint16_t>(port));
  5878. }
  5879. }
  5880. }
  5881. current = &((*current)->ai_next);
  5882. }
  5883. CFRelease(context.addresses);
  5884. CFRelease(host_ref);
  5885. *res = result_addrinfo;
  5886. return 0;
  5887. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5888. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  5889. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  5890. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  5891. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5892. // the resolver worker still references the stack-local gaicb. The cancel
  5893. // path therefore waits (gai_suspend with no timeout) for the worker to
  5894. // actually finish before letting the stack frame go. The trade-off is that
  5895. // a wedged DNS server can hold this thread for the system resolver timeout
  5896. // (~30s by default) past the caller's connection timeout.
  5897. struct gaicb request{};
  5898. struct gaicb *requests[1] = {&request};
  5899. struct sigevent sevp{};
  5900. struct timespec timeout{timeout_sec, 0};
  5901. request.ar_name = node;
  5902. request.ar_service = service;
  5903. request.ar_request = hints;
  5904. sevp.sigev_notify = SIGEV_NONE;
  5905. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5906. if (rc != 0) { return rc; }
  5907. auto cleanup = scope_exit([&] {
  5908. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5909. });
  5910. int wait_result = gai_suspend(requests, 1, &timeout);
  5911. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5912. int gai_result = gai_error(&request);
  5913. if (gai_result == 0) {
  5914. *res = request.ar_result;
  5915. request.ar_result = nullptr;
  5916. return 0;
  5917. }
  5918. return gai_result;
  5919. }
  5920. gai_cancel(&request);
  5921. while (gai_error(&request) == EAI_INPROGRESS) {
  5922. gai_suspend(requests, 1, nullptr);
  5923. }
  5924. return wait_result;
  5925. #else
  5926. // Fallback implementation using thread-based timeout for other Unix systems.
  5927. struct GetAddrInfoState {
  5928. ~GetAddrInfoState() {
  5929. if (info) { freeaddrinfo(info); }
  5930. }
  5931. std::mutex mutex;
  5932. std::condition_variable result_cv;
  5933. bool completed = false;
  5934. int result = EAI_SYSTEM;
  5935. std::string node;
  5936. std::string service;
  5937. struct addrinfo hints;
  5938. struct addrinfo *info = nullptr;
  5939. };
  5940. // Allocate on the heap, so the resolver thread can keep using the data.
  5941. auto state = std::make_shared<GetAddrInfoState>();
  5942. if (node) { state->node = node; }
  5943. state->service = service;
  5944. state->hints = *hints;
  5945. std::thread resolve_thread([state]() {
  5946. auto thread_result =
  5947. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5948. &state->info);
  5949. std::lock_guard<std::mutex> lock(state->mutex);
  5950. state->result = thread_result;
  5951. state->completed = true;
  5952. state->result_cv.notify_one();
  5953. });
  5954. // Wait for completion or timeout
  5955. std::unique_lock<std::mutex> lock(state->mutex);
  5956. auto finished =
  5957. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5958. [&] { return state->completed; });
  5959. if (finished) {
  5960. // Operation completed within timeout
  5961. resolve_thread.join();
  5962. *res = state->info;
  5963. state->info = nullptr; // Pass ownership to caller
  5964. return state->result;
  5965. } else {
  5966. // Timeout occurred
  5967. resolve_thread.detach(); // Let the thread finish in background
  5968. return EAI_AGAIN; // Return timeout error
  5969. }
  5970. #endif
  5971. #else
  5972. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5973. return getaddrinfo(node, service, hints, res);
  5974. #endif
  5975. }
  5976. template <typename BindOrConnect>
  5977. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5978. int address_family, int socket_flags, bool tcp_nodelay,
  5979. bool ipv6_v6only, SocketOptions socket_options,
  5980. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5981. // Get address info
  5982. const char *node = nullptr;
  5983. struct addrinfo hints;
  5984. struct addrinfo *result;
  5985. memset(&hints, 0, sizeof(struct addrinfo));
  5986. hints.ai_socktype = SOCK_STREAM;
  5987. hints.ai_protocol = IPPROTO_IP;
  5988. if (!ip.empty()) {
  5989. node = ip.c_str();
  5990. // Ask getaddrinfo to convert IP in c-string to address
  5991. hints.ai_family = AF_UNSPEC;
  5992. hints.ai_flags = AI_NUMERICHOST;
  5993. } else {
  5994. if (!host.empty()) { node = host.c_str(); }
  5995. hints.ai_family = address_family;
  5996. hints.ai_flags = socket_flags;
  5997. }
  5998. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5999. if (hints.ai_family == AF_UNIX) {
  6000. const auto addrlen = host.length();
  6001. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6002. #ifdef SOCK_CLOEXEC
  6003. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6004. hints.ai_protocol);
  6005. #else
  6006. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6007. #endif
  6008. if (sock != INVALID_SOCKET) {
  6009. sockaddr_un addr{};
  6010. addr.sun_family = AF_UNIX;
  6011. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6012. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6013. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6014. hints.ai_addrlen = static_cast<socklen_t>(
  6015. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6016. #ifndef SOCK_CLOEXEC
  6017. #ifndef _WIN32
  6018. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6019. #endif
  6020. #endif
  6021. if (socket_options) { socket_options(sock); }
  6022. #ifdef _WIN32
  6023. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6024. // remove the option.
  6025. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6026. #endif
  6027. bool dummy;
  6028. if (!bind_or_connect(sock, hints, dummy)) {
  6029. close_socket(sock);
  6030. sock = INVALID_SOCKET;
  6031. }
  6032. }
  6033. return sock;
  6034. }
  6035. #endif
  6036. auto service = std::to_string(port);
  6037. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6038. timeout_sec)) {
  6039. #if defined __linux__ && !defined __ANDROID__
  6040. res_init();
  6041. #endif
  6042. return INVALID_SOCKET;
  6043. }
  6044. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6045. for (auto rp = result; rp; rp = rp->ai_next) {
  6046. // Create a socket
  6047. #ifdef _WIN32
  6048. auto sock =
  6049. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6050. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6051. /**
  6052. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6053. * and above the socket creation fails on older Windows Systems.
  6054. *
  6055. * Let's try to create a socket the old way in this case.
  6056. *
  6057. * Reference:
  6058. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6059. *
  6060. * WSA_FLAG_NO_HANDLE_INHERIT:
  6061. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6062. * SP1, and later
  6063. *
  6064. */
  6065. if (sock == INVALID_SOCKET) {
  6066. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6067. }
  6068. #else
  6069. #ifdef SOCK_CLOEXEC
  6070. auto sock =
  6071. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6072. #else
  6073. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6074. #endif
  6075. #endif
  6076. if (sock == INVALID_SOCKET) { continue; }
  6077. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6078. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6079. close_socket(sock);
  6080. continue;
  6081. }
  6082. #endif
  6083. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6084. if (rp->ai_family == AF_INET6) {
  6085. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6086. }
  6087. if (socket_options) { socket_options(sock); }
  6088. // bind or connect
  6089. auto quit = false;
  6090. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6091. close_socket(sock);
  6092. if (quit) { break; }
  6093. }
  6094. return INVALID_SOCKET;
  6095. }
  6096. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6097. #ifdef _WIN32
  6098. auto flags = nonblocking ? 1UL : 0UL;
  6099. ioctlsocket(sock, FIONBIO, &flags);
  6100. #else
  6101. auto flags = fcntl(sock, F_GETFL, 0);
  6102. fcntl(sock, F_SETFL,
  6103. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6104. #endif
  6105. }
  6106. inline bool is_connection_error() {
  6107. #ifdef _WIN32
  6108. return WSAGetLastError() != WSAEWOULDBLOCK;
  6109. #else
  6110. return errno != EINPROGRESS;
  6111. #endif
  6112. }
  6113. // accept() failed because the process or the network stack is temporarily out
  6114. // of resources. The listening socket is still usable, so back off briefly and
  6115. // try again.
  6116. inline bool is_accept_resource_error() {
  6117. #ifdef _WIN32
  6118. auto err = WSAGetLastError();
  6119. return err == WSAEMFILE || err == WSAENOBUFS;
  6120. #else
  6121. auto err = errno;
  6122. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6123. #endif
  6124. }
  6125. // accept() failed for a reason that says nothing about the listening socket:
  6126. // the pending connection went away before it could be accepted, or the call
  6127. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6128. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6129. // connection that way.
  6130. inline bool is_accept_transient_error() {
  6131. #ifdef _WIN32
  6132. auto err = WSAGetLastError();
  6133. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6134. err == WSAECONNABORTED;
  6135. #else
  6136. auto err = errno;
  6137. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6138. err == ECONNABORTED;
  6139. #endif
  6140. }
  6141. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6142. struct addrinfo hints;
  6143. struct addrinfo *result;
  6144. memset(&hints, 0, sizeof(struct addrinfo));
  6145. hints.ai_family = AF_UNSPEC;
  6146. hints.ai_socktype = SOCK_STREAM;
  6147. hints.ai_protocol = 0;
  6148. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6149. return false;
  6150. }
  6151. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6152. auto ret = false;
  6153. for (auto rp = result; rp; rp = rp->ai_next) {
  6154. const auto &ai = *rp;
  6155. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6156. ret = true;
  6157. break;
  6158. }
  6159. }
  6160. return ret;
  6161. }
  6162. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6163. #define USE_IF2IP
  6164. #endif
  6165. #ifdef USE_IF2IP
  6166. inline std::string if2ip(int address_family, const std::string &ifn) {
  6167. struct ifaddrs *ifap;
  6168. getifaddrs(&ifap);
  6169. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6170. std::string addr_candidate;
  6171. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6172. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6173. (AF_UNSPEC == address_family ||
  6174. ifa->ifa_addr->sa_family == address_family)) {
  6175. if (ifa->ifa_addr->sa_family == AF_INET) {
  6176. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6177. char buf[INET_ADDRSTRLEN];
  6178. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6179. return std::string(buf, INET_ADDRSTRLEN);
  6180. }
  6181. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6182. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6183. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6184. char buf[INET6_ADDRSTRLEN] = {};
  6185. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6186. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6187. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6188. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6189. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6190. } else {
  6191. return std::string(buf, INET6_ADDRSTRLEN);
  6192. }
  6193. }
  6194. }
  6195. }
  6196. }
  6197. }
  6198. return addr_candidate;
  6199. }
  6200. #endif
  6201. inline socket_t create_client_socket(
  6202. const std::string &host, const std::string &ip, int port,
  6203. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6204. SocketOptions socket_options, time_t connection_timeout_sec,
  6205. time_t connection_timeout_usec, time_t read_timeout_sec,
  6206. time_t read_timeout_usec, time_t write_timeout_sec,
  6207. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6208. auto sock = create_socket(
  6209. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6210. std::move(socket_options),
  6211. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6212. if (!intf.empty()) {
  6213. #ifdef USE_IF2IP
  6214. auto ip_from_if = if2ip(address_family, intf);
  6215. if (ip_from_if.empty()) { ip_from_if = intf; }
  6216. if (!bind_ip_address(sock2, ip_from_if)) {
  6217. error = Error::BindIPAddress;
  6218. return false;
  6219. }
  6220. #endif
  6221. }
  6222. set_nonblocking(sock2, true);
  6223. auto ret =
  6224. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6225. if (ret < 0) {
  6226. if (is_connection_error()) {
  6227. error = Error::Connection;
  6228. return false;
  6229. }
  6230. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6231. connection_timeout_usec);
  6232. if (error != Error::Success) {
  6233. if (error == Error::ConnectionTimeout) { quit = true; }
  6234. return false;
  6235. }
  6236. }
  6237. set_nonblocking(sock2, false);
  6238. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6239. read_timeout_usec);
  6240. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6241. write_timeout_usec);
  6242. error = Error::Success;
  6243. return true;
  6244. },
  6245. connection_timeout_sec); // Pass DNS timeout
  6246. if (sock != INVALID_SOCKET) {
  6247. error = Error::Success;
  6248. } else {
  6249. if (error == Error::Success) { error = Error::Connection; }
  6250. }
  6251. return sock;
  6252. }
  6253. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6254. socklen_t addr_len, std::string &ip, int &port) {
  6255. if (addr.ss_family == AF_INET) {
  6256. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6257. } else if (addr.ss_family == AF_INET6) {
  6258. port =
  6259. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6260. } else {
  6261. return false;
  6262. }
  6263. std::array<char, NI_MAXHOST> ipstr{};
  6264. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6265. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6266. 0, NI_NUMERICHOST)) {
  6267. return false;
  6268. }
  6269. ip = ipstr.data();
  6270. return true;
  6271. }
  6272. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6273. struct sockaddr_storage addr;
  6274. socklen_t addr_len = sizeof(addr);
  6275. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6276. &addr_len)) {
  6277. get_ip_and_port(addr, addr_len, ip, port);
  6278. }
  6279. }
  6280. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6281. struct sockaddr_storage addr;
  6282. socklen_t addr_len = sizeof(addr);
  6283. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6284. &addr_len)) {
  6285. #ifndef _WIN32
  6286. if (addr.ss_family == AF_UNIX) {
  6287. #if defined(__linux__)
  6288. struct ucred ucred;
  6289. socklen_t len = sizeof(ucred);
  6290. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6291. port = ucred.pid;
  6292. }
  6293. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6294. pid_t pid;
  6295. socklen_t len = sizeof(pid);
  6296. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6297. port = pid;
  6298. }
  6299. #endif
  6300. return;
  6301. }
  6302. #endif
  6303. get_ip_and_port(addr, addr_len, ip, port);
  6304. }
  6305. }
  6306. // Recursive form retained so operator""_t below can compute hashes for
  6307. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6308. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6309. // instead, which is iterative and stack-safe.
  6310. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6311. unsigned int h) {
  6312. return (l == 0)
  6313. ? h
  6314. : str2tag_core(
  6315. s + 1, l - 1,
  6316. // Unsets the 6 high bits of h, therefore no overflow happens
  6317. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6318. h * 33) ^
  6319. static_cast<unsigned char>(*s));
  6320. }
  6321. inline unsigned int str2tag(const std::string &s) {
  6322. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6323. // for compile-time UDL evaluation of short string literals, but at runtime
  6324. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6325. // would blow the stack with one frame per character.
  6326. unsigned int h = 0;
  6327. for (auto c : s) {
  6328. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6329. static_cast<unsigned char>(c);
  6330. }
  6331. return h;
  6332. }
  6333. namespace udl {
  6334. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6335. return str2tag_core(s, l, 0);
  6336. }
  6337. } // namespace udl
  6338. inline std::string
  6339. find_content_type(const std::string &path,
  6340. const std::map<std::string, std::string> &user_data,
  6341. const std::string &default_content_type) {
  6342. auto ext = file_extension(path);
  6343. auto it = user_data.find(ext);
  6344. if (it != user_data.end()) { return it->second; }
  6345. using udl::operator""_t;
  6346. switch (str2tag(ext)) {
  6347. default: return default_content_type;
  6348. case "css"_t: return "text/css";
  6349. case "csv"_t: return "text/csv";
  6350. case "htm"_t:
  6351. case "html"_t: return "text/html";
  6352. case "js"_t:
  6353. case "mjs"_t: return "text/javascript";
  6354. case "txt"_t: return "text/plain";
  6355. case "vtt"_t: return "text/vtt";
  6356. case "apng"_t: return "image/apng";
  6357. case "avif"_t: return "image/avif";
  6358. case "bmp"_t: return "image/bmp";
  6359. case "gif"_t: return "image/gif";
  6360. case "png"_t: return "image/png";
  6361. case "svg"_t: return "image/svg+xml";
  6362. case "webp"_t: return "image/webp";
  6363. case "ico"_t: return "image/x-icon";
  6364. case "tif"_t: return "image/tiff";
  6365. case "tiff"_t: return "image/tiff";
  6366. case "jpg"_t:
  6367. case "jpeg"_t: return "image/jpeg";
  6368. case "mp4"_t: return "video/mp4";
  6369. case "mpeg"_t: return "video/mpeg";
  6370. case "webm"_t: return "video/webm";
  6371. case "mp3"_t: return "audio/mp3";
  6372. case "mpga"_t: return "audio/mpeg";
  6373. case "weba"_t: return "audio/webm";
  6374. case "wav"_t: return "audio/wave";
  6375. case "otf"_t: return "font/otf";
  6376. case "ttf"_t: return "font/ttf";
  6377. case "woff"_t: return "font/woff";
  6378. case "woff2"_t: return "font/woff2";
  6379. case "7z"_t: return "application/x-7z-compressed";
  6380. case "atom"_t: return "application/atom+xml";
  6381. case "pdf"_t: return "application/pdf";
  6382. case "json"_t: return "application/json";
  6383. case "rss"_t: return "application/rss+xml";
  6384. case "tar"_t: return "application/x-tar";
  6385. case "xht"_t:
  6386. case "xhtml"_t: return "application/xhtml+xml";
  6387. case "xslt"_t: return "application/xslt+xml";
  6388. case "xml"_t: return "application/xml";
  6389. case "gz"_t: return "application/gzip";
  6390. case "zip"_t: return "application/zip";
  6391. case "wasm"_t: return "application/wasm";
  6392. }
  6393. }
  6394. inline std::string
  6395. extract_media_type(const std::string &content_type,
  6396. std::map<std::string, std::string> *params = nullptr) {
  6397. // Extract type/subtype from Content-Type value (RFC 2045)
  6398. // e.g. "application/json; charset=utf-8" -> "application/json"
  6399. auto media_type = content_type;
  6400. auto semicolon_pos = media_type.find(';');
  6401. if (semicolon_pos != std::string::npos) {
  6402. auto param_str = media_type.substr(semicolon_pos + 1);
  6403. media_type = media_type.substr(0, semicolon_pos);
  6404. if (params) {
  6405. // Parse parameters: key=value pairs separated by ';'
  6406. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6407. [&](const char *b, const char *e) {
  6408. std::string key;
  6409. std::string val;
  6410. divide_param_pair(b, e, key, val);
  6411. if (!key.empty()) {
  6412. params->emplace(trim_copy(key),
  6413. trim_double_quotes_copy(val));
  6414. }
  6415. });
  6416. }
  6417. }
  6418. // Trim whitespace from media type
  6419. return trim_copy(media_type);
  6420. }
  6421. inline bool can_compress_content_type(const std::string &content_type) {
  6422. using udl::operator""_t;
  6423. auto mime_type = extract_media_type(content_type);
  6424. auto tag = str2tag(mime_type);
  6425. switch (tag) {
  6426. case "image/svg+xml"_t:
  6427. case "application/javascript"_t:
  6428. case "application/x-javascript"_t:
  6429. case "application/json"_t:
  6430. case "application/ld+json"_t:
  6431. case "application/xml"_t:
  6432. case "application/xhtml+xml"_t:
  6433. case "application/rss+xml"_t:
  6434. case "application/atom+xml"_t:
  6435. case "application/xslt+xml"_t:
  6436. case "application/protobuf"_t: return true;
  6437. case "text/event-stream"_t: return false;
  6438. default: return !mime_type.rfind("text/", 0);
  6439. }
  6440. }
  6441. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6442. double &quality) {
  6443. quality = 1.0;
  6444. token.clear();
  6445. // Split on first ';': left = token name, right = parameters
  6446. const char *params_b = nullptr;
  6447. std::size_t params_len = 0;
  6448. divide(
  6449. b, static_cast<std::size_t>(e - b), ';',
  6450. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6451. auto r = trim(lb, lb + llen, 0, llen);
  6452. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6453. params_b = rb;
  6454. params_len = rlen;
  6455. });
  6456. if (token.empty()) { return false; }
  6457. if (params_len == 0) { return true; }
  6458. // Scan parameters for q= (stops on first match)
  6459. bool invalid = false;
  6460. split_find(params_b, params_b + params_len, ';',
  6461. (std::numeric_limits<size_t>::max)(),
  6462. [&](const char *pb, const char *pe) -> bool {
  6463. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6464. auto len = static_cast<size_t>(pe - pb);
  6465. if (len < 2) { return false; }
  6466. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6467. return false;
  6468. }
  6469. // Trim the value portion
  6470. auto r = trim(pb, pe, 2, len);
  6471. if (r.first >= r.second) {
  6472. invalid = true;
  6473. return true;
  6474. }
  6475. double v = 0.0;
  6476. auto res = from_chars(pb + r.first, pb + r.second, v);
  6477. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6478. v < 0.0 || v > 1.0) {
  6479. invalid = true;
  6480. return true;
  6481. }
  6482. quality = v;
  6483. return true;
  6484. });
  6485. return !invalid;
  6486. }
  6487. inline EncodingType encoding_type(const Request &req,
  6488. const std::string &content_type) {
  6489. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6490. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6491. if (s.empty()) { return EncodingType::None; }
  6492. // Single-pass: iterate tokens and track the best supported encoding.
  6493. // Server preference breaks ties (br > gzip > zstd).
  6494. EncodingType best = EncodingType::None;
  6495. double best_q = 0.0; // q=0 means "not acceptable"
  6496. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6497. auto priority = [](EncodingType t) -> int {
  6498. switch (t) {
  6499. case EncodingType::Brotli: return 0;
  6500. case EncodingType::Gzip: return 1;
  6501. case EncodingType::Zstd: return 2;
  6502. default: return 3;
  6503. }
  6504. };
  6505. std::string name;
  6506. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6507. double quality = 1.0;
  6508. if (!parse_quality(b, e, name, quality)) { return; }
  6509. if (quality <= 0.0) { return; }
  6510. EncodingType type = EncodingType::None;
  6511. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6512. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6513. #endif
  6514. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6515. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6516. type = EncodingType::Gzip;
  6517. }
  6518. #endif
  6519. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6520. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6521. type = EncodingType::Zstd;
  6522. }
  6523. #endif
  6524. if (type == EncodingType::None) { return; }
  6525. // Higher q-value wins; for equal q, server preference breaks ties
  6526. if (quality > best_q ||
  6527. (quality == best_q && priority(type) < priority(best))) {
  6528. best_q = quality;
  6529. best = type;
  6530. }
  6531. });
  6532. return best;
  6533. }
  6534. // `content_type` is taken separately because a file-backed response has not
  6535. // been given one yet when its coding has to be decided.
  6536. inline EncodingType encoding_type(const Request &req, const Response &res,
  6537. const std::string &content_type) {
  6538. // The response already names a content coding of its own: a handler serving
  6539. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6540. // point whose headers name the coding its files are stored in. Applying one
  6541. // on top of that would double-encode the body and append a second
  6542. // `Content-Encoding` field line.
  6543. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6544. return encoding_type(req, content_type);
  6545. }
  6546. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6547. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6548. }
  6549. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6550. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6551. if (type == EncodingType::Gzip) {
  6552. return detail::make_unique<gzip_compressor>();
  6553. }
  6554. #endif
  6555. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6556. if (type == EncodingType::Brotli) {
  6557. return detail::make_unique<brotli_compressor>();
  6558. }
  6559. #endif
  6560. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6561. if (type == EncodingType::Zstd) {
  6562. return detail::make_unique<zstd_compressor>();
  6563. }
  6564. #endif
  6565. (void)type;
  6566. return nullptr;
  6567. }
  6568. inline const char *encoding_name(EncodingType type) {
  6569. switch (type) {
  6570. case EncodingType::Gzip: return "gzip";
  6571. case EncodingType::Brotli: return "br";
  6572. case EncodingType::Zstd: return "zstd";
  6573. default: return "";
  6574. }
  6575. }
  6576. inline bool nocompressor::compress(const char *data, size_t data_length,
  6577. bool /*last*/, Callback callback) {
  6578. if (!data_length) { return true; }
  6579. return callback(data, data_length);
  6580. }
  6581. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6582. inline gzip_compressor::gzip_compressor() {
  6583. std::memset(&strm_, 0, sizeof(strm_));
  6584. strm_.zalloc = Z_NULL;
  6585. strm_.zfree = Z_NULL;
  6586. strm_.opaque = Z_NULL;
  6587. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6588. Z_DEFAULT_STRATEGY) == Z_OK;
  6589. }
  6590. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6591. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6592. bool last, Callback callback) {
  6593. assert(is_valid_);
  6594. do {
  6595. constexpr size_t max_avail_in =
  6596. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6597. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6598. (std::min)(data_length, max_avail_in));
  6599. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6600. data_length -= strm_.avail_in;
  6601. data += strm_.avail_in;
  6602. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6603. auto ret = Z_OK;
  6604. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6605. do {
  6606. strm_.avail_out = static_cast<uInt>(buff.size());
  6607. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6608. ret = deflate(&strm_, flush);
  6609. if (ret == Z_STREAM_ERROR) { return false; }
  6610. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6611. return false;
  6612. }
  6613. } while (strm_.avail_out == 0);
  6614. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6615. (flush == Z_NO_FLUSH && ret == Z_OK));
  6616. assert(strm_.avail_in == 0);
  6617. } while (data_length > 0);
  6618. return true;
  6619. }
  6620. inline gzip_decompressor::gzip_decompressor() {
  6621. std::memset(&strm_, 0, sizeof(strm_));
  6622. strm_.zalloc = Z_NULL;
  6623. strm_.zfree = Z_NULL;
  6624. strm_.opaque = Z_NULL;
  6625. // 15 is the value of wbits, which should be at the maximum possible value
  6626. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6627. // that the stream type should be automatically detected either gzip or
  6628. // deflate.
  6629. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6630. }
  6631. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6632. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6633. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6634. Callback callback) {
  6635. assert(is_valid_);
  6636. auto ret = Z_OK;
  6637. do {
  6638. constexpr size_t max_avail_in =
  6639. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6640. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6641. (std::min)(data_length, max_avail_in));
  6642. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6643. data_length -= strm_.avail_in;
  6644. data += strm_.avail_in;
  6645. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6646. while (strm_.avail_in > 0 && ret == Z_OK) {
  6647. strm_.avail_out = static_cast<uInt>(buff.size());
  6648. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6649. ret = inflate(&strm_, Z_NO_FLUSH);
  6650. assert(ret != Z_STREAM_ERROR);
  6651. switch (ret) {
  6652. case Z_NEED_DICT:
  6653. case Z_DATA_ERROR:
  6654. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6655. }
  6656. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6657. return false;
  6658. }
  6659. }
  6660. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6661. } while (data_length > 0);
  6662. return true;
  6663. }
  6664. #endif
  6665. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6666. inline brotli_compressor::brotli_compressor() {
  6667. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6668. }
  6669. inline brotli_compressor::~brotli_compressor() {
  6670. BrotliEncoderDestroyInstance(state_);
  6671. }
  6672. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6673. bool last, Callback callback) {
  6674. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6675. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6676. auto available_in = data_length;
  6677. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6678. for (;;) {
  6679. if (last) {
  6680. if (BrotliEncoderIsFinished(state_)) { break; }
  6681. } else {
  6682. if (!available_in) { break; }
  6683. }
  6684. auto available_out = buff.size();
  6685. auto next_out = buff.data();
  6686. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6687. &available_out, &next_out, nullptr)) {
  6688. return false;
  6689. }
  6690. auto output_bytes = buff.size() - available_out;
  6691. if (output_bytes) {
  6692. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6693. }
  6694. }
  6695. return true;
  6696. }
  6697. inline brotli_decompressor::brotli_decompressor() {
  6698. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6699. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6700. : BROTLI_DECODER_RESULT_ERROR;
  6701. }
  6702. inline brotli_decompressor::~brotli_decompressor() {
  6703. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6704. }
  6705. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6706. inline bool brotli_decompressor::decompress(const char *data,
  6707. size_t data_length,
  6708. Callback callback) {
  6709. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6710. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6711. return 0;
  6712. }
  6713. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6714. size_t avail_in = data_length;
  6715. size_t total_out;
  6716. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6717. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6718. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6719. char *next_out = buff.data();
  6720. size_t avail_out = buff.size();
  6721. decoder_r = BrotliDecoderDecompressStream(
  6722. decoder_s, &avail_in, &next_in, &avail_out,
  6723. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6724. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6725. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6726. }
  6727. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6728. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6729. }
  6730. #endif
  6731. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6732. inline zstd_compressor::zstd_compressor() {
  6733. ctx_ = ZSTD_createCCtx();
  6734. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6735. }
  6736. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6737. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6738. bool last, Callback callback) {
  6739. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6740. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6741. ZSTD_inBuffer input = {data, data_length, 0};
  6742. bool finished;
  6743. do {
  6744. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6745. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6746. if (ZSTD_isError(remaining)) { return false; }
  6747. if (!callback(buff.data(), output.pos)) { return false; }
  6748. finished = last ? (remaining == 0) : (input.pos == input.size);
  6749. } while (!finished);
  6750. return true;
  6751. }
  6752. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6753. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6754. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6755. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6756. Callback callback) {
  6757. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6758. ZSTD_inBuffer input = {data, data_length, 0};
  6759. while (input.pos < input.size) {
  6760. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6761. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6762. if (ZSTD_isError(remaining)) { return false; }
  6763. if (!callback(buff.data(), output.pos)) { return false; }
  6764. }
  6765. return true;
  6766. }
  6767. #endif
  6768. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6769. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6770. // unknown coding, and its payload would be handed back still compressed.
  6771. inline bool is_zlib_encoding(const std::string &encoding) {
  6772. return case_ignore::equal(encoding, "gzip") ||
  6773. case_ignore::equal(encoding, "deflate");
  6774. }
  6775. inline bool is_brotli_encoding(const std::string &encoding) {
  6776. return case_ignore::equal(encoding, "br");
  6777. }
  6778. inline bool is_zstd_encoding(const std::string &encoding) {
  6779. return case_ignore::equal(encoding, "zstd");
  6780. }
  6781. // Returns true if the content coding is one cpp-httplib is able to decompress
  6782. // when the corresponding support is compiled in.
  6783. inline bool is_known_content_encoding(const std::string &encoding) {
  6784. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6785. is_zstd_encoding(encoding);
  6786. }
  6787. inline std::unique_ptr<decompressor>
  6788. create_decompressor(const std::string &encoding) {
  6789. std::unique_ptr<decompressor> decompressor;
  6790. if (is_zlib_encoding(encoding)) {
  6791. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6792. decompressor = detail::make_unique<gzip_decompressor>();
  6793. #endif
  6794. } else if (is_brotli_encoding(encoding)) {
  6795. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6796. decompressor = detail::make_unique<brotli_decompressor>();
  6797. #endif
  6798. } else if (is_zstd_encoding(encoding)) {
  6799. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6800. decompressor = detail::make_unique<zstd_decompressor>();
  6801. #endif
  6802. }
  6803. return decompressor;
  6804. }
  6805. // Returns the best available compressor and its Content-Encoding name.
  6806. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6807. inline std::pair<std::unique_ptr<compressor>, const char *>
  6808. create_compressor() {
  6809. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6810. return {detail::make_unique<brotli_compressor>(), "br"};
  6811. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6812. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6813. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6814. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6815. #else
  6816. return {nullptr, nullptr};
  6817. #endif
  6818. }
  6819. inline bool is_prohibited_header_name(const std::string &name) {
  6820. using udl::operator""_t;
  6821. switch (str2tag(name)) {
  6822. case "REMOTE_ADDR"_t:
  6823. case "REMOTE_PORT"_t:
  6824. case "LOCAL_ADDR"_t:
  6825. case "LOCAL_PORT"_t: return true;
  6826. default: return false;
  6827. }
  6828. }
  6829. inline bool has_header(const Headers &headers, const std::string &key) {
  6830. if (is_prohibited_header_name(key)) { return false; }
  6831. return headers.find(key) != headers.end();
  6832. }
  6833. inline const char *get_header_value(const Headers &headers,
  6834. const std::string &key, const char *def,
  6835. size_t id) {
  6836. if (is_prohibited_header_name(key)) {
  6837. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6838. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6839. throw std::invalid_argument(msg);
  6840. #else
  6841. return "";
  6842. #endif
  6843. }
  6844. auto rng = headers.equal_range(key);
  6845. auto it = bounded_next(rng.first, id, rng.second);
  6846. if (it != rng.second) { return it->second.c_str(); }
  6847. return def;
  6848. }
  6849. inline size_t get_header_value_count(const Headers &headers,
  6850. const std::string &key) {
  6851. return headers.count(key);
  6852. }
  6853. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6854. // list may be sent as several field lines, and the combined field value is
  6855. // those values joined by commas in the order they were received. Callers that
  6856. // parse such a list must work on the combined value; reading only the first
  6857. // occurrence silently drops whatever the later field lines carry.
  6858. inline std::string get_combined_header_value(const Headers &headers,
  6859. const std::string &key) {
  6860. std::string combined;
  6861. auto rng = headers.equal_range(key);
  6862. for (auto it = rng.first; it != rng.second; ++it) {
  6863. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6864. // elements, so an empty field line must not contribute a bare comma to the
  6865. // combined value.
  6866. if (it->second.empty()) { continue; }
  6867. if (!combined.empty()) { combined += ", "; }
  6868. combined += it->second;
  6869. }
  6870. return combined;
  6871. }
  6872. inline bool has_header_token(const Headers &headers, const std::string &key,
  6873. const std::string &token) {
  6874. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6875. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6876. // several lines. Match complete tokens rather than searching the raw value,
  6877. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6878. auto rng = headers.equal_range(key);
  6879. for (auto it = rng.first; it != rng.second; ++it) {
  6880. const auto &value = it->second;
  6881. if (split_find(value.data(), value.data() + value.size(), ',',
  6882. [&](const char *b, const char *e) {
  6883. return case_ignore::equal(std::string(b, e), token);
  6884. })) {
  6885. return true;
  6886. }
  6887. }
  6888. return false;
  6889. }
  6890. template <typename Map>
  6891. inline typename Map::mapped_type
  6892. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6893. auto rng = m.equal_range(key);
  6894. auto it = bounded_next(rng.first, id, rng.second);
  6895. if (it != rng.second) { return it->second; }
  6896. return typename Map::mapped_type();
  6897. }
  6898. inline void set_header(Headers &headers, const std::string &key,
  6899. const std::string &val) {
  6900. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6901. }
  6902. inline bool read_headers(Stream &strm, Headers &headers) {
  6903. const auto bufsiz = 2048;
  6904. char buf[bufsiz];
  6905. stream_line_reader line_reader(strm, buf, bufsiz);
  6906. size_t header_count = 0;
  6907. for (;;) {
  6908. if (!line_reader.getline()) { return false; }
  6909. // Check if the line ends with CRLF.
  6910. auto line_terminator_len = 2;
  6911. if (line_reader.end_with_crlf()) {
  6912. // Blank line indicates end of headers.
  6913. if (line_reader.size() == 2) { break; }
  6914. } else {
  6915. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6916. // Blank line indicates end of headers.
  6917. if (line_reader.size() == 1) { break; }
  6918. line_terminator_len = 1;
  6919. #else
  6920. continue; // Skip invalid line.
  6921. #endif
  6922. }
  6923. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6924. // Check header count limit
  6925. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6926. // Exclude line terminator
  6927. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6928. if (!parse_header(line_reader.ptr(), end,
  6929. [&](const std::string &key, const std::string &val) {
  6930. headers.emplace(key, val);
  6931. })) {
  6932. return false;
  6933. }
  6934. header_count++;
  6935. }
  6936. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6937. // headers that have different values to prevent request smuggling.
  6938. auto cl_range = headers.equal_range("Content-Length");
  6939. if (cl_range.first != cl_range.second) {
  6940. const auto &first_val = cl_range.first->second;
  6941. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6942. if (it->second != first_val) { return false; }
  6943. }
  6944. }
  6945. return true;
  6946. }
  6947. // Parsed by hand: std::regex_match recurses once per character of the reason
  6948. // phrase, which a server can make as long as a whole line.
  6949. inline bool parse_status_line(const char *line, std::string &version,
  6950. int &status, std::string &reason) {
  6951. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  6952. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  6953. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  6954. !is_ascii_digit(line[11])) {
  6955. return false;
  6956. }
  6957. auto p = line + 12;
  6958. auto reason_begin = p;
  6959. if (*p == ' ') {
  6960. reason_begin = ++p;
  6961. p += std::strcspn(p, "\r\n");
  6962. }
  6963. auto reason_end = p;
  6964. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6965. if (*p == '\r') { p++; }
  6966. #else
  6967. if (*p++ != '\r') { return false; }
  6968. #endif
  6969. if (*p++ != '\n' || *p != '\0') { return false; }
  6970. version.assign(line, 8);
  6971. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  6972. reason.assign(reason_begin, reason_end);
  6973. return true;
  6974. }
  6975. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6976. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6977. struct WebSocketUpgradeResponse {
  6978. Error error = Error::Success;
  6979. int status = -1;
  6980. Headers headers;
  6981. std::string selected_subprotocol;
  6982. };
  6983. inline bool
  6984. read_websocket_upgrade_response(Stream &strm,
  6985. const std::string &expected_accept,
  6986. const std::string &offered_subprotocols,
  6987. WebSocketUpgradeResponse &upgrade) {
  6988. // Read status line
  6989. const auto bufsiz = 2048;
  6990. char buf[bufsiz];
  6991. stream_line_reader line_reader(strm, buf, bufsiz);
  6992. if (!line_reader.getline()) {
  6993. upgrade.error = Error::Read;
  6994. return false;
  6995. }
  6996. std::string version;
  6997. std::string reason;
  6998. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6999. upgrade.error = Error::WebSocketHandshake;
  7000. return false;
  7001. }
  7002. // Read the headers even for a rejection so the caller can see why the
  7003. // server refused the upgrade. A non-101 response may carry a body; it is
  7004. // deliberately left unread since the caller closes the socket right away.
  7005. if (!read_headers(strm, upgrade.headers)) {
  7006. upgrade.error = Error::Read;
  7007. return false;
  7008. }
  7009. const auto &headers = upgrade.headers;
  7010. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7011. upgrade.error = Error::WebSocketHandshake;
  7012. return false;
  7013. }
  7014. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7015. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7016. upgrade.error = Error::WebSocketHandshake;
  7017. return false;
  7018. }
  7019. // Verify Connection: Upgrade
  7020. if (!has_header_token(headers, "Connection", "upgrade")) {
  7021. upgrade.error = Error::WebSocketHandshake;
  7022. return false;
  7023. }
  7024. // Verify Sec-WebSocket-Accept header value
  7025. auto it = headers.find("Sec-WebSocket-Accept");
  7026. if (it == headers.end() || it->second != expected_accept) {
  7027. upgrade.error = Error::WebSocketHandshake;
  7028. return false;
  7029. }
  7030. // Extract negotiated subprotocol
  7031. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7032. if (proto_it != headers.end()) {
  7033. upgrade.selected_subprotocol = proto_it->second;
  7034. }
  7035. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7036. if (!upgrade.selected_subprotocol.empty()) {
  7037. auto was_offered = false;
  7038. split(offered_subprotocols.data(),
  7039. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7040. [&](const char *b, const char *e) {
  7041. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7042. was_offered = true;
  7043. }
  7044. });
  7045. if (!was_offered) {
  7046. upgrade.error = Error::WebSocketHandshake;
  7047. return false;
  7048. }
  7049. }
  7050. return true;
  7051. }
  7052. enum class ReadContentResult {
  7053. Success, // Successfully read the content
  7054. PayloadTooLarge, // The content exceeds the specified payload limit
  7055. Error // An error occurred while reading the content
  7056. };
  7057. inline ReadContentResult read_content_with_length(
  7058. Stream &strm, size_t len, DownloadProgress progress,
  7059. ContentReceiverWithProgress out,
  7060. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7061. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7062. detail::BodyReader br;
  7063. br.stream = &strm;
  7064. br.has_content_length = true;
  7065. br.content_length = len;
  7066. br.payload_max_length = payload_max_length;
  7067. br.chunked = false;
  7068. br.bytes_read = 0;
  7069. br.last_error = Error::Success;
  7070. size_t r = 0;
  7071. while (r < len) {
  7072. auto read_len = static_cast<size_t>(len - r);
  7073. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7074. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7075. if (n <= 0) {
  7076. // Check if it was a payload size error
  7077. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7078. return ReadContentResult::PayloadTooLarge;
  7079. }
  7080. return ReadContentResult::Error;
  7081. }
  7082. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7083. return ReadContentResult::Error;
  7084. }
  7085. r += static_cast<size_t>(n);
  7086. if (progress) {
  7087. if (!progress(r, len)) { return ReadContentResult::Error; }
  7088. }
  7089. }
  7090. return ReadContentResult::Success;
  7091. }
  7092. inline ReadContentResult
  7093. read_content_without_length(Stream &strm, size_t payload_max_length,
  7094. ContentReceiverWithProgress out) {
  7095. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7096. size_t r = 0;
  7097. for (;;) {
  7098. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7099. if (n == 0) { return ReadContentResult::Success; }
  7100. if (n < 0) { return ReadContentResult::Error; }
  7101. // Check if adding this data would exceed the payload limit
  7102. if (payload_max_length > 0 &&
  7103. (r > payload_max_length ||
  7104. payload_max_length - r < static_cast<size_t>(n))) {
  7105. return ReadContentResult::PayloadTooLarge;
  7106. }
  7107. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7108. return ReadContentResult::Error;
  7109. }
  7110. r += static_cast<size_t>(n);
  7111. }
  7112. return ReadContentResult::Success;
  7113. }
  7114. template <typename T>
  7115. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7116. size_t payload_max_length,
  7117. ContentReceiverWithProgress out) {
  7118. detail::ChunkedDecoder dec(strm);
  7119. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7120. size_t total_len = 0;
  7121. for (;;) {
  7122. size_t chunk_offset = 0;
  7123. size_t chunk_total = 0;
  7124. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7125. if (n < 0) { return ReadContentResult::Error; }
  7126. if (n == 0) {
  7127. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7128. return ReadContentResult::Error;
  7129. }
  7130. return ReadContentResult::Success;
  7131. }
  7132. if (payload_max_length > 0 &&
  7133. (total_len > payload_max_length ||
  7134. payload_max_length - total_len < static_cast<size_t>(n))) {
  7135. return ReadContentResult::PayloadTooLarge;
  7136. }
  7137. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7138. return ReadContentResult::Error;
  7139. }
  7140. total_len += static_cast<size_t>(n);
  7141. }
  7142. }
  7143. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7144. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7145. // is the final transfer coding. A single field value may list several
  7146. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7147. // several Transfer-Encoding lines, which combine into one comma-separated
  7148. // list in the order the lines were received. Headers preserves that order,
  7149. // so the final coding is the last token of the last line. Match it
  7150. // case-insensitively rather than comparing the whole value against
  7151. // "chunked".
  7152. //
  7153. // Security: reading a chunked message as unframed leaves its body in the
  7154. // socket, where a keep-alive connection parses it as a smuggled request.
  7155. // Server::process_request() answers 400 and closes when the final coding is
  7156. // not chunked, so a request whose framing cannot be determined never
  7157. // reaches the "no body" path.
  7158. auto rng = headers.equal_range("Transfer-Encoding");
  7159. if (rng.first == rng.second) { return false; }
  7160. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7161. // combined list ending in nothing rather than inheriting the line before it.
  7162. std::string last_coding;
  7163. for (auto it = rng.first; it != rng.second; ++it) {
  7164. const auto &value = it->second;
  7165. last_coding.clear();
  7166. split(value.data(), value.data() + value.size(), ',',
  7167. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7168. }
  7169. return case_ignore::equal(last_coding, "chunked");
  7170. }
  7171. inline bool has_conflicting_content_length(const Headers &headers) {
  7172. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7173. // Content-Length is framed ambiguously. The body readers here delimit it by
  7174. // the transfer coding and drop Content-Length, while an intermediary may do
  7175. // the reverse, so the two disagree on where the body ends and a reused
  7176. // connection is desynchronised (request/response smuggling). Content-Length:
  7177. // 0 is tolerated for compatibility with existing peers.
  7178. return has_header(headers, "Transfer-Encoding") &&
  7179. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7180. }
  7181. template <typename T, typename U>
  7182. bool prepare_content_receiver(T &x, int &status,
  7183. ContentReceiverWithProgress receiver,
  7184. bool decompress, size_t payload_max_length,
  7185. bool &exceed_payload_max_length, U callback) {
  7186. if (decompress) {
  7187. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7188. std::unique_ptr<decompressor> decompressor;
  7189. if (!encoding.empty()) {
  7190. // A coding we know about but were not built with is an error. An
  7191. // unrecognized coding (including "identity") is left alone and the
  7192. // payload is passed through as-is, since some servers misuse the header,
  7193. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7194. decompressor = detail::create_decompressor(encoding);
  7195. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7196. status = StatusCode::UnsupportedMediaType_415;
  7197. return false;
  7198. }
  7199. }
  7200. if (decompressor) {
  7201. if (decompressor->is_valid()) {
  7202. size_t decompressed_size = 0;
  7203. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7204. size_t off, size_t len) {
  7205. return decompressor->decompress(
  7206. buf, n, [&](const char *buf2, size_t n2) {
  7207. // Guard against zip-bomb: check
  7208. // decompressed size against limit.
  7209. if (payload_max_length > 0 &&
  7210. (decompressed_size >= payload_max_length ||
  7211. n2 > payload_max_length - decompressed_size)) {
  7212. exceed_payload_max_length = true;
  7213. return false;
  7214. }
  7215. decompressed_size += n2;
  7216. return receiver(buf2, n2, off, len);
  7217. });
  7218. };
  7219. return callback(std::move(out));
  7220. } else {
  7221. status = StatusCode::InternalServerError_500;
  7222. return false;
  7223. }
  7224. }
  7225. }
  7226. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7227. size_t len) {
  7228. return receiver(buf, n, off, len);
  7229. };
  7230. return callback(std::move(out));
  7231. }
  7232. template <typename T>
  7233. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7234. DownloadProgress progress,
  7235. ContentReceiverWithProgress receiver, bool decompress) {
  7236. bool exceed_payload_max_length = false;
  7237. return prepare_content_receiver(
  7238. x, status, std::move(receiver), decompress, payload_max_length,
  7239. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7240. auto ret = true;
  7241. // Note: exceed_payload_max_length may also be set by the decompressor
  7242. // wrapper in prepare_content_receiver when the decompressed payload
  7243. // size exceeds the limit.
  7244. if (is_chunked_transfer_encoding(x.headers)) {
  7245. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7246. if (result == ReadContentResult::Success) {
  7247. ret = true;
  7248. } else if (result == ReadContentResult::PayloadTooLarge) {
  7249. exceed_payload_max_length = true;
  7250. ret = false;
  7251. } else {
  7252. ret = false;
  7253. }
  7254. } else if (!has_header(x.headers, "Content-Length")) {
  7255. auto result =
  7256. read_content_without_length(strm, payload_max_length, out);
  7257. if (result == ReadContentResult::Success) {
  7258. ret = true;
  7259. } else if (result == ReadContentResult::PayloadTooLarge) {
  7260. exceed_payload_max_length = true;
  7261. ret = false;
  7262. } else {
  7263. ret = false;
  7264. }
  7265. } else {
  7266. auto is_invalid_value = false;
  7267. auto len = get_header_value_u64(x.headers, "Content-Length",
  7268. (std::numeric_limits<size_t>::max)(),
  7269. 0, is_invalid_value);
  7270. if (is_invalid_value) {
  7271. ret = false;
  7272. } else if (len > 0) {
  7273. auto result = read_content_with_length(
  7274. strm, len, std::move(progress), out, payload_max_length);
  7275. ret = (result == ReadContentResult::Success);
  7276. if (result == ReadContentResult::PayloadTooLarge) {
  7277. exceed_payload_max_length = true;
  7278. }
  7279. }
  7280. }
  7281. if (!ret) {
  7282. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7283. : StatusCode::BadRequest_400;
  7284. }
  7285. return ret;
  7286. });
  7287. }
  7288. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7289. const std::string &path) {
  7290. // Neither the method nor the request target may carry CR/LF, SP or other
  7291. // control octets; otherwise a value smuggled into either splits the request
  7292. // line and injects headers or a whole request.
  7293. if (!fields::is_token(method)) { return -1; }
  7294. if (!fields::is_request_target(path)) { return -1; }
  7295. std::string s = method;
  7296. s += ' ';
  7297. s += path;
  7298. s += " HTTP/1.1\r\n";
  7299. return strm.write(s.data(), s.size());
  7300. }
  7301. inline ssize_t write_response_line(Stream &strm, int status) {
  7302. std::string s = "HTTP/1.1 ";
  7303. s += std::to_string(status);
  7304. s += ' ';
  7305. s += httplib::status_message(status);
  7306. s += "\r\n";
  7307. return strm.write(s.data(), s.size());
  7308. }
  7309. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7310. ssize_t write_len = 0;
  7311. for (const auto &x : headers) {
  7312. // Skip fields with invalid names or values to prevent response splitting
  7313. // via CR/LF injection, matching set_header(). The client validates request
  7314. // headers up front in check_and_write_headers, but the server passes
  7315. // res.headers straight to this writer, and res.headers is a public field
  7316. // an application can populate directly with request-derived values.
  7317. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7318. std::string s;
  7319. s = x.first;
  7320. s += ": ";
  7321. s += x.second;
  7322. s += "\r\n";
  7323. auto len = strm.write(s.data(), s.size());
  7324. if (len < 0) { return len; }
  7325. write_len += len;
  7326. }
  7327. auto len = strm.write("\r\n");
  7328. if (len < 0) { return len; }
  7329. write_len += len;
  7330. return write_len;
  7331. }
  7332. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7333. size_t offset = 0;
  7334. while (offset < l) {
  7335. auto length = strm.write(d + offset, l - offset);
  7336. if (length < 0) { return false; }
  7337. offset += static_cast<size_t>(length);
  7338. }
  7339. return true;
  7340. }
  7341. template <typename T>
  7342. inline bool write_content_with_progress(Stream &strm,
  7343. const ContentProvider &content_provider,
  7344. size_t offset, size_t length,
  7345. T is_shutting_down,
  7346. const UploadProgress &upload_progress,
  7347. Error &error) {
  7348. size_t end_offset = offset + length;
  7349. size_t start_offset = offset;
  7350. auto ok = true;
  7351. auto finished = false;
  7352. DataSink data_sink;
  7353. data_sink.write = [&](const char *d, size_t l) -> bool {
  7354. if (ok) {
  7355. if (write_data(strm, d, l)) {
  7356. offset += l;
  7357. if (upload_progress && length > 0) {
  7358. size_t current_written = offset - start_offset;
  7359. if (!upload_progress(current_written, length)) {
  7360. ok = false;
  7361. return false;
  7362. }
  7363. }
  7364. } else {
  7365. ok = false;
  7366. }
  7367. }
  7368. return ok;
  7369. };
  7370. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7371. // The body is framed by `length`, so a provider that reports itself done
  7372. // early has truncated it. Record that and let the short-body check below
  7373. // fail the write, rather than calling the provider again forever.
  7374. data_sink.done = [&]() { finished = true; };
  7375. while (offset < end_offset && !finished && !is_shutting_down()) {
  7376. auto last_offset = offset;
  7377. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7378. error = Error::Write;
  7379. return false;
  7380. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7381. error = Error::Canceled;
  7382. return false;
  7383. } else if (!ok) {
  7384. error = Error::Write;
  7385. return false;
  7386. }
  7387. // A provider that reports success without writing anything and without
  7388. // reporting itself done gets handed the same offset and length again on
  7389. // the next pass, so it would spin here for as long as the peer stays
  7390. // connected. Treat making no progress as a short body, like done() early.
  7391. if (!finished && offset == last_offset) {
  7392. error = Error::Write;
  7393. return false;
  7394. }
  7395. }
  7396. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7397. error = Error::Write;
  7398. return false;
  7399. }
  7400. error = Error::Success;
  7401. return true;
  7402. }
  7403. template <typename T>
  7404. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7405. size_t offset, size_t length, T is_shutting_down,
  7406. Error &error) {
  7407. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7408. is_shutting_down, nullptr, error);
  7409. }
  7410. template <typename T>
  7411. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7412. size_t offset, size_t length,
  7413. const T &is_shutting_down) {
  7414. auto error = Error::Success;
  7415. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7416. error);
  7417. }
  7418. template <typename T>
  7419. inline bool
  7420. write_content_without_length(Stream &strm,
  7421. const ContentProvider &content_provider,
  7422. const T &is_shutting_down) {
  7423. size_t offset = 0;
  7424. auto data_available = true;
  7425. auto ok = true;
  7426. DataSink data_sink;
  7427. data_sink.write = [&](const char *d, size_t l) -> bool {
  7428. if (ok) {
  7429. offset += l;
  7430. if (!write_data(strm, d, l)) { ok = false; }
  7431. }
  7432. return ok;
  7433. };
  7434. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7435. data_sink.done = [&](void) { data_available = false; };
  7436. while (data_available && !is_shutting_down()) {
  7437. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7438. return false;
  7439. } else if (!content_provider(offset, 0, data_sink)) {
  7440. return false;
  7441. } else if (!ok) {
  7442. return false;
  7443. }
  7444. }
  7445. return !data_available; // true only if done() was called, false if shutting
  7446. // down
  7447. }
  7448. // Runs a known-length content provider to completion and compresses what it
  7449. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7450. // by an mmap hands the compressor a pointer straight into the mapping.
  7451. inline bool compress_content_provider(const ContentProvider &content_provider,
  7452. size_t length, compressor &cmp,
  7453. std::string &out) {
  7454. size_t offset = 0;
  7455. auto ok = true;
  7456. auto finished = false;
  7457. DataSink data_sink;
  7458. auto append = [&](const char *data, size_t data_len) {
  7459. out.append(data, data_len);
  7460. return true;
  7461. };
  7462. data_sink.write = [&](const char *d, size_t l) -> bool {
  7463. if (!ok) { return false; }
  7464. offset += l;
  7465. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7466. return ok;
  7467. };
  7468. // The body is framed by `length`, so a provider that reports itself done
  7469. // early has truncated it; the short-body check below turns that into a
  7470. // failure rather than calling the provider again forever.
  7471. data_sink.done = [&]() { finished = true; };
  7472. while (offset < length && !finished) {
  7473. auto prev_offset = offset;
  7474. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7475. return false;
  7476. }
  7477. // No Stream to block on here, so a provider that keeps returning true
  7478. // without writing would spin. Treat a pass that made no progress as a
  7479. // failure.
  7480. if (offset == prev_offset) { return false; }
  7481. }
  7482. if (offset != length) { return false; }
  7483. return cmp.compress(nullptr, 0, true, append);
  7484. }
  7485. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7486. // and the file flag, so recording them has to come after; keeping all of it
  7487. // here means a third file-serving path cannot get that order wrong.
  7488. inline void set_file_content_provider(Response &res,
  7489. const std::shared_ptr<mmap> &m,
  7490. const std::string &content_type,
  7491. EncodingType encoding) {
  7492. res.set_content_provider(
  7493. m->size(), content_type,
  7494. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7495. // Never read past the mapping.
  7496. if (offset >= m->size()) { return false; }
  7497. sink.write(m->data() + offset, (std::min)(length, m->size() - offset));
  7498. return true;
  7499. });
  7500. res.is_file_content_provider_ = true;
  7501. res.content_coding_ = encoding;
  7502. }
  7503. template <typename T, typename U>
  7504. inline bool
  7505. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7506. const T &is_shutting_down, U &compressor, Error &error) {
  7507. size_t offset = 0;
  7508. auto data_available = true;
  7509. auto ok = true;
  7510. DataSink data_sink;
  7511. data_sink.write = [&](const char *d, size_t l) -> bool {
  7512. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7513. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7514. // zero-length chunk is the terminator, so it must not be emitted here.
  7515. if (ok && l > 0) {
  7516. offset += l;
  7517. std::string payload;
  7518. if (compressor.compress(d, l, false,
  7519. [&](const char *data, size_t data_len) {
  7520. payload.append(data, data_len);
  7521. return true;
  7522. })) {
  7523. if (!payload.empty()) {
  7524. // Emit chunked response header and footer for each chunk
  7525. auto chunk =
  7526. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7527. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7528. }
  7529. } else {
  7530. ok = false;
  7531. }
  7532. }
  7533. return ok;
  7534. };
  7535. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7536. auto done_with_trailer = [&](const Headers *trailer) {
  7537. if (!ok) { return; }
  7538. data_available = false;
  7539. std::string payload;
  7540. if (!compressor.compress(nullptr, 0, true,
  7541. [&](const char *data, size_t data_len) {
  7542. payload.append(data, data_len);
  7543. return true;
  7544. })) {
  7545. ok = false;
  7546. return;
  7547. }
  7548. if (!payload.empty()) {
  7549. // Emit chunked response header and footer for each chunk
  7550. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7551. if (!write_data(strm, chunk.data(), chunk.size())) {
  7552. ok = false;
  7553. return;
  7554. }
  7555. }
  7556. constexpr const char done_marker[] = "0\r\n";
  7557. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7558. // Trailer
  7559. if (trailer) {
  7560. for (const auto &kv : *trailer) {
  7561. // Skip fields with invalid names or values to prevent response
  7562. // splitting via CR/LF injection, matching set_header().
  7563. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7564. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7565. if (!write_data(strm, field_line.data(), field_line.size())) {
  7566. ok = false;
  7567. }
  7568. }
  7569. }
  7570. constexpr const char crlf[] = "\r\n";
  7571. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7572. };
  7573. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7574. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7575. done_with_trailer(&trailer);
  7576. };
  7577. while (data_available && !is_shutting_down()) {
  7578. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7579. error = Error::Write;
  7580. return false;
  7581. } else if (!content_provider(offset, 0, data_sink)) {
  7582. error = Error::Canceled;
  7583. return false;
  7584. } else if (!ok) {
  7585. error = Error::Write;
  7586. return false;
  7587. }
  7588. }
  7589. if (data_available) { // exited due to is_shutting_down(), not done()
  7590. error = Error::Write;
  7591. return false;
  7592. }
  7593. error = Error::Success;
  7594. return true;
  7595. }
  7596. template <typename T, typename U>
  7597. inline bool write_content_chunked(Stream &strm,
  7598. const ContentProvider &content_provider,
  7599. const T &is_shutting_down, U &compressor) {
  7600. auto error = Error::Success;
  7601. return write_content_chunked(strm, content_provider, is_shutting_down,
  7602. compressor, error);
  7603. }
  7604. template <typename T>
  7605. inline bool redirect(T &cli, Request &req, Response &res,
  7606. const std::string &path, const std::string &location,
  7607. Error &error) {
  7608. Request new_req = req;
  7609. new_req.path = path;
  7610. new_req.redirect_count_ -= 1;
  7611. if (res.status == StatusCode::SeeOther_303 &&
  7612. (req.method != "GET" && req.method != "HEAD")) {
  7613. new_req.method = "GET";
  7614. new_req.body.clear();
  7615. new_req.headers.clear();
  7616. new_req.content_length_ = 0;
  7617. new_req.content_provider_ = nullptr;
  7618. new_req.is_chunked_content_provider_ = false;
  7619. }
  7620. Response new_res;
  7621. auto ret = cli.send(new_req, new_res, error);
  7622. if (ret) {
  7623. req = std::move(new_req);
  7624. res = std::move(new_res);
  7625. if (res.location.empty()) { res.location = location; }
  7626. }
  7627. return ret;
  7628. }
  7629. inline std::string params_to_query_str(const Params &params) {
  7630. std::string query;
  7631. for (auto it = params.begin(); it != params.end(); ++it) {
  7632. if (it != params.begin()) { query += '&'; }
  7633. query += encode_query_component(it->first);
  7634. query += '=';
  7635. query += encode_query_component(it->second);
  7636. }
  7637. return query;
  7638. }
  7639. // Splits one "key=value" span of a query string at its first '='. A span with
  7640. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7641. // "?flag" keeps its name.
  7642. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7643. std::string &val) {
  7644. divide(b, static_cast<std::size_t>(e - b), '=',
  7645. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7646. std::size_t rhs_size) {
  7647. key.assign(lhs_data, lhs_size);
  7648. val.assign(rhs_data, rhs_size);
  7649. });
  7650. }
  7651. inline void parse_query_text(const char *data, std::size_t size,
  7652. Params &params) {
  7653. std::set<std::string> cache;
  7654. split(data, data + size, '&', [&](const char *b, const char *e) {
  7655. std::string kv(b, e);
  7656. if (cache.find(kv) != cache.end()) { return; }
  7657. cache.insert(std::move(kv));
  7658. std::string key;
  7659. std::string val;
  7660. divide_query_pair(b, e, key, val);
  7661. if (!key.empty()) {
  7662. params.emplace(decode_query_component(key), decode_query_component(val));
  7663. }
  7664. });
  7665. }
  7666. inline void parse_query_text(const std::string &s, Params &params) {
  7667. parse_query_text(s.data(), s.size(), params);
  7668. }
  7669. // Normalize a query string by decoding and re-encoding each key/value pair
  7670. // while preserving the original parameter order. This avoids double-encoding
  7671. // and ensures consistent encoding. It works on the raw string rather than
  7672. // parsing into Params and re-serializing, because that round trip cannot
  7673. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7674. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7675. // duplicated pairs.
  7676. inline std::string normalize_query_string(const std::string &query) {
  7677. std::string result;
  7678. split(query.data(), query.data() + query.size(), '&',
  7679. [&](const char *b, const char *e) {
  7680. std::string key;
  7681. std::string val;
  7682. divide_query_pair(b, e, key, val);
  7683. if (!key.empty()) {
  7684. auto dec_key = decode_query_component(key);
  7685. auto dec_val = decode_query_component(val);
  7686. if (!result.empty()) { result += '&'; }
  7687. result += encode_query_component(dec_key);
  7688. if (!val.empty() || std::find(b, e, '=') != e) {
  7689. result += '=';
  7690. result += encode_query_component(dec_val);
  7691. }
  7692. }
  7693. });
  7694. return result;
  7695. }
  7696. // Build the request target that goes on the wire from a caller-supplied path.
  7697. // Shared by the buffered send path and the streaming API so that both put the
  7698. // same bytes in the request line for the same input.
  7699. inline std::string encode_request_target(const std::string &target,
  7700. bool path_encode) {
  7701. // `substr(0, npos)` yields the whole string, which is what the no-query
  7702. // case needs.
  7703. auto query_pos = target.find('?');
  7704. auto path_part = target.substr(0, query_pos);
  7705. std::string query_part;
  7706. if (query_pos != std::string::npos) {
  7707. query_part = target.substr(query_pos + 1);
  7708. }
  7709. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7710. if (!query_part.empty()) {
  7711. // When path encoding is disabled the caller has supplied an already-encoded
  7712. // target and expects the exact bytes to be sent on the wire, so skip
  7713. // normalization for the query too. Normalizing would decode-then-re-encode
  7714. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7715. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7716. if (path_encode) {
  7717. auto normalized = normalize_query_string(query_part);
  7718. if (!normalized.empty()) {
  7719. result += '?';
  7720. result += normalized;
  7721. }
  7722. } else {
  7723. result += '?';
  7724. result += query_part;
  7725. }
  7726. }
  7727. return result;
  7728. }
  7729. inline bool parse_multipart_boundary(const std::string &content_type,
  7730. std::string &boundary) {
  7731. std::map<std::string, std::string> params;
  7732. extract_media_type(content_type, &params);
  7733. auto it = params.find("boundary");
  7734. if (it == params.end()) { return false; }
  7735. boundary = it->second;
  7736. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7737. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7738. // bytes costs a nearly full comparison at nearly every position: the
  7739. // boundary's length multiplies the worst-case cost of scanning a body.
  7740. return !boundary.empty() && boundary.size() <= 70;
  7741. }
  7742. inline void parse_disposition_params(const std::string &s, Params &params) {
  7743. std::set<std::string> cache;
  7744. split_unquoted(s.data(), s.data() + s.size(), ';',
  7745. [&](const char *b, const char *e) {
  7746. std::string kv(b, e);
  7747. if (cache.find(kv) != cache.end()) { return; }
  7748. cache.insert(kv);
  7749. std::string key;
  7750. std::string val;
  7751. divide_param_pair(b, e, key, val);
  7752. if (!key.empty()) {
  7753. params.emplace(trim_double_quotes_copy(key),
  7754. trim_double_quotes_copy(val));
  7755. }
  7756. });
  7757. }
  7758. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7759. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7760. #else
  7761. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7762. #endif
  7763. auto is_valid = [](const std::string &str) {
  7764. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7765. };
  7766. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7767. const auto pos = static_cast<size_t>(6);
  7768. const auto len = static_cast<size_t>(s.size() - 6);
  7769. auto all_valid_ranges = true;
  7770. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7771. if (!all_valid_ranges) { return; }
  7772. const auto it = std::find(b, e, '-');
  7773. if (it == e) {
  7774. all_valid_ranges = false;
  7775. return;
  7776. }
  7777. const auto lhs = std::string(b, it);
  7778. const auto rhs = std::string(it + 1, e);
  7779. if (!is_valid(lhs) || !is_valid(rhs)) {
  7780. all_valid_ranges = false;
  7781. return;
  7782. }
  7783. ssize_t first = -1;
  7784. if (!lhs.empty()) {
  7785. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7786. // would turn the range into a suffix range.
  7787. auto res =
  7788. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7789. if (res.ec != std::errc{}) {
  7790. all_valid_ranges = false;
  7791. return;
  7792. }
  7793. }
  7794. ssize_t last = -1;
  7795. if (!rhs.empty()) {
  7796. // An overflowing last-byte-pos is past any content length, so keeping
  7797. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7798. ssize_t v;
  7799. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7800. if (res.ec == std::errc{}) { last = v; }
  7801. }
  7802. if ((first == -1 && last == -1) ||
  7803. (first != -1 && last != -1 && first > last)) {
  7804. all_valid_ranges = false;
  7805. return;
  7806. }
  7807. ranges.emplace_back(first, last);
  7808. });
  7809. return all_valid_ranges && !ranges.empty();
  7810. }
  7811. return false;
  7812. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7813. }
  7814. #else
  7815. } catch (...) { return false; }
  7816. #endif
  7817. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7818. inline std::string remove_quoted_strings(const std::string &s) {
  7819. std::string out;
  7820. auto in_quotes = false;
  7821. for (size_t i = 0; i < s.size(); i++) {
  7822. if (s[i] == '"') {
  7823. in_quotes = !in_quotes;
  7824. } else if (!in_quotes) {
  7825. out += s[i];
  7826. } else if (s[i] == '\\') {
  7827. i++;
  7828. }
  7829. }
  7830. return out;
  7831. }
  7832. inline bool parse_accept_header(const std::string &s,
  7833. std::vector<std::string> &content_types) {
  7834. // Parameter values are not used here, so a quoted-string is dropped rather
  7835. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  7836. if (s.find('"') != std::string::npos) {
  7837. return parse_accept_header(remove_quoted_strings(s), content_types);
  7838. }
  7839. content_types.clear();
  7840. // Empty string is considered valid (no preference)
  7841. if (s.empty()) { return true; }
  7842. struct AcceptEntry {
  7843. std::string media_type;
  7844. double quality;
  7845. int order;
  7846. };
  7847. std::vector<AcceptEntry> entries;
  7848. int order = 0;
  7849. bool has_invalid_entry = false;
  7850. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7851. // has to parse and ignore empty list elements, so a leading, trailing or
  7852. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7853. // split() skips them, and the header length limit bounds how many a sender
  7854. // can send, so ignoring all of them cannot be used as a denial-of-service
  7855. // vector.
  7856. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7857. std::string entry(b, e);
  7858. entry = trim_copy(entry);
  7859. AcceptEntry accept_entry;
  7860. accept_entry.order = order++;
  7861. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7862. accept_entry.media_type, accept_entry.quality)) {
  7863. has_invalid_entry = true;
  7864. return;
  7865. }
  7866. // Remove additional parameters from media type
  7867. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7868. // Basic validation of media type format
  7869. if (accept_entry.media_type.empty()) {
  7870. has_invalid_entry = true;
  7871. return;
  7872. }
  7873. // Check for basic media type format (should contain '/' or be '*')
  7874. if (accept_entry.media_type != "*" &&
  7875. accept_entry.media_type.find('/') == std::string::npos) {
  7876. has_invalid_entry = true;
  7877. return;
  7878. }
  7879. entries.push_back(std::move(accept_entry));
  7880. });
  7881. // Return false if any invalid entry was found
  7882. if (has_invalid_entry) { return false; }
  7883. // Sort by quality (descending), then by original order (ascending)
  7884. std::sort(entries.begin(), entries.end(),
  7885. [](const AcceptEntry &a, const AcceptEntry &b) {
  7886. if (a.quality != b.quality) {
  7887. return a.quality > b.quality; // Higher quality first
  7888. }
  7889. return a.order < b.order; // Earlier order first for same quality
  7890. });
  7891. // Extract sorted media types
  7892. content_types.reserve(entries.size());
  7893. for (auto &entry : entries) {
  7894. content_types.push_back(std::move(entry.media_type));
  7895. }
  7896. return true;
  7897. }
  7898. class FormDataParser {
  7899. public:
  7900. FormDataParser() = default;
  7901. void set_boundary(std::string &&boundary) {
  7902. boundary_ = std::move(boundary);
  7903. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7904. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7905. }
  7906. bool is_valid() const { return is_valid_; }
  7907. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7908. const ContentReceiver &content_callback) {
  7909. // Once the close delimiter has been seen the rest of the body is epilogue
  7910. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7911. // spread across reads is not copied in only to be erased right away.
  7912. if (state_ == 5) { return true; }
  7913. buf_append(buf, n);
  7914. while (buf_size() > 0) {
  7915. switch (state_) {
  7916. case 0: { // Initial boundary
  7917. auto pos = buf_find(dash_boundary_crlf_);
  7918. if (pos == buf_size()) {
  7919. // Not found yet: keep only a possible partial boundary at the tail so
  7920. // that a body which never contains the boundary cannot grow the
  7921. // buffer (and get rescanned from the start) without bound.
  7922. auto keep = dash_boundary_crlf_.size() - 1;
  7923. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7924. return true;
  7925. }
  7926. buf_erase(pos + dash_boundary_crlf_.size());
  7927. state_ = 1;
  7928. break;
  7929. }
  7930. case 1: { // New entry
  7931. clear_file_info();
  7932. state_ = 2;
  7933. break;
  7934. }
  7935. case 2: { // Headers
  7936. auto pos = buf_find(crlf_);
  7937. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7938. while (pos < buf_size()) {
  7939. // Empty line
  7940. if (pos == 0) {
  7941. if (!header_callback(file_)) {
  7942. is_valid_ = false;
  7943. return false;
  7944. }
  7945. buf_erase(crlf_.size());
  7946. state_ = 3;
  7947. break;
  7948. }
  7949. // Check header count limit
  7950. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7951. is_valid_ = false;
  7952. return false;
  7953. }
  7954. header_count_++;
  7955. const auto header = buf_head(pos);
  7956. if (!parse_header(header.data(), header.data() + header.size(),
  7957. [&](const std::string &, const std::string &) {})) {
  7958. is_valid_ = false;
  7959. return false;
  7960. }
  7961. // Parse and emplace space trimmed headers into a map
  7962. if (!parse_header(
  7963. header.data(), header.data() + header.size(),
  7964. [&](const std::string &key, const std::string &val) {
  7965. file_.headers.emplace(key, val);
  7966. })) {
  7967. is_valid_ = false;
  7968. return false;
  7969. }
  7970. constexpr const char header_content_type[] = "Content-Type:";
  7971. if (start_with_case_ignore(header, header_content_type)) {
  7972. file_.content_type =
  7973. trim_copy(header.substr(str_len(header_content_type)));
  7974. } else {
  7975. std::string disposition_params;
  7976. if (parse_content_disposition(header, disposition_params)) {
  7977. Params params;
  7978. parse_disposition_params(disposition_params, params);
  7979. auto it = params.find("name");
  7980. if (it != params.end()) {
  7981. file_.name = it->second;
  7982. } else {
  7983. is_valid_ = false;
  7984. return false;
  7985. }
  7986. it = params.find("filename");
  7987. if (it != params.end()) { file_.filename = it->second; }
  7988. it = params.find("filename*");
  7989. if (it != params.end()) {
  7990. // RFC 5987: only UTF-8 encoding is allowed
  7991. const auto &val = it->second;
  7992. constexpr const char utf8_prefix[] = "UTF-8''";
  7993. constexpr size_t prefix_len = str_len(utf8_prefix);
  7994. if (val.size() > prefix_len &&
  7995. start_with_case_ignore(val, utf8_prefix)) {
  7996. file_.filename = decode_path_component(
  7997. val.substr(prefix_len)); // override...
  7998. } else {
  7999. is_valid_ = false;
  8000. return false;
  8001. }
  8002. }
  8003. }
  8004. }
  8005. buf_erase(pos + crlf_.size());
  8006. pos = buf_find(crlf_);
  8007. }
  8008. if (state_ != 3) { return true; }
  8009. break;
  8010. }
  8011. case 3: { // Body
  8012. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8013. auto pos = buf_find(crlf_dash_boundary_);
  8014. if (pos < buf_size()) {
  8015. if (!content_callback(buf_data(), pos)) {
  8016. is_valid_ = false;
  8017. return false;
  8018. }
  8019. buf_erase(pos + crlf_dash_boundary_.size());
  8020. state_ = 4;
  8021. } else {
  8022. auto len = buf_size() - crlf_dash_boundary_.size();
  8023. if (len > 0) {
  8024. if (!content_callback(buf_data(), len)) {
  8025. is_valid_ = false;
  8026. return false;
  8027. }
  8028. buf_erase(len);
  8029. }
  8030. return true;
  8031. }
  8032. break;
  8033. }
  8034. case 4: { // Boundary
  8035. if (crlf_.size() > buf_size()) { return true; }
  8036. if (buf_start_with(crlf_)) {
  8037. buf_erase(crlf_.size());
  8038. state_ = 1;
  8039. } else if (buf_start_with(dash_)) {
  8040. buf_erase(dash_.size());
  8041. is_valid_ = true;
  8042. state_ = 5;
  8043. } else {
  8044. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8045. // accepted after a boundary; RFC 2046 allows transport-padding in
  8046. // between, but this parser has never supported it. Either way the
  8047. // body is already destined to be rejected, so fail now instead of
  8048. // buffering the rest of it. Both are two bytes, so the check above
  8049. // already guarantees enough buffered data to decide.
  8050. is_valid_ = false;
  8051. return false;
  8052. }
  8053. break;
  8054. }
  8055. case 5: { // Epilogue
  8056. buf_erase(buf_size());
  8057. break;
  8058. }
  8059. }
  8060. }
  8061. return true;
  8062. }
  8063. private:
  8064. void clear_file_info() {
  8065. file_.name.clear();
  8066. file_.filename.clear();
  8067. file_.content_type.clear();
  8068. file_.headers.clear();
  8069. header_count_ = 0;
  8070. }
  8071. bool start_with_case_ignore(const std::string &a, const char *b,
  8072. size_t offset = 0) const {
  8073. const auto b_len = strlen(b);
  8074. if (a.size() < offset + b_len) { return false; }
  8075. for (size_t i = 0; i < b_len; i++) {
  8076. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8077. return false;
  8078. }
  8079. }
  8080. return true;
  8081. }
  8082. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8083. // Returns true if header matches, with the params portion in `params_out`.
  8084. bool parse_content_disposition(const std::string &header,
  8085. std::string &params_out) const {
  8086. constexpr const char prefix[] = "Content-Disposition:";
  8087. constexpr size_t prefix_len = str_len(prefix);
  8088. if (!start_with_case_ignore(header, prefix)) { return false; }
  8089. // Skip whitespace after "Content-Disposition:"
  8090. auto pos = prefix_len;
  8091. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8092. pos++;
  8093. }
  8094. // Match "form-data;" (case-insensitive)
  8095. constexpr const char form_data[] = "form-data;";
  8096. constexpr size_t form_data_len = str_len(form_data);
  8097. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8098. pos += form_data_len;
  8099. // Skip whitespace after "form-data;"
  8100. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8101. pos++;
  8102. }
  8103. params_out = header.substr(pos);
  8104. return true;
  8105. }
  8106. const std::string dash_ = "--";
  8107. const std::string crlf_ = "\r\n";
  8108. std::string boundary_;
  8109. std::string dash_boundary_crlf_;
  8110. std::string crlf_dash_boundary_;
  8111. size_t state_ = 0;
  8112. bool is_valid_ = false;
  8113. FormData file_;
  8114. size_t header_count_ = 0;
  8115. // Buffer
  8116. bool start_with(const std::string &a, size_t spos, size_t epos,
  8117. const std::string &b) const {
  8118. if (epos - spos < b.size()) { return false; }
  8119. for (size_t i = 0; i < b.size(); i++) {
  8120. if (a[i + spos] != b[i]) { return false; }
  8121. }
  8122. return true;
  8123. }
  8124. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8125. const char *buf_data() const { return &buf_[buf_spos_]; }
  8126. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8127. bool buf_start_with(const std::string &s) const {
  8128. return start_with(buf_, buf_spos_, buf_epos_, s);
  8129. }
  8130. size_t buf_find(const std::string &s) const {
  8131. auto c = s.front();
  8132. size_t off = buf_spos_;
  8133. while (off < buf_epos_) {
  8134. auto pos = off;
  8135. while (true) {
  8136. if (pos == buf_epos_) { return buf_size(); }
  8137. if (buf_[pos] == c) { break; }
  8138. pos++;
  8139. }
  8140. auto remaining_size = buf_epos_ - pos;
  8141. if (s.size() > remaining_size) { return buf_size(); }
  8142. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8143. off = pos + 1;
  8144. }
  8145. return buf_size();
  8146. }
  8147. void buf_append(const char *data, size_t n) {
  8148. auto remaining_size = buf_size();
  8149. if (remaining_size > 0 && buf_spos_ > 0) {
  8150. for (size_t i = 0; i < remaining_size; i++) {
  8151. buf_[i] = buf_[buf_spos_ + i];
  8152. }
  8153. }
  8154. buf_spos_ = 0;
  8155. buf_epos_ = remaining_size;
  8156. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8157. for (size_t i = 0; i < n; i++) {
  8158. buf_[buf_epos_ + i] = data[i];
  8159. }
  8160. buf_epos_ += n;
  8161. }
  8162. void buf_erase(size_t size) { buf_spos_ += size; }
  8163. std::string buf_;
  8164. size_t buf_spos_ = 0;
  8165. size_t buf_epos_ = 0;
  8166. };
  8167. inline std::string random_string(size_t length) {
  8168. constexpr const char data[] =
  8169. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8170. std::string result(length, '\0');
  8171. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8172. for (auto &c : result) {
  8173. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8174. }
  8175. return result;
  8176. }
  8177. inline std::string make_multipart_data_boundary() {
  8178. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8179. }
  8180. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8181. auto valid = true;
  8182. for (size_t i = 0; i < boundary.size(); i++) {
  8183. auto c = boundary[i];
  8184. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8185. valid = false;
  8186. break;
  8187. }
  8188. }
  8189. return valid;
  8190. }
  8191. // Escape a multipart field name/filename following the WHATWG HTML standard
  8192. // ("escape a multipart form-data name"), which is what browsers send:
  8193. // '"' -> %22, CR -> %0D, LF -> %0A
  8194. // With escape_quote = false, only CR and LF are escaped; this is for header
  8195. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8196. inline std::string escape_multipart_field(const std::string &s,
  8197. bool escape_quote = true) {
  8198. std::string result;
  8199. result.reserve(s.size());
  8200. for (auto c : s) {
  8201. switch (c) {
  8202. case '"':
  8203. if (escape_quote) {
  8204. result += "%22";
  8205. } else {
  8206. result += c;
  8207. }
  8208. break;
  8209. case '\r': result += "%0D"; break;
  8210. case '\n': result += "%0A"; break;
  8211. default: result += c; break;
  8212. }
  8213. }
  8214. return result;
  8215. }
  8216. template <typename T>
  8217. inline std::string
  8218. serialize_multipart_formdata_item_begin(const T &item,
  8219. const std::string &boundary) {
  8220. std::string body = "--" + boundary + "\r\n";
  8221. body += "Content-Disposition: form-data; name=\"" +
  8222. escape_multipart_field(item.name) + "\"";
  8223. if (!item.filename.empty()) {
  8224. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8225. }
  8226. body += "\r\n";
  8227. if (!item.content_type.empty()) {
  8228. body +=
  8229. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8230. "\r\n";
  8231. }
  8232. body += "\r\n";
  8233. return body;
  8234. }
  8235. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8236. inline std::string
  8237. serialize_multipart_formdata_finish(const std::string &boundary) {
  8238. return "--" + boundary + "--\r\n";
  8239. }
  8240. inline std::string
  8241. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8242. return "multipart/form-data; boundary=" + boundary;
  8243. }
  8244. inline std::string
  8245. serialize_multipart_formdata(const UploadFormDataItems &items,
  8246. const std::string &boundary, bool finish = true) {
  8247. std::string body;
  8248. for (const auto &item : items) {
  8249. body += serialize_multipart_formdata_item_begin(item, boundary);
  8250. body += item.content + serialize_multipart_formdata_item_end();
  8251. }
  8252. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8253. return body;
  8254. }
  8255. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8256. const std::string &boundary) {
  8257. size_t total = 0;
  8258. for (const auto &item : items) {
  8259. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8260. total += item.content.size();
  8261. total += serialize_multipart_formdata_item_end().size();
  8262. }
  8263. total += serialize_multipart_formdata_finish(boundary).size();
  8264. return total;
  8265. }
  8266. struct MultipartSegment {
  8267. const char *data;
  8268. size_t size;
  8269. };
  8270. // NOTE: items must outlive the returned ContentProvider
  8271. // (safe for synchronous use inside Post/Put/Patch)
  8272. inline ContentProvider
  8273. make_multipart_content_provider(const UploadFormDataItems &items,
  8274. const std::string &boundary) {
  8275. // Own the per-item header strings and the finish string
  8276. std::vector<std::string> owned;
  8277. owned.reserve(items.size() + 1);
  8278. for (const auto &item : items)
  8279. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8280. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8281. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8282. std::vector<MultipartSegment> segs;
  8283. segs.reserve(items.size() * 3 + 1);
  8284. static const char crlf[] = "\r\n";
  8285. for (size_t i = 0; i < items.size(); i++) {
  8286. segs.push_back({owned[i].data(), owned[i].size()});
  8287. segs.push_back({items[i].content.data(), items[i].content.size()});
  8288. segs.push_back({crlf, 2});
  8289. }
  8290. segs.push_back({owned.back().data(), owned.back().size()});
  8291. struct MultipartState {
  8292. std::vector<std::string> owned;
  8293. std::vector<MultipartSegment> segs;
  8294. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8295. };
  8296. auto state = std::make_shared<MultipartState>();
  8297. state->owned = std::move(owned);
  8298. // `segs` holds raw pointers into owned strings; std::string move preserves
  8299. // the data pointer, so these pointers remain valid after the move above.
  8300. state->segs = std::move(segs);
  8301. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8302. // Buffer multiple small segments into fewer, larger writes to avoid
  8303. // excessive TCP packets when there are many form data items (#2410)
  8304. auto &buf = state->buf;
  8305. auto buf_size = buf.size();
  8306. size_t buf_len = 0;
  8307. size_t remaining = length;
  8308. // Find the first segment containing 'offset'
  8309. size_t pos = 0;
  8310. size_t seg_idx = 0;
  8311. for (; seg_idx < state->segs.size(); seg_idx++) {
  8312. const auto &seg = state->segs[seg_idx];
  8313. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8314. pos += seg.size;
  8315. }
  8316. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8317. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8318. const auto &seg = state->segs[seg_idx];
  8319. size_t available = seg.size - seg_offset;
  8320. size_t to_copy = (std::min)(available, remaining);
  8321. const char *src = seg.data + seg_offset;
  8322. seg_offset = 0; // only the first segment has a non-zero offset
  8323. while (to_copy > 0) {
  8324. size_t space = buf_size - buf_len;
  8325. size_t chunk = (std::min)(to_copy, space);
  8326. std::memcpy(buf.data() + buf_len, src, chunk);
  8327. buf_len += chunk;
  8328. src += chunk;
  8329. to_copy -= chunk;
  8330. remaining -= chunk;
  8331. if (buf_len == buf_size) {
  8332. if (!sink.write(buf.data(), buf_len)) { return false; }
  8333. buf_len = 0;
  8334. }
  8335. }
  8336. }
  8337. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8338. return true;
  8339. };
  8340. }
  8341. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8342. if (ranges.size() <= 1) return;
  8343. // Sort ranges by start position
  8344. std::sort(ranges.begin(), ranges.end(),
  8345. [](const Range &a, const Range &b) { return a.first < b.first; });
  8346. Ranges coalesced;
  8347. coalesced.reserve(ranges.size());
  8348. for (auto &r : ranges) {
  8349. auto first_pos = r.first;
  8350. auto last_pos = r.second;
  8351. // Handle special cases like in range_error
  8352. if (first_pos == -1 && last_pos == -1) {
  8353. first_pos = 0;
  8354. last_pos = static_cast<ssize_t>(content_length);
  8355. }
  8356. if (first_pos == -1) {
  8357. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8358. last_pos = static_cast<ssize_t>(content_length) - 1;
  8359. }
  8360. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8361. last_pos = static_cast<ssize_t>(content_length) - 1;
  8362. }
  8363. // Skip invalid ranges
  8364. if (!(0 <= first_pos && first_pos <= last_pos &&
  8365. last_pos < static_cast<ssize_t>(content_length))) {
  8366. continue;
  8367. }
  8368. // Coalesce with previous range if overlapping or adjacent (but not
  8369. // identical)
  8370. if (!coalesced.empty()) {
  8371. auto &prev = coalesced.back();
  8372. // Check if current range overlaps or is adjacent to previous range
  8373. // but don't coalesce identical ranges (allow duplicates)
  8374. if (first_pos <= prev.second + 1 &&
  8375. !(first_pos == prev.first && last_pos == prev.second)) {
  8376. // Extend the previous range
  8377. prev.second = (std::max)(prev.second, last_pos);
  8378. continue;
  8379. }
  8380. }
  8381. // Add new range
  8382. coalesced.emplace_back(first_pos, last_pos);
  8383. }
  8384. ranges = std::move(coalesced);
  8385. }
  8386. inline bool range_error(Request &req, Response &res) {
  8387. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8388. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8389. req.ranges.clear();
  8390. if (res.status == StatusCode::PartialContent_206) {
  8391. res.status = StatusCode::OK_200;
  8392. }
  8393. return false;
  8394. }
  8395. ssize_t content_len = static_cast<ssize_t>(
  8396. res.content_length_ ? res.content_length_ : res.body.size());
  8397. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8398. size_t overwrapping_count = 0;
  8399. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8400. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8401. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8402. // Too many ranges
  8403. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8404. for (auto &r : req.ranges) {
  8405. auto &first_pos = r.first;
  8406. auto &last_pos = r.second;
  8407. if (first_pos == -1 && last_pos == -1) {
  8408. first_pos = 0;
  8409. last_pos = content_len;
  8410. }
  8411. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8412. // selects the entire representation.
  8413. if (first_pos == -1) {
  8414. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8415. last_pos = content_len - 1;
  8416. }
  8417. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8418. // A client can limit the number of bytes requested without knowing the
  8419. // size of the selected representation. If the last-pos value is absent,
  8420. // or if the value is greater than or equal to the current length of the
  8421. // representation data, the byte range is interpreted as the remainder of
  8422. // the representation (i.e., the server replaces the value of last-pos
  8423. // with a value that is one less than the current length of the selected
  8424. // representation).
  8425. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8426. if (last_pos == -1 || last_pos >= content_len) {
  8427. last_pos = content_len - 1;
  8428. }
  8429. // Range must be within content length
  8430. if (!(0 <= first_pos && first_pos <= last_pos &&
  8431. last_pos <= content_len - 1)) {
  8432. return true;
  8433. }
  8434. // Request must not have more than two overlapping ranges
  8435. for (const auto &processed_range : processed_ranges) {
  8436. if (!(last_pos < processed_range.first ||
  8437. first_pos > processed_range.second)) {
  8438. overwrapping_count++;
  8439. if (overwrapping_count > 2) { return true; }
  8440. break; // Only count once per range
  8441. }
  8442. }
  8443. processed_ranges.emplace_back(first_pos, last_pos);
  8444. }
  8445. // After validation, coalesce overlapping ranges as per RFC 9110
  8446. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8447. }
  8448. return false;
  8449. }
  8450. inline std::pair<size_t, size_t>
  8451. get_range_offset_and_length(Range r, size_t content_length) {
  8452. assert(r.first != -1 && r.second != -1);
  8453. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8454. assert(r.first <= r.second &&
  8455. r.second < static_cast<ssize_t>(content_length));
  8456. (void)(content_length);
  8457. return std::make_pair(static_cast<size_t>(r.first),
  8458. static_cast<size_t>(r.second - r.first) + 1);
  8459. }
  8460. inline std::string make_content_range_header_field(
  8461. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8462. auto st = offset_and_length.first;
  8463. auto ed = st + offset_and_length.second - 1;
  8464. std::string field = "bytes ";
  8465. field += std::to_string(st);
  8466. field += '-';
  8467. field += std::to_string(ed);
  8468. field += '/';
  8469. field += std::to_string(content_length);
  8470. return field;
  8471. }
  8472. template <typename SToken, typename CToken, typename Content>
  8473. bool process_multipart_ranges_data(const Request &req,
  8474. const std::string &boundary,
  8475. const std::string &content_type,
  8476. size_t content_length, SToken stoken,
  8477. CToken ctoken, Content content) {
  8478. for (size_t i = 0; i < req.ranges.size(); i++) {
  8479. ctoken("--");
  8480. stoken(boundary);
  8481. ctoken("\r\n");
  8482. if (!content_type.empty()) {
  8483. ctoken("Content-Type: ");
  8484. stoken(content_type);
  8485. ctoken("\r\n");
  8486. }
  8487. auto offset_and_length =
  8488. get_range_offset_and_length(req.ranges[i], content_length);
  8489. ctoken("Content-Range: ");
  8490. stoken(make_content_range_header_field(offset_and_length, content_length));
  8491. ctoken("\r\n");
  8492. ctoken("\r\n");
  8493. if (!content(offset_and_length.first, offset_and_length.second)) {
  8494. return false;
  8495. }
  8496. ctoken("\r\n");
  8497. }
  8498. ctoken("--");
  8499. stoken(boundary);
  8500. ctoken("--");
  8501. return true;
  8502. }
  8503. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8504. const std::string &boundary,
  8505. const std::string &content_type,
  8506. size_t content_length,
  8507. std::string &data) {
  8508. process_multipart_ranges_data(
  8509. req, boundary, content_type, content_length,
  8510. [&](const std::string &token) { data += token; },
  8511. [&](const std::string &token) { data += token; },
  8512. [&](size_t offset, size_t length) {
  8513. assert(offset + length <= content_length);
  8514. data += res.body.substr(offset, length);
  8515. return true;
  8516. });
  8517. }
  8518. inline size_t get_multipart_ranges_data_length(const Request &req,
  8519. const std::string &boundary,
  8520. const std::string &content_type,
  8521. size_t content_length) {
  8522. size_t data_length = 0;
  8523. process_multipart_ranges_data(
  8524. req, boundary, content_type, content_length,
  8525. [&](const std::string &token) { data_length += token.size(); },
  8526. [&](const std::string &token) { data_length += token.size(); },
  8527. [&](size_t /*offset*/, size_t length) {
  8528. data_length += length;
  8529. return true;
  8530. });
  8531. return data_length;
  8532. }
  8533. template <typename T>
  8534. inline bool
  8535. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8536. const std::string &boundary,
  8537. const std::string &content_type,
  8538. size_t content_length, const T &is_shutting_down) {
  8539. return process_multipart_ranges_data(
  8540. req, boundary, content_type, content_length,
  8541. [&](const std::string &token) { strm.write(token); },
  8542. [&](const std::string &token) { strm.write(token); },
  8543. [&](size_t offset, size_t length) {
  8544. return write_content(strm, res.content_provider_, offset, length,
  8545. is_shutting_down);
  8546. });
  8547. }
  8548. inline bool has_framed_body(const Request &req) {
  8549. return is_chunked_transfer_encoding(req.headers) ||
  8550. req.get_header_value_u64("Content-Length") > 0;
  8551. }
  8552. inline bool is_connection_persistent(const Request &req) {
  8553. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8554. if (req.version == "HTTP/1.0" &&
  8555. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8556. return false;
  8557. }
  8558. return true;
  8559. }
  8560. inline bool expect_content(const Request &req) {
  8561. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8562. req.method == "DELETE") {
  8563. return true;
  8564. }
  8565. return has_framed_body(req);
  8566. }
  8567. #ifdef _WIN32
  8568. class WSInit {
  8569. public:
  8570. WSInit() {
  8571. WSADATA wsaData;
  8572. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8573. }
  8574. ~WSInit() {
  8575. if (is_valid_) WSACleanup();
  8576. }
  8577. bool is_valid_ = false;
  8578. };
  8579. static WSInit wsinit_;
  8580. #endif
  8581. // RFC 9110 Section 11.6.1 defines a challenge list as
  8582. // WWW-Authenticate = #challenge
  8583. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8584. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8585. // so a server may offer several schemes, each with its own comma-separated
  8586. // auth-param list, in either order and either as separate field lines or
  8587. // packed into one. Splitting on every comma would break apart a challenge's
  8588. // own param list; splitting only on the first space would miss a Digest
  8589. // challenge that isn't first. Split on commas that aren't inside a
  8590. // quoted-string instead, then track which scheme each resulting segment
  8591. // belongs to: a segment whose text before "=" contains whitespace (or that
  8592. // has no "=" at all) starts a new challenge named by its leading token.
  8593. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8594. std::vector<std::string> segments;
  8595. size_t start = 0;
  8596. auto in_quotes = false;
  8597. for (size_t i = 0; i < s.size(); i++) {
  8598. auto c = s[i];
  8599. if (in_quotes) {
  8600. if (c == '\\' && i + 1 < s.size()) {
  8601. i++;
  8602. } else if (c == '"') {
  8603. in_quotes = false;
  8604. }
  8605. } else if (c == '"') {
  8606. in_quotes = true;
  8607. } else if (c == ',') {
  8608. segments.push_back(s.substr(start, i - start));
  8609. start = i + 1;
  8610. }
  8611. }
  8612. segments.push_back(s.substr(start));
  8613. return segments;
  8614. }
  8615. inline std::string unescape_quoted_pairs(const std::string &s) {
  8616. std::string out;
  8617. out.reserve(s.size());
  8618. for (size_t i = 0; i < s.size(); i++) {
  8619. if (s[i] == '\\' && i + 1 < s.size()) {
  8620. out += s[++i];
  8621. } else {
  8622. out += s[i];
  8623. }
  8624. }
  8625. return out;
  8626. }
  8627. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8628. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8629. // quoted-pair, so the recipient recovers the original value.
  8630. inline std::string escape_quoted_pairs(const std::string &s) {
  8631. std::string out;
  8632. out.reserve(s.size());
  8633. for (auto c : s) {
  8634. if (c == '\\' || c == '"') { out += '\\'; }
  8635. out += c;
  8636. }
  8637. return out;
  8638. }
  8639. inline bool parse_www_authenticate(const Response &res,
  8640. std::map<std::string, std::string> &auth,
  8641. bool is_proxy) {
  8642. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8643. auto combined = get_combined_header_value(res.headers, auth_key);
  8644. if (combined.empty()) { return false; }
  8645. auto found_digest = false;
  8646. auto in_digest_challenge = false;
  8647. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8648. auto segment = trim_copy(raw_segment);
  8649. if (segment.empty()) { continue; }
  8650. auto eq_pos = segment.find('=');
  8651. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8652. // for the first segment of a challenge, "<scheme> <key>") must be
  8653. // trimmed before its boundaries are inspected.
  8654. auto key_part = trim_copy(
  8655. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8656. auto space_pos = key_part.find_last_of(" \t");
  8657. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8658. // "<scheme>[ <key>]" starts a new challenge.
  8659. auto scheme_end =
  8660. space_pos == std::string::npos ? key_part.size() : space_pos;
  8661. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8662. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8663. // from one challenge is never paired with another's algorithm.
  8664. in_digest_challenge =
  8665. !found_digest &&
  8666. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8667. if (in_digest_challenge) { found_digest = true; }
  8668. if (space_pos == std::string::npos) {
  8669. // Bare scheme (or a token68), no auth-param on this segment.
  8670. continue;
  8671. }
  8672. key_part = key_part.substr(space_pos + 1);
  8673. }
  8674. if (!in_digest_challenge) { continue; }
  8675. auto val = trim_copy(segment.substr(eq_pos + 1));
  8676. auto unquoted = trim_double_quotes_copy(val);
  8677. if (unquoted.size() != val.size()) {
  8678. unquoted = unescape_quoted_pairs(unquoted);
  8679. }
  8680. auth[std::move(key_part)] = std::move(unquoted);
  8681. }
  8682. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8683. // make_digest_authentication_header() dereferences both unconditionally, so
  8684. // a challenge missing either can't produce a usable Authorization header.
  8685. // Treat it the same as no Digest challenge at all.
  8686. return found_digest && auth.find("realm") != auth.end() &&
  8687. auth.find("nonce") != auth.end();
  8688. }
  8689. class ContentProviderAdapter {
  8690. public:
  8691. explicit ContentProviderAdapter(
  8692. ContentProviderWithoutLength &&content_provider)
  8693. : content_provider_(std::move(content_provider)) {}
  8694. bool operator()(size_t offset, size_t, DataSink &sink) {
  8695. return content_provider_(offset, sink);
  8696. }
  8697. private:
  8698. ContentProviderWithoutLength content_provider_;
  8699. };
  8700. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8701. namespace fields {
  8702. inline bool is_token_char(char c) {
  8703. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8704. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8705. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8706. }
  8707. inline bool is_token(const std::string &s) {
  8708. if (s.empty()) { return false; }
  8709. for (auto c : s) {
  8710. if (!is_token_char(c)) { return false; }
  8711. }
  8712. return true;
  8713. }
  8714. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8715. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8716. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8717. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8718. inline bool is_field_content(const std::string &s) {
  8719. if (s.empty()) { return true; }
  8720. if (s.size() == 1) {
  8721. return is_field_vchar(s[0]);
  8722. } else if (s.size() == 2) {
  8723. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8724. } else {
  8725. size_t i = 0;
  8726. if (!is_field_vchar(s[i])) { return false; }
  8727. i++;
  8728. while (i < s.size() - 1) {
  8729. auto c = s[i++];
  8730. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8731. } else {
  8732. return false;
  8733. }
  8734. }
  8735. return is_field_vchar(s[i]);
  8736. }
  8737. }
  8738. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8739. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8740. return is_field_name(name) && is_field_value(value);
  8741. }
  8742. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8743. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8744. inline bool is_request_target(const std::string &s) {
  8745. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8746. }
  8747. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8748. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8749. inline bool is_host(const std::string &s) {
  8750. return std::all_of(s.begin(), s.end(), [](char c) {
  8751. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8752. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8753. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8754. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8755. });
  8756. }
  8757. } // namespace fields
  8758. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8759. WebSocketUpgradeResponse &upgrade) {
  8760. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8761. std::string key_bytes(16, '\0');
  8762. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8763. key_bytes.size());
  8764. auto client_key = base64_encode(key_bytes);
  8765. req.headers.erase("Upgrade");
  8766. req.headers.erase("Connection");
  8767. req.headers.erase("Sec-WebSocket-Key");
  8768. req.headers.erase("Sec-WebSocket-Version");
  8769. req.headers.emplace("Upgrade", "websocket");
  8770. req.headers.emplace("Connection", "Upgrade");
  8771. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8772. req.headers.emplace("Sec-WebSocket-Version", "13");
  8773. // Build the request in memory first, like ClientImpl::write_request does.
  8774. // Writing straight to the socket would leak a request line onto the wire
  8775. // before check_and_write_headers gets a chance to reject an invalid header,
  8776. // and would emit one small write per header.
  8777. BufferStream bstrm;
  8778. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8779. upgrade.error = Error::Write;
  8780. return false;
  8781. }
  8782. auto error = Error::Success;
  8783. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8784. upgrade.error = error;
  8785. return false;
  8786. }
  8787. const auto &data = bstrm.get_buffer();
  8788. if (!write_data(strm, data.data(), data.size())) {
  8789. upgrade.error = Error::Write;
  8790. return false;
  8791. }
  8792. // Verify 101 response and Sec-WebSocket-Accept header
  8793. auto expected_accept = websocket_accept_key(client_key);
  8794. auto offered_subprotocols =
  8795. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8796. return read_websocket_upgrade_response(strm, expected_accept,
  8797. offered_subprotocols, upgrade);
  8798. }
  8799. inline bool is_ip_address(const std::string &host) {
  8800. struct in_addr addr4;
  8801. struct in6_addr addr6;
  8802. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8803. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8804. }
  8805. // Resolve where a client should connect for `host`, honoring a user-supplied
  8806. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8807. // supplying the Host header and SNI; only the connection target changes.
  8808. //
  8809. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8810. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8811. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8812. // absent or empty mapping leaves `host` as the connection target; without the
  8813. // empty check the value would reach getaddrinfo as a null node and silently
  8814. // resolve to loopback.
  8815. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8816. const std::string &host, std::string &connect_host,
  8817. std::string &ip) {
  8818. connect_host = host;
  8819. ip.clear();
  8820. auto it = addr_map.find(host);
  8821. if (it == addr_map.end() || it->second.empty()) { return; }
  8822. if (is_ip_address(it->second)) {
  8823. ip = it->second;
  8824. } else {
  8825. connect_host = it->second;
  8826. }
  8827. }
  8828. } // namespace detail
  8829. /*
  8830. * Group 2: detail namespace - SSL common utilities
  8831. */
  8832. #ifdef CPPHTTPLIB_SSL_ENABLED
  8833. namespace detail {
  8834. class SSLSocketStream final : public Stream {
  8835. public:
  8836. SSLSocketStream(
  8837. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8838. time_t read_timeout_usec, time_t write_timeout_sec,
  8839. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8840. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8841. (std::chrono::steady_clock::time_point::min)());
  8842. ~SSLSocketStream() override;
  8843. bool is_readable() const override;
  8844. bool wait_readable() const override;
  8845. bool wait_writable() const override;
  8846. bool is_peer_alive() const override;
  8847. ssize_t read(char *ptr, size_t size) override;
  8848. ssize_t write(const char *ptr, size_t size) override;
  8849. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8850. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8851. socket_t socket() const override;
  8852. time_t duration() const override;
  8853. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8854. // See SocketStream::set_readable_hint().
  8855. void set_readable_hint() { readable_hint_ = true; }
  8856. private:
  8857. bool ensure_readable();
  8858. socket_t sock_;
  8859. tls::session_t session_;
  8860. time_t read_timeout_sec_;
  8861. time_t read_timeout_usec_;
  8862. time_t write_timeout_sec_;
  8863. time_t write_timeout_usec_;
  8864. time_t max_timeout_msec_;
  8865. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8866. bool readable_hint_ = false;
  8867. };
  8868. // A TLS stream for WebSocket connections, where the receive path and the
  8869. // send path (application send() plus the heartbeat ping thread) run on
  8870. // different threads. A single TLS session must never be entered
  8871. // concurrently, so every call into the session is serialized by one mutex.
  8872. //
  8873. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8874. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8875. // call under the lock, then waits for readiness with select() outside the
  8876. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8877. // blocked waiting for data never stalls a concurrent sender.
  8878. //
  8879. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8880. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8881. class WebSocketSSLStream final : public Stream {
  8882. public:
  8883. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8884. time_t read_timeout_sec, time_t read_timeout_usec,
  8885. time_t write_timeout_sec, time_t write_timeout_usec);
  8886. ~WebSocketSSLStream() override;
  8887. bool is_readable() const override;
  8888. bool wait_readable() const override;
  8889. bool wait_writable() const override;
  8890. ssize_t read(char *ptr, size_t size) override;
  8891. ssize_t write(const char *ptr, size_t size) override;
  8892. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8893. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8894. socket_t socket() const override;
  8895. time_t duration() const override;
  8896. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8897. private:
  8898. mutable std::mutex session_mutex_;
  8899. socket_t sock_;
  8900. tls::session_t session_;
  8901. // WebSocket::close() shortens the read timeout from the closing thread
  8902. // while the receive thread is inside wait_readable(), so these two are read
  8903. // and written concurrently. The write timeouts are never mutated.
  8904. std::atomic<time_t> read_timeout_sec_;
  8905. std::atomic<time_t> read_timeout_usec_;
  8906. time_t write_timeout_sec_;
  8907. time_t write_timeout_usec_;
  8908. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8909. };
  8910. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8911. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8912. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8913. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8914. unsigned int hash_length = 0;
  8915. unsigned char hash[EVP_MAX_MD_SIZE];
  8916. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8917. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8918. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8919. std::stringstream ss;
  8920. for (auto i = 0u; i < hash_length; ++i) {
  8921. ss << std::hex << std::setw(2) << std::setfill('0')
  8922. << static_cast<unsigned int>(hash[i]);
  8923. }
  8924. return ss.str();
  8925. }
  8926. inline std::string MD5(const std::string &s) {
  8927. return message_digest(s, EVP_md5());
  8928. }
  8929. inline std::string SHA_256(const std::string &s) {
  8930. return message_digest(s, EVP_sha256());
  8931. }
  8932. inline std::string SHA_512(const std::string &s) {
  8933. return message_digest(s, EVP_sha512());
  8934. }
  8935. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8936. namespace {
  8937. template <size_t N>
  8938. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8939. std::stringstream ss;
  8940. for (size_t i = 0; i < N; ++i) {
  8941. ss << std::hex << std::setw(2) << std::setfill('0')
  8942. << static_cast<unsigned int>(hash[i]);
  8943. }
  8944. return ss.str();
  8945. }
  8946. } // namespace
  8947. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8948. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8949. // initialized once. PSA state is process-global; do not free it.
  8950. inline bool ensure_mbedtls_psa_crypto() {
  8951. static std::once_flag once;
  8952. static bool ok = false;
  8953. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8954. return ok;
  8955. }
  8956. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8957. unsigned char *out, size_t out_size) {
  8958. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8959. size_t olen = 0;
  8960. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8961. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8962. olen == out_size;
  8963. }
  8964. #endif
  8965. inline std::string MD5(const std::string &s) {
  8966. unsigned char hash[16];
  8967. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8968. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8969. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8970. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8971. hash);
  8972. #else
  8973. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8974. hash);
  8975. #endif
  8976. return hash_to_hex(hash);
  8977. }
  8978. inline std::string SHA_256(const std::string &s) {
  8979. unsigned char hash[32];
  8980. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8981. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8982. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8983. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8984. hash, 0);
  8985. #else
  8986. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8987. s.size(), hash, 0);
  8988. #endif
  8989. return hash_to_hex(hash);
  8990. }
  8991. inline std::string SHA_512(const std::string &s) {
  8992. unsigned char hash[64];
  8993. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8994. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8995. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8996. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8997. hash, 0);
  8998. #else
  8999. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9000. s.size(), hash, 0);
  9001. #endif
  9002. return hash_to_hex(hash);
  9003. }
  9004. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9005. namespace {
  9006. template <size_t N>
  9007. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9008. std::stringstream ss;
  9009. for (size_t i = 0; i < N; ++i) {
  9010. ss << std::hex << std::setw(2) << std::setfill('0')
  9011. << static_cast<unsigned int>(hash[i]);
  9012. }
  9013. return ss.str();
  9014. }
  9015. } // namespace
  9016. inline std::string MD5(const std::string &s) {
  9017. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9018. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9019. static_cast<word32>(s.size()), hash);
  9020. return hash_to_hex(hash);
  9021. }
  9022. inline std::string SHA_256(const std::string &s) {
  9023. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9024. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9025. static_cast<word32>(s.size()), hash);
  9026. return hash_to_hex(hash);
  9027. }
  9028. inline std::string SHA_512(const std::string &s) {
  9029. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9030. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9031. static_cast<word32>(s.size()), hash);
  9032. return hash_to_hex(hash);
  9033. }
  9034. #endif
  9035. template <typename T>
  9036. inline bool process_server_socket_ssl(
  9037. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9038. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9039. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9040. time_t write_timeout_usec, T callback) {
  9041. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9042. // of a pipelined request, which keep_alive() cannot see on the socket.
  9043. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9044. write_timeout_sec, write_timeout_usec);
  9045. return process_server_socket_core(
  9046. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9047. [&]() { return strm.is_readable(); },
  9048. [&](bool socket_readable, bool close_connection,
  9049. bool &connection_closed) {
  9050. if (socket_readable) { strm.set_readable_hint(); }
  9051. return callback(strm, close_connection, connection_closed);
  9052. });
  9053. }
  9054. template <typename T>
  9055. inline bool process_client_socket_ssl(
  9056. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9057. time_t read_timeout_usec, time_t write_timeout_sec,
  9058. time_t write_timeout_usec, time_t max_timeout_msec,
  9059. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9060. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9061. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9062. start_time);
  9063. return callback(strm);
  9064. }
  9065. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9066. const Request &req, const std::map<std::string, std::string> &auth,
  9067. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  9068. const std::string &password, bool is_proxy = false) {
  9069. std::string nc;
  9070. {
  9071. std::stringstream ss;
  9072. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9073. nc = ss.str();
  9074. }
  9075. std::string qop;
  9076. if (auth.find("qop") != auth.end()) {
  9077. qop = auth.at("qop");
  9078. if (qop.find("auth-int") != std::string::npos) {
  9079. qop = "auth-int";
  9080. } else if (qop.find("auth") != std::string::npos) {
  9081. qop = "auth";
  9082. } else {
  9083. qop.clear();
  9084. }
  9085. }
  9086. std::string algo = "MD5";
  9087. if (auth.find("algorithm") != auth.end()) {
  9088. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9089. // not a token would otherwise be emitted verbatim and could carry commas
  9090. // or quotes that inject further auth-params into the header below.
  9091. const auto &a = auth.at("algorithm");
  9092. if (fields::is_token(a)) { algo = a; }
  9093. }
  9094. std::string response;
  9095. {
  9096. auto H = algo == "SHA-256" ? detail::SHA_256
  9097. : algo == "SHA-512" ? detail::SHA_512
  9098. : detail::MD5;
  9099. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9100. auto A2 = req.method + ":" + req.path;
  9101. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9102. if (qop.empty()) {
  9103. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9104. } else {
  9105. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9106. ":" + qop + ":" + H(A2));
  9107. }
  9108. }
  9109. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9110. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9111. // close the string early. realm, nonce and opaque come straight from the
  9112. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9113. // without this a crafted challenge injects extra auth-params into the header.
  9114. auto field =
  9115. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9116. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9117. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9118. "\", uri=\"" + detail::escape_quoted_pairs(req.path) +
  9119. "\", algorithm=" + algo +
  9120. (qop.empty() ? ", response=\""
  9121. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9122. "\", response=\"") +
  9123. response + "\"" +
  9124. (opaque.empty()
  9125. ? ""
  9126. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9127. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9128. return std::make_pair(key, field);
  9129. }
  9130. inline bool match_hostname(const std::string &pattern,
  9131. const std::string &hostname) {
  9132. // Exact match (case-insensitive)
  9133. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  9134. // Split both pattern and hostname into components by '.'
  9135. std::vector<std::string> pattern_components;
  9136. if (!pattern.empty()) {
  9137. split(pattern.data(), pattern.data() + pattern.size(), '.',
  9138. [&](const char *b, const char *e) {
  9139. pattern_components.emplace_back(b, e);
  9140. });
  9141. }
  9142. std::vector<std::string> host_components;
  9143. if (!hostname.empty()) {
  9144. split(hostname.data(), hostname.data() + hostname.size(), '.',
  9145. [&](const char *b, const char *e) {
  9146. host_components.emplace_back(b, e);
  9147. });
  9148. }
  9149. // Component count must match
  9150. if (host_components.size() != pattern_components.size()) { return false; }
  9151. // Compare each component with wildcard support
  9152. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9153. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9154. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9155. auto itr = pattern_components.begin();
  9156. for (const auto &h : host_components) {
  9157. auto &p = *itr;
  9158. auto is_leftmost = itr == pattern_components.begin();
  9159. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9160. bool partial_match = false;
  9161. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9162. const auto prefix_length = p.size() - 1;
  9163. if (prefix_length == 0) {
  9164. partial_match = true;
  9165. } else if (h.size() >= prefix_length) {
  9166. partial_match =
  9167. std::equal(p.begin(),
  9168. p.begin() + static_cast<std::string::difference_type>(
  9169. prefix_length),
  9170. h.begin(), [](const char ca, const char cb) {
  9171. return detail::case_ignore::to_lower(ca) ==
  9172. detail::case_ignore::to_lower(cb);
  9173. });
  9174. }
  9175. }
  9176. if (!partial_match) { return false; }
  9177. }
  9178. ++itr;
  9179. }
  9180. return true;
  9181. }
  9182. #ifdef _WIN32
  9183. // Verify certificate using Windows CertGetCertificateChain API.
  9184. // This provides real-time certificate validation with Windows Update
  9185. // integration, independent of the TLS backend.
  9186. inline bool verify_cert_with_windows_schannel(
  9187. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9188. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9189. if (der_cert.empty()) { return false; }
  9190. out_error = 0;
  9191. // Create Windows certificate context from DER data
  9192. auto cert_context = CertCreateCertificateContext(
  9193. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9194. static_cast<DWORD>(der_cert.size()));
  9195. if (!cert_context) {
  9196. out_error = GetLastError();
  9197. return false;
  9198. }
  9199. auto cert_guard =
  9200. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9201. // Give CryptoAPI the certificates the server sent. Without them it follows
  9202. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9203. std::vector<tls::cert_t> peer_certs;
  9204. tls::get_peer_certs(session, peer_certs);
  9205. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9206. auto store_guard = scope_exit([&] {
  9207. for (auto cert : peer_certs) {
  9208. tls::free_cert(cert);
  9209. }
  9210. if (store) { CertCloseStore(store, 0); }
  9211. });
  9212. for (auto cert : peer_certs) {
  9213. std::vector<unsigned char> der;
  9214. if (store && tls::get_cert_der(cert, der)) {
  9215. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9216. static_cast<DWORD>(der.size()),
  9217. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9218. }
  9219. }
  9220. // Setup chain parameters
  9221. CERT_CHAIN_PARA chain_para = {};
  9222. chain_para.cbSize = sizeof(chain_para);
  9223. // Require the server authentication usage along the chain, which also
  9224. // rejects roots that Windows trusts only for other purposes.
  9225. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9226. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9227. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9228. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9229. // Build certificate chain with revocation checking
  9230. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9231. auto chain_result = CertGetCertificateChain(
  9232. nullptr, cert_context, nullptr, store, &chain_para,
  9233. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9234. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9235. nullptr, &chain_context);
  9236. if (!chain_result || !chain_context) {
  9237. out_error = GetLastError();
  9238. return false;
  9239. }
  9240. auto chain_guard =
  9241. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9242. // Verify SSL policy
  9243. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9244. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9245. #ifdef AUTHTYPE_SERVER
  9246. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9247. #endif
  9248. std::wstring whost;
  9249. if (verify_hostname) {
  9250. whost = u8string_to_wstring(hostname.c_str());
  9251. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9252. }
  9253. CERT_CHAIN_POLICY_PARA policy_para = {};
  9254. policy_para.cbSize = sizeof(policy_para);
  9255. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9256. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9257. #else
  9258. policy_para.dwFlags = 0;
  9259. #endif
  9260. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9261. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9262. policy_status.cbSize = sizeof(policy_status);
  9263. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9264. &policy_para, &policy_status)) {
  9265. out_error = GetLastError();
  9266. return false;
  9267. }
  9268. if (policy_status.dwError != 0) {
  9269. out_error = policy_status.dwError;
  9270. return false;
  9271. }
  9272. return true;
  9273. }
  9274. #endif // _WIN32
  9275. // Loads CA file/dir configuration and applies the system CA policy to a
  9276. // client TLS context. PEM data and native stores are applied to the context
  9277. // directly at set time; has_custom_store reflects them for the Auto policy
  9278. // decision.
  9279. inline bool load_client_ca_config(tls::ctx_t ctx,
  9280. const std::string &ca_cert_file_path,
  9281. const std::string &ca_cert_dir_path,
  9282. bool has_custom_store, SystemCAMode mode,
  9283. uint64_t &backend_error) {
  9284. auto ret = true;
  9285. if (!ca_cert_file_path.empty()) {
  9286. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9287. backend_error = tls::get_error();
  9288. ret = false;
  9289. }
  9290. } else if (!ca_cert_dir_path.empty()) {
  9291. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9292. backend_error = tls::get_error();
  9293. ret = false;
  9294. }
  9295. }
  9296. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9297. !ca_cert_dir_path.empty() || has_custom_store;
  9298. if (mode == SystemCAMode::Enabled ||
  9299. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9300. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9301. }
  9302. return ret;
  9303. }
  9304. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9305. std::vector<tls::cert_t> certs;
  9306. tls::get_ca_certs(ctx, certs);
  9307. std::string pem;
  9308. for (auto cert : certs) {
  9309. std::vector<unsigned char> der;
  9310. if (tls::get_cert_der(cert, der)) {
  9311. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9312. pem += "-----BEGIN CERTIFICATE-----\n";
  9313. for (size_t i = 0; i < b64.size(); i += 64) {
  9314. pem += b64.substr(i, 64) + "\n";
  9315. }
  9316. pem += "-----END CERTIFICATE-----\n";
  9317. }
  9318. tls::free_cert(cert);
  9319. }
  9320. return pem;
  9321. }
  9322. // The parts of session setup that only SSLClient needs, plus the handful
  9323. // WebSocketClient also exposes; everything else takes the defaults, which is
  9324. // what keeps the two clients on one implementation.
  9325. struct ClientTlsSessionOptions {
  9326. // Both SSLClient and WebSocketClient expose this independently of
  9327. // certificate verification.
  9328. bool server_hostname_verification = true;
  9329. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9330. // When non-null, guards session creation against concurrent use of the
  9331. // context. A WebSocketClient is not safe to use from several threads to
  9332. // begin with, so it passes nothing.
  9333. std::mutex *ctx_mutex = nullptr;
  9334. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9335. // The caller decides whether Schannel has anything to say about this
  9336. // connection; see SSLClient::initialize_ssl().
  9337. bool windows_cert_verification = false;
  9338. // A server certificate verifier works on the backend's chain verification,
  9339. // so the backend keeps deciding and Schannel only adds its own check.
  9340. bool server_certificate_verifier_set = false;
  9341. #endif
  9342. };
  9343. // Filled in on failure for callers that report error details.
  9344. struct ClientTlsSessionError {
  9345. Error error = Error::Success;
  9346. int ssl_error = 0;
  9347. uint64_t backend_error = 0;
  9348. };
  9349. // Establishes a client TLS session on an already connected socket. On failure
  9350. // the session is left for the caller to free: SSLClient frees it right away,
  9351. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9352. inline bool setup_client_tls_session(
  9353. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9354. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9355. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9356. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9357. using namespace tls;
  9358. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9359. if (out_error) {
  9360. out_error->error = error;
  9361. out_error->ssl_error = ssl_error;
  9362. out_error->backend_error = backend_error;
  9363. }
  9364. return false;
  9365. };
  9366. if (!ctx) {
  9367. session = nullptr;
  9368. return fail(Error::SSLConnection, 0, 0);
  9369. }
  9370. // With Windows verification on and no server certificate verifier set,
  9371. // Schannel is the only chain verifier. The backend's trust store is a
  9372. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9373. // demand, so the backend's verdict is not used.
  9374. auto windows_verifies_chain = false;
  9375. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9376. windows_verifies_chain = options.windows_cert_verification &&
  9377. !options.server_certificate_verifier_set;
  9378. #endif
  9379. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9380. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9381. // uses SSL_VERIFY_NONE and does all verification post-handshake. Unless
  9382. // Schannel verifies the chain instead, chain verification happens during
  9383. // the handshake even for IP hosts; the certificate identity is verified
  9384. // post-handshake via verify_hostname().
  9385. set_verify_client(ctx,
  9386. server_certificate_verification && !windows_verifies_chain);
  9387. #endif
  9388. {
  9389. std::unique_lock<std::mutex> guard;
  9390. if (options.ctx_mutex) {
  9391. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9392. }
  9393. session = create_session(ctx, sock);
  9394. }
  9395. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9396. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9397. // their identity is checked post-handshake below instead. On Mbed TLS and
  9398. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9399. // options.server_hostname_verification is threaded through here.
  9400. if (!is_ip_address(host)) {
  9401. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9402. return fail(Error::SSLConnection, 0, get_error());
  9403. }
  9404. }
  9405. TlsError tls_err;
  9406. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9407. &tls_err)) {
  9408. auto error = Error::SSLConnection;
  9409. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9410. error = Error::SSLServerVerification;
  9411. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9412. error = Error::SSLServerHostnameVerification;
  9413. }
  9414. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9415. }
  9416. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9417. if (options.session_verifier) {
  9418. verification_status = options.session_verifier(session);
  9419. }
  9420. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9421. return fail(Error::SSLServerVerification, 0, get_error());
  9422. }
  9423. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9424. server_certificate_verification) {
  9425. if (!windows_verifies_chain) {
  9426. auto verify_result = get_verify_result(session);
  9427. if (verify_result != 0) {
  9428. return fail(Error::SSLServerVerification, 0,
  9429. static_cast<uint64_t>(verify_result));
  9430. }
  9431. }
  9432. auto server_cert = get_peer_cert(session);
  9433. if (!server_cert) {
  9434. return fail(Error::SSLServerVerification, 0, get_error());
  9435. }
  9436. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9437. // Identity check against the peer certificate, post-handshake for all
  9438. // backends. For IP hosts this is the only identity verification, since no
  9439. // hostname is bound during the handshake.
  9440. if (options.server_hostname_verification) {
  9441. if (!verify_hostname(server_cert, host.c_str())) {
  9442. return fail(Error::SSLServerHostnameVerification, 0,
  9443. hostname_mismatch_code());
  9444. }
  9445. }
  9446. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9447. // Windows Schannel verification, which lets Windows fetch missing roots
  9448. // and intermediates on demand. It must not be skipped: unless a server
  9449. // certificate verifier is set, it is the only chain check.
  9450. if (options.windows_cert_verification) {
  9451. std::vector<unsigned char> der;
  9452. uint64_t wincrypt_error = 0;
  9453. if (!get_cert_der(server_cert, der) ||
  9454. !verify_cert_with_windows_schannel(
  9455. der, host, options.server_hostname_verification, wincrypt_error,
  9456. session)) {
  9457. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9458. }
  9459. }
  9460. #endif
  9461. }
  9462. return true;
  9463. }
  9464. } // namespace detail
  9465. #endif // CPPHTTPLIB_SSL_ENABLED
  9466. /*
  9467. * Group 3: httplib namespace - Non-SSL public API implementations
  9468. */
  9469. inline void default_socket_options(socket_t sock) {
  9470. set_socket_opt(sock, SOL_SOCKET,
  9471. #ifdef SO_REUSEPORT
  9472. SO_REUSEPORT,
  9473. #else
  9474. SO_REUSEADDR,
  9475. #endif
  9476. 1);
  9477. }
  9478. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9479. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9480. sizeof(optval));
  9481. }
  9482. inline std::string get_bearer_token_auth(const Request &req) {
  9483. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9484. // than the prefix carries no token.
  9485. constexpr const char bearer_prefix[] = "Bearer ";
  9486. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9487. auto value = req.get_header_value("Authorization");
  9488. if (value.size() >= bearer_prefix_len &&
  9489. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9490. bearer_prefix)) {
  9491. return value.substr(bearer_prefix_len);
  9492. }
  9493. return "";
  9494. }
  9495. inline const char *status_message(int status) {
  9496. switch (status) {
  9497. case StatusCode::Continue_100: return "Continue";
  9498. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9499. case StatusCode::Processing_102: return "Processing";
  9500. case StatusCode::EarlyHints_103: return "Early Hints";
  9501. case StatusCode::OK_200: return "OK";
  9502. case StatusCode::Created_201: return "Created";
  9503. case StatusCode::Accepted_202: return "Accepted";
  9504. case StatusCode::NonAuthoritativeInformation_203:
  9505. return "Non-Authoritative Information";
  9506. case StatusCode::NoContent_204: return "No Content";
  9507. case StatusCode::ResetContent_205: return "Reset Content";
  9508. case StatusCode::PartialContent_206: return "Partial Content";
  9509. case StatusCode::MultiStatus_207: return "Multi-Status";
  9510. case StatusCode::AlreadyReported_208: return "Already Reported";
  9511. case StatusCode::IMUsed_226: return "IM Used";
  9512. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9513. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9514. case StatusCode::Found_302: return "Found";
  9515. case StatusCode::SeeOther_303: return "See Other";
  9516. case StatusCode::NotModified_304: return "Not Modified";
  9517. case StatusCode::UseProxy_305: return "Use Proxy";
  9518. case StatusCode::unused_306: return "unused";
  9519. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9520. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9521. case StatusCode::BadRequest_400: return "Bad Request";
  9522. case StatusCode::Unauthorized_401: return "Unauthorized";
  9523. case StatusCode::PaymentRequired_402: return "Payment Required";
  9524. case StatusCode::Forbidden_403: return "Forbidden";
  9525. case StatusCode::NotFound_404: return "Not Found";
  9526. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9527. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9528. case StatusCode::ProxyAuthenticationRequired_407:
  9529. return "Proxy Authentication Required";
  9530. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9531. case StatusCode::Conflict_409: return "Conflict";
  9532. case StatusCode::Gone_410: return "Gone";
  9533. case StatusCode::LengthRequired_411: return "Length Required";
  9534. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9535. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9536. case StatusCode::UriTooLong_414: return "URI Too Long";
  9537. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9538. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9539. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9540. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9541. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9542. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9543. case StatusCode::Locked_423: return "Locked";
  9544. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9545. case StatusCode::TooEarly_425: return "Too Early";
  9546. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9547. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9548. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9549. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9550. return "Request Header Fields Too Large";
  9551. case StatusCode::UnavailableForLegalReasons_451:
  9552. return "Unavailable For Legal Reasons";
  9553. case StatusCode::NotImplemented_501: return "Not Implemented";
  9554. case StatusCode::BadGateway_502: return "Bad Gateway";
  9555. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9556. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9557. case StatusCode::HttpVersionNotSupported_505:
  9558. return "HTTP Version Not Supported";
  9559. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9560. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9561. case StatusCode::LoopDetected_508: return "Loop Detected";
  9562. case StatusCode::NotExtended_510: return "Not Extended";
  9563. case StatusCode::NetworkAuthenticationRequired_511:
  9564. return "Network Authentication Required";
  9565. default:
  9566. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9567. }
  9568. }
  9569. inline std::string to_string(const Error error) {
  9570. switch (error) {
  9571. case Error::Success: return "Success (no error)";
  9572. case Error::Unknown: return "Unknown";
  9573. case Error::Connection: return "Could not establish connection";
  9574. case Error::BindIPAddress: return "Failed to bind IP address";
  9575. case Error::Read: return "Failed to read connection";
  9576. case Error::Write: return "Failed to write connection";
  9577. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9578. case Error::Canceled: return "Connection handling canceled";
  9579. case Error::SSLConnection: return "SSL connection failed";
  9580. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9581. case Error::SSLServerVerification: return "SSL server verification failed";
  9582. case Error::SSLServerHostnameVerification:
  9583. return "SSL server hostname verification failed";
  9584. case Error::UnsupportedMultipartBoundaryChars:
  9585. return "Unsupported HTTP multipart boundary characters";
  9586. case Error::Compression: return "Compression failed";
  9587. case Error::ConnectionTimeout: return "Connection timed out";
  9588. case Error::ProxyConnection: return "Proxy connection failed";
  9589. case Error::ConnectionClosed: return "Connection closed by server";
  9590. case Error::Timeout: return "Read timeout";
  9591. case Error::ResourceExhaustion: return "Resource exhaustion";
  9592. case Error::TooManyFormDataFiles: return "Too many form data files";
  9593. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9594. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9595. case Error::ExceedMaxSocketDescriptorCount:
  9596. return "Exceeded maximum socket descriptor count";
  9597. case Error::InvalidRequestLine: return "Invalid request line";
  9598. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9599. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9600. case Error::InvalidHeaders: return "Invalid headers";
  9601. case Error::MultipartParsing: return "Multipart parsing failed";
  9602. case Error::OpenFile: return "Failed to open file";
  9603. case Error::Listen: return "Failed to listen on socket";
  9604. case Error::GetSockName: return "Failed to get socket name";
  9605. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9606. case Error::HTTPParsing: return "HTTP parsing failed";
  9607. case Error::InvalidRangeHeader: return "Invalid Range header";
  9608. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9609. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9610. case Error::UserCallbackException: return "User callback threw an exception";
  9611. default: break;
  9612. }
  9613. return "Invalid";
  9614. }
  9615. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9616. os << to_string(obj);
  9617. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9618. return os;
  9619. }
  9620. inline std::string hosted_at(const std::string &hostname) {
  9621. std::vector<std::string> addrs;
  9622. hosted_at(hostname, addrs);
  9623. if (addrs.empty()) { return std::string(); }
  9624. return addrs[0];
  9625. }
  9626. inline void hosted_at(const std::string &hostname,
  9627. std::vector<std::string> &addrs) {
  9628. struct addrinfo hints;
  9629. struct addrinfo *result;
  9630. memset(&hints, 0, sizeof(struct addrinfo));
  9631. hints.ai_family = AF_UNSPEC;
  9632. hints.ai_socktype = SOCK_STREAM;
  9633. hints.ai_protocol = 0;
  9634. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9635. &result, 0)) {
  9636. #if defined __linux__ && !defined __ANDROID__
  9637. res_init();
  9638. #endif
  9639. return;
  9640. }
  9641. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9642. for (auto rp = result; rp; rp = rp->ai_next) {
  9643. const auto &addr =
  9644. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9645. std::string ip;
  9646. auto dummy = -1;
  9647. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9648. dummy)) {
  9649. addrs.emplace_back(std::move(ip));
  9650. }
  9651. }
  9652. }
  9653. inline std::string encode_uri_component(const std::string &value) {
  9654. std::ostringstream escaped;
  9655. escaped.fill('0');
  9656. escaped << std::hex;
  9657. for (auto c : value) {
  9658. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9659. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9660. escaped << c;
  9661. } else {
  9662. escaped << std::uppercase;
  9663. escaped << '%' << std::setw(2)
  9664. << static_cast<int>(static_cast<unsigned char>(c));
  9665. escaped << std::nouppercase;
  9666. }
  9667. }
  9668. return escaped.str();
  9669. }
  9670. inline std::string encode_uri(const std::string &value) {
  9671. std::ostringstream escaped;
  9672. escaped.fill('0');
  9673. escaped << std::hex;
  9674. for (auto c : value) {
  9675. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9676. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9677. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9678. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9679. escaped << c;
  9680. } else {
  9681. escaped << std::uppercase;
  9682. escaped << '%' << std::setw(2)
  9683. << static_cast<int>(static_cast<unsigned char>(c));
  9684. escaped << std::nouppercase;
  9685. }
  9686. }
  9687. return escaped.str();
  9688. }
  9689. inline std::string decode_uri_component(const std::string &value) {
  9690. std::string result;
  9691. for (size_t i = 0; i < value.size(); i++) {
  9692. if (value[i] == '%' && i + 2 < value.size()) {
  9693. auto val = 0;
  9694. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9695. result += static_cast<char>(val);
  9696. i += 2;
  9697. } else {
  9698. result += value[i];
  9699. }
  9700. } else {
  9701. result += value[i];
  9702. }
  9703. }
  9704. return result;
  9705. }
  9706. inline std::string decode_uri(const std::string &value) {
  9707. std::string result;
  9708. for (size_t i = 0; i < value.size(); i++) {
  9709. if (value[i] == '%' && i + 2 < value.size()) {
  9710. auto val = 0;
  9711. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9712. auto c = static_cast<char>(val);
  9713. // Keep escapes of the reserved characters that encode_uri leaves
  9714. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9715. // delimiter is not promoted into a real one (as with JS decodeURI).
  9716. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9717. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9718. c == '#') {
  9719. result += value[i];
  9720. result += value[i + 1];
  9721. result += value[i + 2];
  9722. } else {
  9723. result += c;
  9724. }
  9725. i += 2;
  9726. } else {
  9727. result += value[i];
  9728. }
  9729. } else {
  9730. result += value[i];
  9731. }
  9732. }
  9733. return result;
  9734. }
  9735. inline std::string encode_path_component(const std::string &component) {
  9736. std::string result;
  9737. result.reserve(component.size() * 3);
  9738. for (size_t i = 0; i < component.size(); i++) {
  9739. auto c = static_cast<unsigned char>(component[i]);
  9740. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9741. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9742. c == '_' || c == '~') {
  9743. result += static_cast<char>(c);
  9744. }
  9745. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9746. // "," / ";" / "="
  9747. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9748. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9749. c == '=') {
  9750. result += static_cast<char>(c);
  9751. }
  9752. // Colon is allowed in path segments except first segment
  9753. else if (c == ':') {
  9754. result += static_cast<char>(c);
  9755. }
  9756. // @ is allowed in path
  9757. else if (c == '@') {
  9758. result += static_cast<char>(c);
  9759. } else {
  9760. result += '%';
  9761. char hex[3];
  9762. snprintf(hex, sizeof(hex), "%02X", c);
  9763. result.append(hex, 2);
  9764. }
  9765. }
  9766. return result;
  9767. }
  9768. inline std::string decode_path_component(const std::string &component) {
  9769. std::string result;
  9770. result.reserve(component.size());
  9771. for (size_t i = 0; i < component.size(); i++) {
  9772. if (component[i] == '%' && i + 1 < component.size()) {
  9773. if (component[i + 1] == 'u') {
  9774. // Unicode %uXXXX encoding
  9775. auto val = 0;
  9776. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9777. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9778. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9779. char buff[4];
  9780. size_t len = detail::to_utf8(val, buff);
  9781. if (len > 0) { result.append(buff, len); }
  9782. i += 5; // 'u0000'
  9783. } else {
  9784. result += component[i];
  9785. }
  9786. } else {
  9787. // Standard %XX encoding
  9788. auto val = 0;
  9789. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9790. // 2 digits hex codes
  9791. result += static_cast<char>(val);
  9792. i += 2; // 'XX'
  9793. } else {
  9794. result += component[i];
  9795. }
  9796. }
  9797. } else {
  9798. result += component[i];
  9799. }
  9800. }
  9801. return result;
  9802. }
  9803. inline std::string encode_query_component(const std::string &component,
  9804. bool space_as_plus) {
  9805. std::string result;
  9806. result.reserve(component.size() * 3);
  9807. for (size_t i = 0; i < component.size(); i++) {
  9808. auto c = static_cast<unsigned char>(component[i]);
  9809. // Unreserved characters per RFC 3986
  9810. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9811. c == '_' || c == '~') {
  9812. result += static_cast<char>(c);
  9813. }
  9814. // Space handling
  9815. else if (c == ' ') {
  9816. if (space_as_plus) {
  9817. result += '+';
  9818. } else {
  9819. result += "%20";
  9820. }
  9821. }
  9822. // Plus sign handling
  9823. else if (c == '+') {
  9824. if (space_as_plus) {
  9825. result += "%2B";
  9826. } else {
  9827. result += static_cast<char>(c);
  9828. }
  9829. }
  9830. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9831. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9832. c == '*' || c == ',' || c == ';') {
  9833. result += static_cast<char>(c);
  9834. }
  9835. // Colon and @ are allowed in query
  9836. else if (c == ':' || c == '@') {
  9837. result += static_cast<char>(c);
  9838. }
  9839. // Forward slash is allowed in query values
  9840. else if (c == '/') {
  9841. result += static_cast<char>(c);
  9842. }
  9843. // Question mark is allowed in query values (after first ?)
  9844. else if (c == '?') {
  9845. result += static_cast<char>(c);
  9846. } else {
  9847. result += '%';
  9848. char hex[3];
  9849. snprintf(hex, sizeof(hex), "%02X", c);
  9850. result.append(hex, 2);
  9851. }
  9852. }
  9853. return result;
  9854. }
  9855. inline std::string decode_query_component(const std::string &component,
  9856. bool plus_as_space) {
  9857. std::string result;
  9858. result.reserve(component.size());
  9859. for (size_t i = 0; i < component.size(); i++) {
  9860. if (component[i] == '%' && i + 2 < component.size()) {
  9861. auto val = 0;
  9862. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9863. result += static_cast<char>(val);
  9864. i += 2;
  9865. } else {
  9866. result += component[i];
  9867. }
  9868. } else if (component[i] == '+' && plus_as_space) {
  9869. result += ' '; // + becomes space in form-urlencoded
  9870. } else {
  9871. result += component[i];
  9872. }
  9873. }
  9874. return result;
  9875. }
  9876. inline std::string sanitize_filename(const std::string &filename) {
  9877. // Extract basename: find the last path separator (/ or \)
  9878. auto pos = filename.find_last_of("/\\");
  9879. auto result =
  9880. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9881. // Strip null bytes
  9882. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9883. // Trim whitespace
  9884. {
  9885. auto start = result.find_first_not_of(" \t");
  9886. auto end = result.find_last_not_of(" \t");
  9887. result = (start == std::string::npos)
  9888. ? ""
  9889. : result.substr(start, end - start + 1);
  9890. }
  9891. // Reject . and ..
  9892. if (result == "." || result == "..") { return ""; }
  9893. return result;
  9894. }
  9895. inline std::string append_query_params(const std::string &path,
  9896. const Params &params) {
  9897. std::string path_with_query = path;
  9898. path_with_query += path.find('?') == std::string::npos ? '?' : '&';
  9899. path_with_query += detail::params_to_query_str(params);
  9900. return path_with_query;
  9901. }
  9902. // Header utilities
  9903. inline std::pair<std::string, std::string>
  9904. make_range_header(const Ranges &ranges) {
  9905. std::string field = "bytes=";
  9906. auto i = 0;
  9907. for (const auto &r : ranges) {
  9908. if (i != 0) { field += ", "; }
  9909. if (r.first != -1) { field += std::to_string(r.first); }
  9910. field += '-';
  9911. if (r.second != -1) { field += std::to_string(r.second); }
  9912. i++;
  9913. }
  9914. return std::make_pair("Range", std::move(field));
  9915. }
  9916. inline std::pair<std::string, std::string>
  9917. make_basic_authentication_header(const std::string &username,
  9918. const std::string &password, bool is_proxy) {
  9919. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9920. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9921. return std::make_pair(key, std::move(field));
  9922. }
  9923. inline std::pair<std::string, std::string>
  9924. make_bearer_token_authentication_header(const std::string &token,
  9925. bool is_proxy = false) {
  9926. auto field = "Bearer " + token;
  9927. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9928. return std::make_pair(key, std::move(field));
  9929. }
  9930. // Request implementation
  9931. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9932. size_t id) const {
  9933. return detail::get_header_value_u64(headers, key, def, id);
  9934. }
  9935. inline bool Request::has_header(const std::string &key) const {
  9936. return detail::has_header(headers, key);
  9937. }
  9938. inline std::string Request::get_header_value(const std::string &key,
  9939. const char *def, size_t id) const {
  9940. return detail::get_header_value(headers, key, def, id);
  9941. }
  9942. inline size_t Request::get_header_value_count(const std::string &key) const {
  9943. return detail::get_header_value_count(headers, key);
  9944. }
  9945. inline void Request::set_header(const std::string &key,
  9946. const std::string &val) {
  9947. detail::set_header(headers, key, val);
  9948. }
  9949. inline bool Request::has_trailer(const std::string &key) const {
  9950. return trailers.find(key) != trailers.end();
  9951. }
  9952. inline std::string Request::get_trailer_value(const std::string &key,
  9953. size_t id) const {
  9954. return detail::get_multimap_value(trailers, key, id);
  9955. }
  9956. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9957. return trailers.count(key);
  9958. }
  9959. inline bool Request::has_param(const std::string &key) const {
  9960. return params.find(key) != params.end();
  9961. }
  9962. inline std::string Request::get_param_value(const std::string &key,
  9963. size_t id) const {
  9964. return detail::get_multimap_value(params, key, id);
  9965. }
  9966. inline std::vector<std::string>
  9967. Request::get_param_values(const std::string &key) const {
  9968. auto rng = params.equal_range(key);
  9969. std::vector<std::string> values;
  9970. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9971. for (auto it = rng.first; it != rng.second; ++it) {
  9972. values.push_back(it->second);
  9973. }
  9974. return values;
  9975. }
  9976. inline size_t Request::get_param_value_count(const std::string &key) const {
  9977. return params.count(key);
  9978. }
  9979. inline bool Request::is_multipart_form_data() const {
  9980. const auto &content_type = get_header_value("Content-Type");
  9981. return detail::extract_media_type(content_type) == "multipart/form-data";
  9982. }
  9983. // Multipart FormData implementation
  9984. inline std::string MultipartFormData::get_field(const std::string &key,
  9985. size_t id) const {
  9986. auto rng = fields.equal_range(key);
  9987. auto it = detail::bounded_next(rng.first, id, rng.second);
  9988. if (it != rng.second) { return it->second.content; }
  9989. return std::string();
  9990. }
  9991. inline std::vector<std::string>
  9992. MultipartFormData::get_fields(const std::string &key) const {
  9993. std::vector<std::string> values;
  9994. auto rng = fields.equal_range(key);
  9995. for (auto it = rng.first; it != rng.second; it++) {
  9996. values.push_back(it->second.content);
  9997. }
  9998. return values;
  9999. }
  10000. inline bool MultipartFormData::has_field(const std::string &key) const {
  10001. return fields.find(key) != fields.end();
  10002. }
  10003. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10004. return fields.count(key);
  10005. }
  10006. inline FormData MultipartFormData::get_file(const std::string &key,
  10007. size_t id) const {
  10008. return detail::get_multimap_value(files, key, id);
  10009. }
  10010. inline std::vector<FormData>
  10011. MultipartFormData::get_files(const std::string &key) const {
  10012. std::vector<FormData> values;
  10013. auto rng = files.equal_range(key);
  10014. for (auto it = rng.first; it != rng.second; it++) {
  10015. values.push_back(it->second);
  10016. }
  10017. return values;
  10018. }
  10019. inline bool MultipartFormData::has_file(const std::string &key) const {
  10020. return files.find(key) != files.end();
  10021. }
  10022. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10023. return files.count(key);
  10024. }
  10025. // Multipart FormData writer implementation
  10026. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10027. return detail::is_multipart_boundary_chars_valid(boundary);
  10028. }
  10029. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10030. : boundary_(detail::make_multipart_data_boundary()) {}
  10031. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10032. : boundary_(std::move(boundary)) {}
  10033. inline const std::string &MultipartFormDataWriter::boundary() const {
  10034. return boundary_;
  10035. }
  10036. inline std::string MultipartFormDataWriter::content_type() const {
  10037. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10038. }
  10039. inline std::string
  10040. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10041. return detail::serialize_multipart_formdata(items, boundary_);
  10042. }
  10043. inline size_t MultipartFormDataWriter::content_length(
  10044. const UploadFormDataItems &items) const {
  10045. return detail::get_multipart_content_length(items, boundary_);
  10046. }
  10047. inline std::string
  10048. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10049. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10050. }
  10051. inline std::string MultipartFormDataWriter::item_end() {
  10052. return detail::serialize_multipart_formdata_item_end();
  10053. }
  10054. inline std::string MultipartFormDataWriter::finish() const {
  10055. return detail::serialize_multipart_formdata_finish(boundary_);
  10056. }
  10057. // Response implementation
  10058. namespace detail {
  10059. // A response has one content source: `body`, a content provider, or a file.
  10060. // Each content setter calls this so that the one called last wins.
  10061. inline void clear_content_provider(Response &res) {
  10062. auto releaser = std::move(res.content_provider_resource_releaser_);
  10063. auto success = res.content_provider_success_;
  10064. res.content_length_ = 0;
  10065. res.content_provider_ = nullptr;
  10066. res.content_provider_resource_releaser_ = nullptr;
  10067. res.is_chunked_content_provider_ = false;
  10068. res.is_file_content_provider_ = false;
  10069. res.content_provider_success_ = false;
  10070. res.content_coding_ = EncodingType::None;
  10071. res.file_content_path_.clear();
  10072. res.file_content_content_type_.clear();
  10073. if (releaser) { releaser(success); }
  10074. }
  10075. inline void clear_content(Response &res) {
  10076. res.body.clear();
  10077. clear_content_provider(res);
  10078. }
  10079. // `body` is public, so it can be assigned directly after a provider or a file
  10080. // was set. It came last, so it wins.
  10081. inline void prefer_assigned_body(Response &res) {
  10082. if (!res.body.empty() &&
  10083. (res.content_provider_ || !res.file_content_path_.empty())) {
  10084. clear_content_provider(res);
  10085. }
  10086. }
  10087. } // namespace detail
  10088. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10089. size_t id) const {
  10090. return detail::get_header_value_u64(headers, key, def, id);
  10091. }
  10092. inline bool Response::has_header(const std::string &key) const {
  10093. return headers.find(key) != headers.end();
  10094. }
  10095. inline std::string Response::get_header_value(const std::string &key,
  10096. const char *def,
  10097. size_t id) const {
  10098. return detail::get_header_value(headers, key, def, id);
  10099. }
  10100. inline size_t Response::get_header_value_count(const std::string &key) const {
  10101. return detail::get_header_value_count(headers, key);
  10102. }
  10103. inline void Response::set_header(const std::string &key,
  10104. const std::string &val) {
  10105. detail::set_header(headers, key, val);
  10106. }
  10107. inline bool Response::has_trailer(const std::string &key) const {
  10108. return trailers.find(key) != trailers.end();
  10109. }
  10110. inline std::string Response::get_trailer_value(const std::string &key,
  10111. size_t id) const {
  10112. return detail::get_multimap_value(trailers, key, id);
  10113. }
  10114. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10115. return trailers.count(key);
  10116. }
  10117. inline void Response::set_redirect(const std::string &url, int stat) {
  10118. if (detail::fields::is_field_value(url)) {
  10119. set_header("Location", url);
  10120. if (300 <= stat && stat < 400) {
  10121. this->status = stat;
  10122. } else {
  10123. this->status = StatusCode::Found_302;
  10124. }
  10125. }
  10126. }
  10127. inline void Response::set_content(const char *s, size_t n,
  10128. const std::string &content_type) {
  10129. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10130. detail::clear_content_provider(*this);
  10131. auto rng = headers.equal_range("Content-Type");
  10132. headers.erase(rng.first, rng.second);
  10133. set_header("Content-Type", content_type);
  10134. }
  10135. inline void Response::set_content(const std::string &s,
  10136. const std::string &content_type) {
  10137. set_content(s.data(), s.size(), content_type);
  10138. }
  10139. inline void Response::set_content(std::string &&s,
  10140. const std::string &content_type) {
  10141. body = std::move(s);
  10142. detail::clear_content_provider(*this);
  10143. auto rng = headers.equal_range("Content-Type");
  10144. headers.erase(rng.first, rng.second);
  10145. set_header("Content-Type", content_type);
  10146. }
  10147. inline void Response::set_content_provider(
  10148. size_t in_length, const std::string &content_type, ContentProvider provider,
  10149. ContentProviderResourceReleaser resource_releaser) {
  10150. detail::clear_content(*this);
  10151. set_header("Content-Type", content_type);
  10152. content_length_ = in_length;
  10153. if (in_length > 0) { content_provider_ = std::move(provider); }
  10154. content_provider_resource_releaser_ = std::move(resource_releaser);
  10155. }
  10156. inline void Response::set_content_provider(
  10157. const std::string &content_type, ContentProviderWithoutLength provider,
  10158. ContentProviderResourceReleaser resource_releaser) {
  10159. detail::clear_content(*this);
  10160. set_header("Content-Type", content_type);
  10161. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10162. content_provider_resource_releaser_ = std::move(resource_releaser);
  10163. }
  10164. inline void Response::set_chunked_content_provider(
  10165. const std::string &content_type, ContentProviderWithoutLength provider,
  10166. ContentProviderResourceReleaser resource_releaser) {
  10167. set_content_provider(content_type, std::move(provider),
  10168. std::move(resource_releaser));
  10169. is_chunked_content_provider_ = true;
  10170. }
  10171. inline void Response::set_file_content(const std::string &path,
  10172. const std::string &content_type) {
  10173. detail::clear_content(*this);
  10174. file_content_path_ = path;
  10175. file_content_content_type_ = content_type;
  10176. }
  10177. inline void Response::set_file_content(const std::string &path) {
  10178. set_file_content(path, std::string());
  10179. }
  10180. // Result implementation
  10181. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10182. size_t def,
  10183. size_t id) const {
  10184. return detail::get_header_value_u64(request_headers_, key, def, id);
  10185. }
  10186. inline bool Result::has_request_header(const std::string &key) const {
  10187. return request_headers_.find(key) != request_headers_.end();
  10188. }
  10189. inline std::string Result::get_request_header_value(const std::string &key,
  10190. const char *def,
  10191. size_t id) const {
  10192. return detail::get_header_value(request_headers_, key, def, id);
  10193. }
  10194. inline size_t
  10195. Result::get_request_header_value_count(const std::string &key) const {
  10196. return request_headers_.count(key);
  10197. }
  10198. // Stream implementation
  10199. inline ssize_t Stream::write(const char *ptr) {
  10200. return write(ptr, strlen(ptr));
  10201. }
  10202. inline ssize_t Stream::write(const std::string &s) {
  10203. return write(s.data(), s.size());
  10204. }
  10205. // BodyReader implementation
  10206. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10207. if (!stream) {
  10208. last_error = Error::Connection;
  10209. return -1;
  10210. }
  10211. if (eof) { return 0; }
  10212. if (!chunked) {
  10213. // Content-Length based reading
  10214. if (has_content_length && bytes_read >= content_length) {
  10215. eof = true;
  10216. return 0;
  10217. }
  10218. auto to_read = len;
  10219. if (has_content_length) {
  10220. auto remaining = content_length - bytes_read;
  10221. to_read = (std::min)(len, remaining);
  10222. }
  10223. auto n = stream->read(buf, to_read);
  10224. if (n < 0) {
  10225. last_error = stream->get_error();
  10226. if (last_error == Error::Success) { last_error = Error::Read; }
  10227. eof = true;
  10228. return n;
  10229. }
  10230. if (n == 0) {
  10231. // Unexpected EOF before content_length
  10232. last_error = stream->get_error();
  10233. if (last_error == Error::Success) { last_error = Error::Read; }
  10234. eof = true;
  10235. return 0;
  10236. }
  10237. bytes_read += static_cast<size_t>(n);
  10238. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10239. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10240. last_error = Error::ExceedMaxPayloadSize;
  10241. eof = true;
  10242. return -1;
  10243. }
  10244. return n;
  10245. }
  10246. // Chunked transfer encoding: delegate to shared decoder instance.
  10247. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10248. size_t chunk_offset = 0;
  10249. size_t chunk_total = 0;
  10250. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10251. if (n < 0) {
  10252. last_error = stream->get_error();
  10253. if (last_error == Error::Success) { last_error = Error::Read; }
  10254. eof = true;
  10255. return n;
  10256. }
  10257. if (n == 0) {
  10258. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10259. eof = true;
  10260. return 0;
  10261. }
  10262. bytes_read += static_cast<size_t>(n);
  10263. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10264. last_error = Error::ExceedMaxPayloadSize;
  10265. eof = true;
  10266. return -1;
  10267. }
  10268. return n;
  10269. }
  10270. // ThreadPool implementation
  10271. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10272. time_t idle_timeout_sec)
  10273. : base_thread_count_(n), max_queued_requests_(mqr),
  10274. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10275. shutdown_(false) {
  10276. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10277. if (max_n != 0 && max_n < n) {
  10278. std::string msg = "max_threads must be >= base_threads";
  10279. throw std::invalid_argument(msg);
  10280. }
  10281. #endif
  10282. max_thread_count_ = max_n == 0 ? n : max_n;
  10283. threads_.reserve(base_thread_count_);
  10284. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10285. try {
  10286. #endif
  10287. for (size_t i = 0; i < base_thread_count_; i++) {
  10288. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10289. }
  10290. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10291. } catch (...) {
  10292. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10293. // signal the workers we already spawned to exit and join them so the
  10294. // vector destructor does not see joinable threads (which would call
  10295. // std::terminate). Then rethrow so the caller learns of the failure.
  10296. {
  10297. std::unique_lock<std::mutex> lock(mutex_);
  10298. shutdown_ = true;
  10299. }
  10300. cond_.notify_all();
  10301. for (auto &t : threads_) {
  10302. if (t.joinable()) { t.join(); }
  10303. }
  10304. throw;
  10305. }
  10306. #endif
  10307. }
  10308. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10309. {
  10310. std::unique_lock<std::mutex> lock(mutex_);
  10311. if (shutdown_) { return false; }
  10312. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10313. return false;
  10314. }
  10315. jobs_.push_back(std::move(fn));
  10316. // Spawn a dynamic thread if no idle threads and under max
  10317. if (idle_thread_count_ == 0 &&
  10318. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10319. cleanup_finished_threads();
  10320. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10321. }
  10322. }
  10323. cond_.notify_one();
  10324. return true;
  10325. }
  10326. inline void ThreadPool::shutdown() {
  10327. {
  10328. std::unique_lock<std::mutex> lock(mutex_);
  10329. shutdown_ = true;
  10330. }
  10331. cond_.notify_all();
  10332. for (auto &t : threads_) {
  10333. if (t.joinable()) { t.join(); }
  10334. }
  10335. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10336. // with worker threads that call move_to_finished() concurrently.
  10337. std::list<std::thread> remaining_dynamic;
  10338. {
  10339. std::unique_lock<std::mutex> lock(mutex_);
  10340. remaining_dynamic = std::move(dynamic_threads_);
  10341. }
  10342. for (auto &t : remaining_dynamic) {
  10343. if (t.joinable()) { t.join(); }
  10344. }
  10345. std::unique_lock<std::mutex> lock(mutex_);
  10346. cleanup_finished_threads();
  10347. }
  10348. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10349. // Must be called with mutex_ held
  10350. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10351. if (it->get_id() == id) {
  10352. finished_threads_.push_back(std::move(*it));
  10353. dynamic_threads_.erase(it);
  10354. return;
  10355. }
  10356. }
  10357. }
  10358. inline void ThreadPool::cleanup_finished_threads() {
  10359. // Must be called with mutex_ held
  10360. for (auto &t : finished_threads_) {
  10361. if (t.joinable()) { t.join(); }
  10362. }
  10363. finished_threads_.clear();
  10364. }
  10365. inline void ThreadPool::worker(bool is_dynamic) {
  10366. for (;;) {
  10367. std::function<void()> fn;
  10368. {
  10369. std::unique_lock<std::mutex> lock(mutex_);
  10370. idle_thread_count_++;
  10371. if (is_dynamic) {
  10372. auto has_work =
  10373. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10374. [&] { return !jobs_.empty() || shutdown_; });
  10375. if (!has_work) {
  10376. // Timed out with no work - exit this dynamic thread
  10377. idle_thread_count_--;
  10378. move_to_finished(std::this_thread::get_id());
  10379. break;
  10380. }
  10381. } else {
  10382. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10383. }
  10384. idle_thread_count_--;
  10385. if (shutdown_ && jobs_.empty()) { break; }
  10386. fn = std::move(jobs_.front());
  10387. jobs_.pop_front();
  10388. }
  10389. assert(true == static_cast<bool>(fn));
  10390. fn();
  10391. }
  10392. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10393. !defined(LIBRESSL_VERSION_NUMBER)
  10394. OPENSSL_thread_stop();
  10395. #endif
  10396. }
  10397. /*
  10398. * Group 1 (continued): detail namespace - Stream implementations
  10399. */
  10400. namespace detail {
  10401. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10402. time_t timeout_sec, time_t timeout_usec,
  10403. time_t &actual_timeout_sec,
  10404. time_t &actual_timeout_usec) {
  10405. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10406. auto actual_timeout_msec =
  10407. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10408. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10409. actual_timeout_sec = actual_timeout_msec / 1000;
  10410. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10411. }
  10412. // Socket stream implementation
  10413. inline SocketStream::SocketStream(
  10414. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10415. time_t write_timeout_sec, time_t write_timeout_usec,
  10416. time_t max_timeout_msec,
  10417. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10418. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10419. read_timeout_usec_(read_timeout_usec),
  10420. write_timeout_sec_(write_timeout_sec),
  10421. write_timeout_usec_(write_timeout_usec),
  10422. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10423. read_buff_(read_buff_size_, 0) {}
  10424. inline SocketStream::~SocketStream() = default;
  10425. inline bool SocketStream::is_readable() const {
  10426. return read_buff_off_ < read_buff_content_size_;
  10427. }
  10428. inline bool SocketStream::wait_readable() const {
  10429. if (max_timeout_msec_ <= 0) {
  10430. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10431. }
  10432. time_t read_timeout_sec;
  10433. time_t read_timeout_usec;
  10434. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10435. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10436. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10437. }
  10438. inline bool SocketStream::wait_writable() const {
  10439. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10440. }
  10441. inline bool SocketStream::ensure_readable() {
  10442. if (readable_hint_) {
  10443. readable_hint_ = false;
  10444. return true;
  10445. }
  10446. return wait_readable();
  10447. }
  10448. inline const char *SocketStream::buffered_data(size_t &size) const {
  10449. size = read_buff_content_size_ - read_buff_off_;
  10450. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10451. }
  10452. inline void SocketStream::consume_buffered(size_t size) {
  10453. assert(size <= read_buff_content_size_ - read_buff_off_);
  10454. read_buff_off_ += size;
  10455. }
  10456. inline bool SocketStream::is_peer_alive() const {
  10457. return detail::is_socket_alive(sock_);
  10458. }
  10459. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10460. #ifdef _WIN32
  10461. size =
  10462. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10463. #else
  10464. size = (std::min)(size,
  10465. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10466. #endif
  10467. if (read_buff_off_ < read_buff_content_size_) {
  10468. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10469. if (size <= remaining_size) {
  10470. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10471. read_buff_off_ += size;
  10472. return static_cast<ssize_t>(size);
  10473. } else {
  10474. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10475. read_buff_off_ += remaining_size;
  10476. return static_cast<ssize_t>(remaining_size);
  10477. }
  10478. }
  10479. if (!ensure_readable()) {
  10480. error_ = Error::Timeout;
  10481. return -1;
  10482. }
  10483. read_buff_off_ = 0;
  10484. read_buff_content_size_ = 0;
  10485. if (size < read_buff_size_) {
  10486. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10487. CPPHTTPLIB_RECV_FLAGS);
  10488. if (n <= 0) {
  10489. if (n == 0) {
  10490. error_ = Error::ConnectionClosed;
  10491. } else {
  10492. error_ = Error::Read;
  10493. }
  10494. return n;
  10495. } else if (n <= static_cast<ssize_t>(size)) {
  10496. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10497. return n;
  10498. } else {
  10499. memcpy(ptr, read_buff_.data(), size);
  10500. read_buff_off_ = size;
  10501. read_buff_content_size_ = static_cast<size_t>(n);
  10502. return static_cast<ssize_t>(size);
  10503. }
  10504. } else {
  10505. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10506. if (n <= 0) {
  10507. if (n == 0) {
  10508. error_ = Error::ConnectionClosed;
  10509. } else {
  10510. error_ = Error::Read;
  10511. }
  10512. }
  10513. return n;
  10514. }
  10515. }
  10516. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10517. if (!wait_writable()) { return -1; }
  10518. #if defined(_WIN32) && !defined(_WIN64)
  10519. size =
  10520. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10521. #endif
  10522. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10523. }
  10524. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10525. int &port) const {
  10526. return detail::get_remote_ip_and_port(sock_, ip, port);
  10527. }
  10528. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10529. int &port) const {
  10530. return detail::get_local_ip_and_port(sock_, ip, port);
  10531. }
  10532. inline socket_t SocketStream::socket() const { return sock_; }
  10533. inline time_t SocketStream::duration() const {
  10534. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10535. std::chrono::steady_clock::now() - start_time_)
  10536. .count();
  10537. }
  10538. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10539. read_timeout_sec_ = sec;
  10540. read_timeout_usec_ = usec;
  10541. }
  10542. // Buffer stream implementation
  10543. inline bool BufferStream::is_readable() const { return true; }
  10544. inline bool BufferStream::wait_readable() const { return true; }
  10545. inline bool BufferStream::wait_writable() const { return true; }
  10546. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10547. #if defined(_MSC_VER) && _MSC_VER < 1910
  10548. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10549. #else
  10550. auto len_read = buffer.copy(ptr, size, position);
  10551. #endif
  10552. position += static_cast<size_t>(len_read);
  10553. return static_cast<ssize_t>(len_read);
  10554. }
  10555. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10556. buffer.append(ptr, size);
  10557. return static_cast<ssize_t>(size);
  10558. }
  10559. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10560. int & /*port*/) const {}
  10561. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10562. int & /*port*/) const {}
  10563. inline socket_t BufferStream::socket() const { return 0; }
  10564. inline time_t BufferStream::duration() const { return 0; }
  10565. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10566. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10567. : MatcherBase(pattern) {
  10568. constexpr const char marker[] = "/:";
  10569. // One past the last ending position of a path param substring
  10570. std::size_t last_param_end = 0;
  10571. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10572. // Needed to ensure that parameter names are unique during matcher
  10573. // construction
  10574. // If exceptions are disabled, only last duplicate path
  10575. // parameter will be set
  10576. std::unordered_set<std::string> param_name_set;
  10577. #endif
  10578. while (true) {
  10579. const auto marker_pos = pattern.find(
  10580. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10581. if (marker_pos == std::string::npos) { break; }
  10582. static_fragments_.push_back(
  10583. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10584. const auto param_name_start = marker_pos + str_len(marker);
  10585. auto sep_pos = pattern.find(separator, param_name_start);
  10586. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10587. auto param_name =
  10588. pattern.substr(param_name_start, sep_pos - param_name_start);
  10589. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10590. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10591. std::string msg = "Encountered path parameter '" + param_name +
  10592. "' multiple times in route pattern '" + pattern + "'.";
  10593. throw std::invalid_argument(msg);
  10594. }
  10595. #endif
  10596. param_names_.push_back(std::move(param_name));
  10597. last_param_end = sep_pos + 1;
  10598. }
  10599. if (last_param_end < pattern.length()) {
  10600. static_fragments_.push_back(pattern.substr(last_param_end));
  10601. }
  10602. }
  10603. inline bool PathParamsMatcher::match(Request &request) const {
  10604. request.matches = std::smatch();
  10605. request.path_params.clear();
  10606. // A pattern without parameters is just a literal path to compare against
  10607. if (param_names_.empty()) { return request.path == pattern(); }
  10608. request.path_params.reserve(param_names_.size());
  10609. // One past the position at which the path matched the pattern last time
  10610. std::size_t starting_pos = 0;
  10611. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10612. const auto &fragment = static_fragments_[i];
  10613. if (starting_pos + fragment.length() > request.path.length()) {
  10614. return false;
  10615. }
  10616. // Avoid unnecessary allocation by using strncmp instead of substr +
  10617. // comparison
  10618. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10619. fragment.length()) != 0) {
  10620. return false;
  10621. }
  10622. starting_pos += fragment.length();
  10623. // Should only happen when we have a static fragment after a param
  10624. // Example: '/users/:id/subscriptions'
  10625. // The 'subscriptions' fragment here does not have a corresponding param
  10626. if (i >= param_names_.size()) { continue; }
  10627. auto sep_pos = request.path.find(separator, starting_pos);
  10628. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10629. const auto &param_name = param_names_[i];
  10630. request.path_params.emplace(
  10631. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10632. // Mark everything up to '/' as matched
  10633. starting_pos = sep_pos + 1;
  10634. }
  10635. // Returns false if the path is longer than the pattern
  10636. return starting_pos >= request.path.length();
  10637. }
  10638. inline bool RegexMatcher::match(Request &request) const {
  10639. request.path_params.clear();
  10640. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10641. // a non-match rather than risking a stack overflow in std::regex_match.
  10642. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10643. return false;
  10644. }
  10645. return std::regex_match(request.path, request.matches, regex_);
  10646. }
  10647. // Enclose IPv6 address in brackets if needed
  10648. inline std::string prepare_host_string(const std::string &host) {
  10649. // Enclose IPv6 address in brackets (but not if already enclosed)
  10650. if (host.find(':') == std::string::npos ||
  10651. (!host.empty() && host[0] == '[')) {
  10652. // IPv4, hostname, or already bracketed IPv6
  10653. return host;
  10654. } else {
  10655. // IPv6 address without brackets
  10656. return "[" + host + "]";
  10657. }
  10658. }
  10659. inline std::string make_host_and_port_string(const std::string &host, int port,
  10660. bool is_ssl) {
  10661. auto result = prepare_host_string(host);
  10662. // Append port if not default
  10663. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10664. ; // do nothing
  10665. } else {
  10666. result += ":" + std::to_string(port);
  10667. }
  10668. return result;
  10669. }
  10670. // Create "host:port" string always including port number (for CONNECT method)
  10671. inline std::string
  10672. make_host_and_port_string_always_port(const std::string &host, int port) {
  10673. return prepare_host_string(host) + ":" + std::to_string(port);
  10674. }
  10675. // Value for the Host header a client sends when the caller supplied none.
  10676. // Only the value: callers decide where in their header list it goes.
  10677. inline std::string make_default_host_header_value(const std::string &host,
  10678. int port, bool is_ssl,
  10679. int address_family) {
  10680. if (address_family == AF_UNIX) { return "localhost"; }
  10681. return make_host_and_port_string(host, port, is_ssl);
  10682. }
  10683. inline void add_default_user_agent_header(Request &req) {
  10684. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10685. if (!req.has_header("User-Agent")) {
  10686. req.set_header("User-Agent",
  10687. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10688. }
  10689. #else
  10690. (void)req;
  10691. #endif
  10692. }
  10693. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10694. NormalizedTarget normalize_target(const std::string &host);
  10695. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10696. bool host_matches_no_proxy(const NormalizedTarget &target,
  10697. const std::vector<NoProxyEntry> &entries);
  10698. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10699. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10700. if (prefix_bits == 0) { return true; }
  10701. int full_bytes = prefix_bits / 8;
  10702. int rem_bits = prefix_bits % 8;
  10703. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10704. static_cast<size_t>(full_bytes)) != 0) {
  10705. return false;
  10706. }
  10707. if (rem_bits == 0) { return true; }
  10708. auto i = static_cast<size_t>(full_bytes);
  10709. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10710. return (ip[i] & mask) == (net[i] & mask);
  10711. }
  10712. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10713. if (token.empty()) { return false; }
  10714. if (token == "*") {
  10715. out.kind = NoProxyKind::Wildcard;
  10716. return true;
  10717. }
  10718. auto slash = token.find('/');
  10719. std::string addr_part =
  10720. (slash == std::string::npos) ? token : token.substr(0, slash);
  10721. std::string prefix_part =
  10722. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10723. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10724. // don't silently treat it as a /32 (or /128).
  10725. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10726. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10727. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10728. // when brackets are present.
  10729. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10730. addr_part.back() == ']';
  10731. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10732. if (!bracketed) {
  10733. struct in_addr v4;
  10734. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10735. int prefix = 32;
  10736. if (!prefix_part.empty() &&
  10737. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  10738. prefix)) {
  10739. return false;
  10740. }
  10741. out.kind = NoProxyKind::IPv4Cidr;
  10742. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10743. out.prefix_bits = prefix;
  10744. return true;
  10745. }
  10746. }
  10747. struct in6_addr v6;
  10748. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10749. int prefix = 128;
  10750. if (!prefix_part.empty() &&
  10751. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  10752. prefix)) {
  10753. return false;
  10754. }
  10755. out.kind = NoProxyKind::IPv6Cidr;
  10756. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10757. out.prefix_bits = prefix;
  10758. return true;
  10759. }
  10760. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10761. // the entry is malformed — don't fall through to the hostname branch.
  10762. if (bracketed) { return false; }
  10763. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10764. if (slash != std::string::npos) { return false; }
  10765. // Port-specific entries (host:port) are not supported.
  10766. if (token.find(':') != std::string::npos) { return false; }
  10767. std::string hostname = case_ignore::to_lower(token);
  10768. while (!hostname.empty() && hostname.front() == '.') {
  10769. hostname.erase(hostname.begin());
  10770. }
  10771. while (!hostname.empty() && hostname.back() == '.') {
  10772. hostname.pop_back();
  10773. }
  10774. if (hostname.empty()) { return false; }
  10775. out.kind = NoProxyKind::HostnameSuffix;
  10776. out.hostname_pattern = std::move(hostname);
  10777. return true;
  10778. }
  10779. inline NormalizedTarget normalize_target(const std::string &host) {
  10780. NormalizedTarget t;
  10781. std::string h = host;
  10782. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10783. h = h.substr(1, h.size() - 2);
  10784. }
  10785. // Strip a single trailing dot so "example.com." canonicalizes to
  10786. // "example.com".
  10787. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10788. t.hostname = case_ignore::to_lower(h);
  10789. if (!t.hostname.empty()) {
  10790. struct in_addr v4;
  10791. struct in6_addr v6;
  10792. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10793. t.is_ipv4 = true;
  10794. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10795. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10796. t.is_ipv6 = true;
  10797. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10798. }
  10799. }
  10800. return t;
  10801. }
  10802. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10803. const std::vector<NoProxyEntry> &entries) {
  10804. if (target.hostname.empty()) { return false; }
  10805. for (const auto &e : entries) {
  10806. switch (e.kind) {
  10807. case NoProxyKind::Wildcard: return true;
  10808. case NoProxyKind::IPv4Cidr:
  10809. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10810. return true;
  10811. }
  10812. break;
  10813. case NoProxyKind::IPv6Cidr:
  10814. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10815. return true;
  10816. }
  10817. break;
  10818. case NoProxyKind::HostnameSuffix:
  10819. if (target.is_ipv4 || target.is_ipv6) { break; }
  10820. if (target.hostname == e.hostname_pattern) { return true; }
  10821. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10822. // an entry of "example.com".
  10823. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10824. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10825. if (target.hostname[offset - 1] == '.' &&
  10826. target.hostname.compare(offset, e.hostname_pattern.size(),
  10827. e.hostname_pattern) == 0) {
  10828. return true;
  10829. }
  10830. }
  10831. break;
  10832. }
  10833. }
  10834. return false;
  10835. }
  10836. template <typename T>
  10837. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10838. T header_writer, Error &error) {
  10839. for (const auto &h : headers) {
  10840. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10841. error = Error::InvalidHeaders;
  10842. return false;
  10843. }
  10844. }
  10845. if (header_writer(strm, headers) <= 0) {
  10846. error = Error::Write;
  10847. return false;
  10848. }
  10849. return true;
  10850. }
  10851. } // namespace detail
  10852. /*
  10853. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10854. */
  10855. #ifdef CPPHTTPLIB_SSL_ENABLED
  10856. namespace detail {
  10857. // SSL socket stream implementation
  10858. inline SSLSocketStream::SSLSocketStream(
  10859. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10860. time_t read_timeout_usec, time_t write_timeout_sec,
  10861. time_t write_timeout_usec, time_t max_timeout_msec,
  10862. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10863. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10864. read_timeout_usec_(read_timeout_usec),
  10865. write_timeout_sec_(write_timeout_sec),
  10866. write_timeout_usec_(write_timeout_usec),
  10867. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10868. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10869. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10870. // Note: create_session() also clears this, but SSLClient currently
  10871. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10872. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10873. // SSL session was created.
  10874. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10875. #endif
  10876. }
  10877. inline SSLSocketStream::~SSLSocketStream() = default;
  10878. inline bool SSLSocketStream::is_readable() const {
  10879. return tls::pending(session_) > 0;
  10880. }
  10881. inline bool SSLSocketStream::wait_readable() const {
  10882. if (max_timeout_msec_ <= 0) {
  10883. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10884. }
  10885. time_t read_timeout_sec;
  10886. time_t read_timeout_usec;
  10887. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10888. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10889. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10890. }
  10891. inline bool SSLSocketStream::wait_writable() const {
  10892. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10893. !tls::is_peer_closed(session_, sock_);
  10894. }
  10895. inline bool SSLSocketStream::ensure_readable() {
  10896. if (readable_hint_) {
  10897. readable_hint_ = false;
  10898. return true;
  10899. }
  10900. return wait_readable();
  10901. }
  10902. inline bool SSLSocketStream::is_peer_alive() const {
  10903. return !tls::is_peer_closed(session_, sock_);
  10904. }
  10905. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10906. if (tls::pending(session_) > 0) {
  10907. tls::TlsError err;
  10908. auto ret = tls::read(session_, ptr, size, err);
  10909. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10910. error_ = Error::ConnectionClosed;
  10911. }
  10912. return ret;
  10913. } else if (ensure_readable()) {
  10914. tls::TlsError err;
  10915. auto ret = tls::read(session_, ptr, size, err);
  10916. if (ret < 0) {
  10917. auto n = 1000;
  10918. #ifdef _WIN32
  10919. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10920. (err.code == tls::ErrorCode::SyscallError &&
  10921. WSAGetLastError() == WSAETIMEDOUT))) {
  10922. #else
  10923. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10924. #endif
  10925. if (tls::pending(session_) > 0) {
  10926. return tls::read(session_, ptr, size, err);
  10927. } else if (wait_readable()) {
  10928. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10929. ret = tls::read(session_, ptr, size, err);
  10930. if (ret >= 0) { return ret; }
  10931. } else {
  10932. break;
  10933. }
  10934. }
  10935. assert(ret < 0);
  10936. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10937. error_ = Error::ConnectionClosed;
  10938. }
  10939. return ret;
  10940. } else {
  10941. error_ = Error::Timeout;
  10942. return -1;
  10943. }
  10944. }
  10945. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10946. if (wait_writable()) {
  10947. auto handle_size =
  10948. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10949. tls::TlsError err;
  10950. auto ret = tls::write(session_, ptr, handle_size, err);
  10951. if (ret < 0) {
  10952. auto n = 1000;
  10953. #ifdef _WIN32
  10954. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10955. (err.code == tls::ErrorCode::SyscallError &&
  10956. WSAGetLastError() == WSAETIMEDOUT))) {
  10957. #else
  10958. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10959. #endif
  10960. if (wait_writable()) {
  10961. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10962. ret = tls::write(session_, ptr, handle_size, err);
  10963. if (ret >= 0) { return ret; }
  10964. } else {
  10965. break;
  10966. }
  10967. }
  10968. assert(ret < 0);
  10969. }
  10970. return ret;
  10971. }
  10972. return -1;
  10973. }
  10974. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10975. int &port) const {
  10976. detail::get_remote_ip_and_port(sock_, ip, port);
  10977. }
  10978. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10979. int &port) const {
  10980. detail::get_local_ip_and_port(sock_, ip, port);
  10981. }
  10982. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10983. inline time_t SSLSocketStream::duration() const {
  10984. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10985. std::chrono::steady_clock::now() - start_time_)
  10986. .count();
  10987. }
  10988. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10989. read_timeout_sec_ = sec;
  10990. read_timeout_usec_ = usec;
  10991. }
  10992. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10993. tls::session_t session,
  10994. time_t read_timeout_sec,
  10995. time_t read_timeout_usec,
  10996. time_t write_timeout_sec,
  10997. time_t write_timeout_usec)
  10998. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10999. read_timeout_usec_(read_timeout_usec),
  11000. write_timeout_sec_(write_timeout_sec),
  11001. write_timeout_usec_(write_timeout_usec),
  11002. start_time_(std::chrono::steady_clock::now()) {
  11003. // The receive and send paths run on different threads, so each TLS call is
  11004. // driven in non-blocking mode and readiness is awaited with select()
  11005. // outside the session lock. Set the socket non-blocking once here; it is
  11006. // never flipped back, so no thread races on the flag.
  11007. detail::set_nonblocking(sock_, true);
  11008. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11009. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11010. #endif
  11011. }
  11012. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11013. inline bool WebSocketSSLStream::is_readable() const {
  11014. std::lock_guard<std::mutex> guard(session_mutex_);
  11015. return tls::pending(session_) > 0;
  11016. }
  11017. inline bool WebSocketSSLStream::wait_readable() const {
  11018. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11019. }
  11020. inline bool WebSocketSSLStream::wait_writable() const {
  11021. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11022. // that probe toggles the socket's blocking flag, which would race with the
  11023. // concurrent reader on a permanently non-blocking socket.
  11024. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11025. }
  11026. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11027. tls::TlsError err;
  11028. auto n = 1000;
  11029. while (--n >= 0) {
  11030. {
  11031. std::lock_guard<std::mutex> guard(session_mutex_);
  11032. auto ret = tls::read(session_, ptr, size, err);
  11033. if (ret > 0) { return ret; }
  11034. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11035. error_ = Error::ConnectionClosed;
  11036. return ret;
  11037. }
  11038. }
  11039. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11040. // direction: the send path shares this session, so output it left pending
  11041. // has to be flushed before more input can be decrypted. Anything else is
  11042. // a hard error.
  11043. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11044. #ifdef _WIN32
  11045. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11046. needs_readable =
  11047. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11048. WSAGetLastError() == WSAETIMEDOUT);
  11049. #endif
  11050. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11051. error_ = Error::Read;
  11052. return -1;
  11053. }
  11054. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11055. error_ = Error::Timeout;
  11056. return -1;
  11057. }
  11058. }
  11059. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11060. // to tell a timeout from a close would otherwise see whatever the previous
  11061. // failure left behind (error_ is never cleared on success).
  11062. error_ = Error::Read;
  11063. return -1;
  11064. }
  11065. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11066. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11067. tls::TlsError err;
  11068. auto n = 1000;
  11069. while (--n >= 0) {
  11070. {
  11071. std::lock_guard<std::mutex> guard(session_mutex_);
  11072. auto ret = tls::write(session_, ptr, handle_size, err);
  11073. if (ret >= 0) { return ret; }
  11074. }
  11075. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11076. // or a post-handshake message must be consumed before the record goes
  11077. // out. Anything else is a hard error.
  11078. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11079. #ifdef _WIN32
  11080. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11081. needs_writable =
  11082. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11083. WSAGetLastError() == WSAETIMEDOUT);
  11084. #endif
  11085. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11086. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11087. }
  11088. return -1;
  11089. }
  11090. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11091. int &port) const {
  11092. detail::get_remote_ip_and_port(sock_, ip, port);
  11093. }
  11094. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11095. int &port) const {
  11096. detail::get_local_ip_and_port(sock_, ip, port);
  11097. }
  11098. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11099. inline time_t WebSocketSSLStream::duration() const {
  11100. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11101. std::chrono::steady_clock::now() - start_time_)
  11102. .count();
  11103. }
  11104. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11105. read_timeout_sec_ = sec;
  11106. read_timeout_usec_ = usec;
  11107. }
  11108. } // namespace detail
  11109. #endif // CPPHTTPLIB_SSL_ENABLED
  11110. /*
  11111. * Group 4: Server implementation
  11112. */
  11113. // HTTP server implementation
  11114. inline Server::Server()
  11115. : new_task_queue([] {
  11116. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11117. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11118. }) {
  11119. #ifndef _WIN32
  11120. signal(SIGPIPE, SIG_IGN);
  11121. #endif
  11122. }
  11123. inline Server::~Server() = default;
  11124. inline std::unique_ptr<detail::MatcherBase>
  11125. Server::make_matcher(const std::string &pattern) {
  11126. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11127. // a path params pattern
  11128. if (pattern.find("/:") != std::string::npos) {
  11129. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11130. }
  11131. // A pattern with no regex metacharacter only has to be compared literally,
  11132. // which is what PathParamsMatcher already does when it captures no
  11133. // parameter, so std::regex is only worth building for the patterns that
  11134. // actually need it
  11135. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11136. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11137. }
  11138. return detail::make_unique<detail::RegexMatcher>(pattern);
  11139. }
  11140. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11141. return add_handler(get_handlers_, pattern, std::move(handler));
  11142. }
  11143. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11144. return add_handler(post_handlers_, pattern, std::move(handler));
  11145. }
  11146. inline Server &Server::Post(const std::string &pattern,
  11147. HandlerWithContentReader handler) {
  11148. return add_handler(post_handlers_for_content_reader_, pattern,
  11149. std::move(handler));
  11150. }
  11151. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11152. return add_handler(put_handlers_, pattern, std::move(handler));
  11153. }
  11154. inline Server &Server::Put(const std::string &pattern,
  11155. HandlerWithContentReader handler) {
  11156. return add_handler(put_handlers_for_content_reader_, pattern,
  11157. std::move(handler));
  11158. }
  11159. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11160. return add_handler(patch_handlers_, pattern, std::move(handler));
  11161. }
  11162. inline Server &Server::Patch(const std::string &pattern,
  11163. HandlerWithContentReader handler) {
  11164. return add_handler(patch_handlers_for_content_reader_, pattern,
  11165. std::move(handler));
  11166. }
  11167. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11168. return add_handler(delete_handlers_, pattern, std::move(handler));
  11169. }
  11170. inline Server &Server::Delete(const std::string &pattern,
  11171. HandlerWithContentReader handler) {
  11172. return add_handler(delete_handlers_for_content_reader_, pattern,
  11173. std::move(handler));
  11174. }
  11175. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11176. return add_handler(options_handlers_, pattern, std::move(handler));
  11177. }
  11178. inline const std::set<std::string> &Server::builtin_methods() {
  11179. thread_local const std::set<std::string> methods{
  11180. "GET", "HEAD", "POST", "PUT", "DELETE",
  11181. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11182. return methods;
  11183. }
  11184. inline Server::CustomHandlerEntry *
  11185. Server::custom_entry_for_registration(const std::string &method) {
  11186. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11187. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11188. // routing() before the custom tables are consulted, so a route registered
  11189. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11190. // there and would be reachable, but they carry protocol-level meaning
  11191. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11192. // library does not route.
  11193. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11194. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11195. has_invalid_registration_ = true;
  11196. return nullptr;
  11197. }
  11198. return &custom_handlers_[method];
  11199. }
  11200. inline Server &Server::CustomRoute(const std::string &method,
  11201. const std::string &pattern,
  11202. Handler handler) {
  11203. auto *entry = custom_entry_for_registration(method);
  11204. if (!entry) { return *this; }
  11205. return add_handler(entry->handlers, pattern, std::move(handler));
  11206. }
  11207. inline Server &Server::CustomRoute(const std::string &method,
  11208. const std::string &pattern,
  11209. HandlerWithContentReader handler) {
  11210. auto *entry = custom_entry_for_registration(method);
  11211. if (!entry) { return *this; }
  11212. return add_handler(entry->handlers_for_content_reader, pattern,
  11213. std::move(handler));
  11214. }
  11215. inline const Server::CustomHandlerEntry *
  11216. Server::find_custom_entry(const std::string &method) const {
  11217. // find() alone would be correct here. The empty() check is what keeps the
  11218. // per-request cost off servers that never call CustomRoute(), which is the
  11219. // overwhelmingly common case; keep it rather than walking into the tree.
  11220. if (custom_handlers_.empty()) { return nullptr; }
  11221. auto it = custom_handlers_.find(method);
  11222. return it == custom_handlers_.end() ? nullptr : &it->second;
  11223. }
  11224. inline Server &Server::WebSocket(const std::string &pattern,
  11225. WebSocketHandler handler) {
  11226. websocket_handlers_.push_back(
  11227. {make_matcher(pattern), std::move(handler), nullptr});
  11228. return *this;
  11229. }
  11230. inline Server &Server::WebSocket(const std::string &pattern,
  11231. WebSocketHandler handler,
  11232. SubProtocolSelector sub_protocol_selector) {
  11233. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11234. std::move(sub_protocol_selector)});
  11235. return *this;
  11236. }
  11237. inline bool Server::set_base_dir(const std::string &dir,
  11238. const std::string &mount_point) {
  11239. return set_mount_point(mount_point, dir);
  11240. }
  11241. inline bool Server::set_mount_point(const std::string &mount_point,
  11242. const std::string &dir, Headers headers) {
  11243. detail::FileStat stat(dir);
  11244. if (stat.is_dir()) {
  11245. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11246. if (!mnt.empty() && mnt[0] == '/') {
  11247. std::string resolved_base;
  11248. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11249. #if defined(_WIN32)
  11250. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11251. resolved_base += '\\';
  11252. }
  11253. #else
  11254. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11255. #endif
  11256. }
  11257. base_dirs_.push_back(
  11258. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11259. return true;
  11260. }
  11261. }
  11262. return false;
  11263. }
  11264. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11265. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11266. if (it->mount_point == mount_point) {
  11267. base_dirs_.erase(it);
  11268. return true;
  11269. }
  11270. }
  11271. return false;
  11272. }
  11273. inline Server &
  11274. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11275. const std::string &mime) {
  11276. file_extension_and_mimetype_map_[ext] = mime;
  11277. return *this;
  11278. }
  11279. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11280. default_file_mimetype_ = mime;
  11281. return *this;
  11282. }
  11283. inline Server &Server::set_file_request_handler(Handler handler) {
  11284. file_request_handler_ = std::move(handler);
  11285. return *this;
  11286. }
  11287. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11288. std::true_type) {
  11289. error_handler_ = std::move(handler);
  11290. return *this;
  11291. }
  11292. inline Server &Server::set_error_handler_core(Handler handler,
  11293. std::false_type) {
  11294. error_handler_ = [handler](const Request &req, Response &res) {
  11295. handler(req, res);
  11296. return HandlerResponse::Handled;
  11297. };
  11298. return *this;
  11299. }
  11300. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11301. exception_handler_ = std::move(handler);
  11302. return *this;
  11303. }
  11304. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11305. pre_routing_handler_ = std::move(handler);
  11306. return *this;
  11307. }
  11308. inline Server &Server::set_post_routing_handler(Handler handler) {
  11309. post_routing_handler_ = std::move(handler);
  11310. return *this;
  11311. }
  11312. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11313. pre_request_handler_ = std::move(handler);
  11314. return *this;
  11315. }
  11316. inline Server &Server::set_logger(Logger logger) {
  11317. logger_ = std::move(logger);
  11318. return *this;
  11319. }
  11320. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11321. error_logger_ = std::move(error_logger);
  11322. return *this;
  11323. }
  11324. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11325. pre_compression_logger_ = std::move(logger);
  11326. return *this;
  11327. }
  11328. inline Server &
  11329. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11330. expect_100_continue_handler_ = std::move(handler);
  11331. return *this;
  11332. }
  11333. inline Server &Server::set_start_handler(StartHandler handler) {
  11334. start_handler_ = std::move(handler);
  11335. return *this;
  11336. }
  11337. inline Server &Server::set_address_family(int family) {
  11338. address_family_ = family;
  11339. return *this;
  11340. }
  11341. inline Server &Server::set_tcp_nodelay(bool on) {
  11342. tcp_nodelay_ = on;
  11343. return *this;
  11344. }
  11345. inline Server &Server::set_ipv6_v6only(bool on) {
  11346. ipv6_v6only_ = on;
  11347. return *this;
  11348. }
  11349. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11350. socket_options_ = std::move(socket_options);
  11351. return *this;
  11352. }
  11353. inline Server &Server::set_default_headers(Headers headers) {
  11354. default_headers_ = std::move(headers);
  11355. return *this;
  11356. }
  11357. inline Server &Server::set_header_writer(
  11358. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11359. header_writer_ = writer;
  11360. return *this;
  11361. }
  11362. inline Server &
  11363. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11364. trusted_proxies_ = proxies;
  11365. return *this;
  11366. }
  11367. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11368. keep_alive_max_count_ = count;
  11369. return *this;
  11370. }
  11371. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11372. keep_alive_timeout_sec_ = sec;
  11373. return *this;
  11374. }
  11375. template <class Rep, class Period>
  11376. inline Server &Server::set_keep_alive_timeout(
  11377. const std::chrono::duration<Rep, Period> &duration) {
  11378. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11379. set_keep_alive_timeout(sec);
  11380. });
  11381. return *this;
  11382. }
  11383. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11384. read_timeout_sec_ = sec;
  11385. read_timeout_usec_ = usec;
  11386. return *this;
  11387. }
  11388. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11389. write_timeout_sec_ = sec;
  11390. write_timeout_usec_ = usec;
  11391. return *this;
  11392. }
  11393. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11394. idle_interval_sec_ = sec;
  11395. idle_interval_usec_ = usec;
  11396. return *this;
  11397. }
  11398. inline Server &Server::set_payload_max_length(size_t length) {
  11399. payload_max_length_ = length;
  11400. return *this;
  11401. }
  11402. inline Server &Server::set_static_file_compression(bool on) {
  11403. static_file_compression_ = on;
  11404. return *this;
  11405. }
  11406. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11407. static_file_compression_min_length_ = length;
  11408. return *this;
  11409. }
  11410. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11411. static_file_compression_max_length_ = length;
  11412. return *this;
  11413. }
  11414. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11415. websocket_max_missed_pongs_ = count;
  11416. return *this;
  11417. }
  11418. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11419. websocket_ping_interval_sec_ = sec;
  11420. return *this;
  11421. }
  11422. template <class Rep, class Period>
  11423. inline Server &Server::set_websocket_ping_interval(
  11424. const std::chrono::duration<Rep, Period> &duration) {
  11425. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11426. set_websocket_ping_interval(sec);
  11427. });
  11428. return *this;
  11429. }
  11430. inline bool Server::bind_to_port(const std::string &host, int port,
  11431. int socket_flags) {
  11432. auto ret = bind_internal(host, port, socket_flags);
  11433. if (ret == -1) { is_decommissioned = true; }
  11434. return ret >= 0;
  11435. }
  11436. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11437. auto ret = bind_internal(host, 0, socket_flags);
  11438. if (ret == -1) { is_decommissioned = true; }
  11439. return ret;
  11440. }
  11441. inline bool Server::listen_after_bind() { return listen_internal(); }
  11442. inline bool Server::listen(const std::string &host, int port,
  11443. int socket_flags) {
  11444. return bind_to_port(host, port, socket_flags) && listen_internal();
  11445. }
  11446. inline bool Server::is_running() const { return is_running_; }
  11447. inline void Server::wait_until_ready() const {
  11448. while (!is_running_ && !is_decommissioned) {
  11449. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11450. }
  11451. }
  11452. inline void Server::stop() noexcept {
  11453. // Release the listening socket whether or not the accept loop is running:
  11454. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11455. // exchange is what makes this safe to call concurrently with the accept loop.
  11456. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11457. if (sock != INVALID_SOCKET) {
  11458. detail::shutdown_socket(sock);
  11459. detail::close_socket(sock);
  11460. }
  11461. is_decommissioned = false;
  11462. }
  11463. inline void Server::decommission() { is_decommissioned = true; }
  11464. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11465. auto len = strlen(s);
  11466. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11467. len -= 2;
  11468. {
  11469. size_t count = 0;
  11470. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11471. switch (count) {
  11472. case 0: req.method = std::string(b, e); break;
  11473. case 1: req.target = std::string(b, e); break;
  11474. case 2: req.version = std::string(b, e); break;
  11475. default: break;
  11476. }
  11477. count++;
  11478. });
  11479. if (count != 3) { return false; }
  11480. }
  11481. // A method outside the built-in set is accepted only when a handler has been
  11482. // registered for it with CustomRoute().
  11483. const auto &methods = builtin_methods();
  11484. if (methods.find(req.method) == methods.end() &&
  11485. !find_custom_entry(req.method)) {
  11486. output_error_log(Error::InvalidHTTPMethod, &req);
  11487. return false;
  11488. }
  11489. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11490. output_error_log(Error::InvalidHTTPVersion, &req);
  11491. return false;
  11492. }
  11493. if (!detail::fields::is_request_target(req.target)) { return false; }
  11494. {
  11495. // Skip URL fragment
  11496. for (size_t i = 0; i < req.target.size(); i++) {
  11497. if (req.target[i] == '#') {
  11498. req.target.erase(i);
  11499. break;
  11500. }
  11501. }
  11502. detail::divide(req.target, '?',
  11503. [&](const char *lhs_data, std::size_t lhs_size,
  11504. const char *rhs_data, std::size_t rhs_size) {
  11505. req.path =
  11506. decode_path_component(std::string(lhs_data, lhs_size));
  11507. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11508. });
  11509. }
  11510. return true;
  11511. }
  11512. inline bool Server::write_response(Stream &strm, bool close_connection,
  11513. Request &req, Response &res) {
  11514. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11515. // incorrectly to the error content.
  11516. req.ranges.clear();
  11517. return write_response_core(strm, close_connection, req, res, false);
  11518. }
  11519. inline bool Server::write_response_with_content(Stream &strm,
  11520. bool close_connection,
  11521. const Request &req,
  11522. Response &res) {
  11523. return write_response_core(strm, close_connection, req, res, true);
  11524. }
  11525. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11526. const Request &req, Response &res,
  11527. bool need_apply_ranges) {
  11528. assert(res.status != -1);
  11529. if (400 <= res.status && error_handler_ &&
  11530. error_handler_(req, res) == HandlerResponse::Handled) {
  11531. need_apply_ranges = true;
  11532. }
  11533. detail::prefer_assigned_body(res);
  11534. std::string content_type;
  11535. std::string boundary;
  11536. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11537. // Prepare additional headers
  11538. if (close_connection ||
  11539. detail::has_header_token(req.headers, "Connection", "close") ||
  11540. 400 <= res.status || // Don't leave connections open after errors
  11541. // The client withholds the body until `100 Continue`, which was never
  11542. // sent, so whether and when the body follows is unknown.
  11543. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11544. // The body was left partway, e.g. by a content receiver that returned
  11545. // false, so the rest of it cannot be told from the next request.
  11546. (req.body_read_started_ && !req.body_consumed_)) {
  11547. res.set_header("Connection", "close");
  11548. } else {
  11549. std::string s = "timeout=";
  11550. s += std::to_string(keep_alive_timeout_sec_);
  11551. s += ", max=";
  11552. s += std::to_string(keep_alive_max_count_);
  11553. res.set_header("Keep-Alive", s);
  11554. }
  11555. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11556. !res.has_header("Content-Type")) {
  11557. res.set_header("Content-Type", "text/plain");
  11558. }
  11559. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11560. !res.has_header("Content-Length")) {
  11561. res.set_header("Content-Length", "0");
  11562. }
  11563. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11564. res.set_header("Accept-Ranges", "bytes");
  11565. }
  11566. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11567. // Response line and headers
  11568. detail::BufferStream bstrm;
  11569. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11570. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11571. // Combine a small body with the headers so the whole response leaves in a
  11572. // single write. A large body is written on its own instead: a copy of it
  11573. // costs more than the extra write saves.
  11574. auto send_body = req.method != "HEAD";
  11575. auto body_is_separate = false;
  11576. auto provider_done = false;
  11577. if (send_body && !res.body.empty() && !res.content_provider_) {
  11578. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11579. bstrm.write(res.body.data(), res.body.size());
  11580. } else {
  11581. body_is_separate = true;
  11582. }
  11583. } else if (send_body && res.content_provider_ &&
  11584. res.is_file_content_provider_ &&
  11585. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11586. // A small file is read into the same buffer. Other providers may produce
  11587. // their data over time, so they are never held back.
  11588. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11589. return false;
  11590. }
  11591. provider_done = true;
  11592. }
  11593. // Log before writing to avoid race condition with client-side code that
  11594. // accesses logger-captured data immediately after receiving the response.
  11595. output_log(req, res);
  11596. // Flush buffer
  11597. auto &data = bstrm.get_buffer();
  11598. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11599. if (body_is_separate) {
  11600. return detail::write_data(strm, res.body.data(), res.body.size());
  11601. }
  11602. // Streaming body
  11603. if (send_body && res.content_provider_) {
  11604. if (!provider_done &&
  11605. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11606. return false;
  11607. }
  11608. res.content_provider_success_ = true;
  11609. }
  11610. return true;
  11611. }
  11612. inline bool
  11613. Server::write_content_with_provider(Stream &strm, const Request &req,
  11614. Response &res, const std::string &boundary,
  11615. const std::string &content_type) {
  11616. auto is_shutting_down = [this]() {
  11617. return this->svr_sock_ == INVALID_SOCKET;
  11618. };
  11619. if (res.content_length_ > 0) {
  11620. // Only a 206 response is served as a partial representation, matching the
  11621. // condition `apply_ranges()` used to decide the Content-Length and the
  11622. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11623. // only for a 2xx status, slicing under any other status would write a body
  11624. // that disagrees with the header already sent, from an unchecked offset.
  11625. auto is_partial =
  11626. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11627. if (!is_partial) {
  11628. return detail::write_content(strm, res.content_provider_, 0,
  11629. res.content_length_, is_shutting_down);
  11630. } else if (req.ranges.size() == 1) {
  11631. auto offset_and_length = detail::get_range_offset_and_length(
  11632. req.ranges[0], res.content_length_);
  11633. return detail::write_content(strm, res.content_provider_,
  11634. offset_and_length.first,
  11635. offset_and_length.second, is_shutting_down);
  11636. } else {
  11637. return detail::write_multipart_ranges_data(
  11638. strm, req, res, boundary, content_type, res.content_length_,
  11639. is_shutting_down);
  11640. }
  11641. } else {
  11642. if (res.is_chunked_content_provider_) {
  11643. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11644. // re-negotiating here would disagree with them, e.g. once a handler's
  11645. // own Content-Encoding header suppresses the negotiation.
  11646. auto compressor = detail::make_compressor(res.content_coding_);
  11647. if (!compressor) {
  11648. compressor = detail::make_unique<detail::nocompressor>();
  11649. }
  11650. return detail::write_content_chunked(strm, res.content_provider_,
  11651. is_shutting_down, *compressor);
  11652. } else {
  11653. return detail::write_content_without_length(strm, res.content_provider_,
  11654. is_shutting_down);
  11655. }
  11656. }
  11657. }
  11658. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11659. FormFields::iterator cur_field;
  11660. FormFiles::iterator cur_file;
  11661. auto is_text_field = false;
  11662. size_t count = 0;
  11663. if (read_content_core(
  11664. strm, req, res,
  11665. // Regular
  11666. [&](const char *buf, size_t n) {
  11667. // Prevent arithmetic overflow when checking sizes.
  11668. // Avoid computing (req.body.size() + n) directly because
  11669. // adding two unsigned `size_t` values can wrap around and
  11670. // produce a small result instead of indicating overflow.
  11671. // Instead, check using subtraction: ensure `n` does not
  11672. // exceed the remaining capacity `max_size() - size()`.
  11673. if (req.body.size() >= req.body.max_size() ||
  11674. n > req.body.max_size() - req.body.size()) {
  11675. return false;
  11676. }
  11677. // Limit decompressed body size to payload_max_length_ to protect
  11678. // against "zip bomb" attacks where a small compressed payload
  11679. // decompresses to a massive size.
  11680. if (payload_max_length_ > 0 &&
  11681. (req.body.size() >= payload_max_length_ ||
  11682. n > payload_max_length_ - req.body.size())) {
  11683. return false;
  11684. }
  11685. req.body.append(buf, n);
  11686. return true;
  11687. },
  11688. // Multipart FormData
  11689. [&](const FormData &file) {
  11690. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11691. output_error_log(Error::TooManyFormDataFiles, &req);
  11692. return false;
  11693. }
  11694. if (file.filename.empty()) {
  11695. cur_field = req.form.fields.emplace(
  11696. file.name, FormField{file.name, file.content, file.headers});
  11697. is_text_field = true;
  11698. } else {
  11699. cur_file = req.form.files.emplace(file.name, file);
  11700. is_text_field = false;
  11701. }
  11702. return true;
  11703. },
  11704. [&](const char *buf, size_t n) {
  11705. if (is_text_field) {
  11706. auto &content = cur_field->second.content;
  11707. if (content.size() + n > content.max_size()) { return false; }
  11708. content.append(buf, n);
  11709. } else {
  11710. auto &content = cur_file->second.content;
  11711. if (content.size() + n > content.max_size()) { return false; }
  11712. content.append(buf, n);
  11713. }
  11714. return true;
  11715. })) {
  11716. const auto &content_type = req.get_header_value("Content-Type");
  11717. if (detail::extract_media_type(content_type) ==
  11718. "application/x-www-form-urlencoded") {
  11719. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11720. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11721. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11722. return false;
  11723. }
  11724. detail::parse_query_text(req.body, req.params);
  11725. }
  11726. return true;
  11727. }
  11728. return false;
  11729. }
  11730. inline bool Server::read_content_with_content_receiver(
  11731. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11732. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11733. return read_content_core(strm, req, res, std::move(receiver),
  11734. std::move(multipart_header),
  11735. std::move(multipart_receiver));
  11736. }
  11737. inline bool Server::read_content_core(
  11738. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11739. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11740. detail::FormDataParser multipart_form_data_parser;
  11741. ContentReceiverWithProgress out;
  11742. if (req.is_multipart_form_data()) {
  11743. const auto &content_type = req.get_header_value("Content-Type");
  11744. std::string boundary;
  11745. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11746. res.status = StatusCode::BadRequest_400;
  11747. output_error_log(Error::MultipartParsing, &req);
  11748. return false;
  11749. }
  11750. multipart_form_data_parser.set_boundary(std::move(boundary));
  11751. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11752. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11753. multipart_receiver);
  11754. };
  11755. } else {
  11756. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11757. size_t /*len*/) { return receiver(buf, n); };
  11758. }
  11759. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11760. // For non-SSL builds we still scan non-persistent connections for stray
  11761. // body bytes so the payload limit is enforced (413). On keep-alive,
  11762. // pending bytes may be the next request (issue #2450), so skip.
  11763. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11764. if (!req.has_header("Content-Length") &&
  11765. !detail::is_chunked_transfer_encoding(req.headers)) {
  11766. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11767. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11768. auto has_data = strm.is_readable();
  11769. if (!has_data) {
  11770. auto s = strm.socket();
  11771. if (s != INVALID_SOCKET) {
  11772. has_data = detail::select_read(s, 0, 0) > 0;
  11773. }
  11774. }
  11775. if (has_data) {
  11776. // Route through the same decompressing reader used by the
  11777. // length-framed and chunked paths below, so payload_max_length_ is
  11778. // enforced on the decompressed size here too instead of only on the
  11779. // compressed wire bytes.
  11780. return detail::read_content(strm, req, payload_max_length_, res.status,
  11781. nullptr, out, true);
  11782. }
  11783. }
  11784. return true;
  11785. }
  11786. #else
  11787. if (!req.has_header("Content-Length") &&
  11788. !detail::is_chunked_transfer_encoding(req.headers)) {
  11789. return true;
  11790. }
  11791. #endif
  11792. // A second read would start where the first one stopped, or in the next
  11793. // request.
  11794. if (req.body_read_started_) { return false; }
  11795. // The client is waiting for this before it sends the body.
  11796. if (req.expect_100_continue_pending_) {
  11797. req.expect_100_continue_pending_ = false;
  11798. detail::write_response_line(strm, StatusCode::Continue_100);
  11799. strm.write("\r\n");
  11800. }
  11801. // Set before reading, since a receiver may also stop by throwing.
  11802. req.body_read_started_ = true;
  11803. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11804. out, true)) {
  11805. return false;
  11806. }
  11807. req.body_consumed_ = true;
  11808. if (req.is_multipart_form_data()) {
  11809. if (!multipart_form_data_parser.is_valid()) {
  11810. res.status = StatusCode::BadRequest_400;
  11811. output_error_log(Error::MultipartParsing, &req);
  11812. return false;
  11813. }
  11814. }
  11815. return true;
  11816. }
  11817. inline bool Server::handle_file_request(Request &req, Response &res) {
  11818. for (const auto &entry : base_dirs_) {
  11819. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11820. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11821. // One that already ends in '/' (the root mount among them) carries its own
  11822. // boundary; set_mount_point() guarantees the mount point is not empty.
  11823. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11824. (entry.mount_point.back() == '/' ||
  11825. req.path.size() == entry.mount_point.size() ||
  11826. req.path[entry.mount_point.size()] == '/')) {
  11827. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11828. if (detail::is_valid_path(sub_path)) {
  11829. auto path = entry.base_dir + sub_path;
  11830. if (path.back() == '/') { path += "index.html"; }
  11831. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11832. // but symlinks/junctions can still escape the base directory.
  11833. if (!entry.resolved_base_dir.empty()) {
  11834. std::string resolved_path;
  11835. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11836. !detail::is_path_within_base(resolved_path,
  11837. entry.resolved_base_dir)) {
  11838. res.status = StatusCode::Forbidden_403;
  11839. return true;
  11840. }
  11841. }
  11842. detail::FileStat stat(path);
  11843. if (stat.is_dir()) {
  11844. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  11845. // in the name from reading as a scheme.
  11846. auto name = req.path.substr(req.path.rfind('/') + 1);
  11847. res.set_redirect("./" + encode_path_component(name) + "/",
  11848. StatusCode::MovedPermanently_301);
  11849. return true;
  11850. }
  11851. if (stat.is_file()) {
  11852. for (const auto &kv : entry.headers) {
  11853. res.set_header(kv.first, kv.second);
  11854. }
  11855. auto content_type = detail::find_content_type(
  11856. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11857. auto encoding = detail::EncodingType::None;
  11858. if (static_file_compression_) {
  11859. encoding =
  11860. static_file_encoding(req, res, content_type, stat.size());
  11861. }
  11862. // The ETag names the representation actually sent, so a client that
  11863. // cached the compressed form revalidates against the compressed ETag
  11864. // and still gets a 304, while one that took identity keeps the plain
  11865. // ETag.
  11866. auto etag = detail::compute_etag(
  11867. stat, encoding == detail::EncodingType::None
  11868. ? std::string()
  11869. : std::string("-") + detail::encoding_name(encoding));
  11870. if (!etag.empty()) { res.set_header("ETag", etag); }
  11871. auto mtime = stat.mtime();
  11872. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11873. if (!last_modified.empty()) {
  11874. res.set_header("Last-Modified", last_modified);
  11875. }
  11876. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11877. check_if_range(req, etag, mtime);
  11878. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11879. if (!mm->is_open()) {
  11880. output_error_log(Error::OpenFile, &req);
  11881. return false;
  11882. }
  11883. detail::set_file_content_provider(res, mm, content_type, encoding);
  11884. if (req.method != "HEAD" && file_request_handler_) {
  11885. file_request_handler_(req, res);
  11886. }
  11887. return true;
  11888. } else {
  11889. output_error_log(Error::OpenFile, &req);
  11890. }
  11891. }
  11892. }
  11893. }
  11894. return false;
  11895. }
  11896. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11897. const std::string &etag,
  11898. time_t mtime) const {
  11899. // Handle conditional GET:
  11900. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11901. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11902. if (req.has_header("If-None-Match")) {
  11903. if (!etag.empty()) {
  11904. auto val =
  11905. detail::get_combined_header_value(req.headers, "If-None-Match");
  11906. // NOTE: We use exact string matching here. This works correctly
  11907. // because our server always generates weak ETags (W/"..."), and
  11908. // clients typically send back the same ETag they received.
  11909. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11910. // If-None-Match, where W/"x" and "x" would match, but this
  11911. // simplified implementation requires exact matches.
  11912. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11913. [&](const char *b, const char *e) {
  11914. auto seg_len = static_cast<size_t>(e - b);
  11915. return (seg_len == 1 && *b == '*') ||
  11916. (seg_len == etag.size() &&
  11917. std::equal(b, e, etag.begin()));
  11918. });
  11919. if (ret) {
  11920. res.status = StatusCode::NotModified_304;
  11921. return true;
  11922. }
  11923. }
  11924. } else if (req.has_header("If-Modified-Since")) {
  11925. auto val = req.get_header_value("If-Modified-Since");
  11926. auto t = detail::parse_http_date(val);
  11927. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11928. res.status = StatusCode::NotModified_304;
  11929. return true;
  11930. }
  11931. }
  11932. return false;
  11933. }
  11934. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11935. time_t mtime) const {
  11936. // Handle If-Range for partial content requests (RFC 9110
  11937. // Section 13.1.5). If-Range is only evaluated when Range header is
  11938. // present. If the validator matches, serve partial content; otherwise
  11939. // serve full content.
  11940. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11941. auto val = req.get_header_value("If-Range");
  11942. auto is_valid_range = [&]() {
  11943. if (detail::is_strong_etag(val)) {
  11944. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11945. // comparison.
  11946. return (!etag.empty() && val == etag);
  11947. } else if (detail::is_weak_etag(val)) {
  11948. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11949. return false;
  11950. } else {
  11951. // HTTP-date comparison
  11952. auto t = detail::parse_http_date(val);
  11953. return (t != static_cast<time_t>(-1) && mtime <= t);
  11954. }
  11955. };
  11956. if (!is_valid_range()) {
  11957. // Validator doesn't match: ignore Range and serve full content
  11958. req.ranges.clear();
  11959. return false;
  11960. }
  11961. }
  11962. return true;
  11963. }
  11964. inline socket_t
  11965. Server::create_server_socket(const std::string &host, int port,
  11966. int socket_flags,
  11967. SocketOptions socket_options) const {
  11968. return detail::create_socket(
  11969. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11970. ipv6_v6only_, std::move(socket_options),
  11971. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11972. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11973. output_error_log(Error::BindIPAddress, nullptr);
  11974. return false;
  11975. }
  11976. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11977. output_error_log(Error::Listen, nullptr);
  11978. return false;
  11979. }
  11980. return true;
  11981. });
  11982. }
  11983. inline int Server::bind_internal(const std::string &host, int port,
  11984. int socket_flags) {
  11985. if (is_decommissioned) { return -1; }
  11986. if (!is_valid()) { return -1; }
  11987. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11988. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11989. if (port == 0) {
  11990. struct sockaddr_storage addr;
  11991. socklen_t addr_len = sizeof(addr);
  11992. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11993. &addr_len) == -1) {
  11994. output_error_log(Error::GetSockName, nullptr);
  11995. return -1;
  11996. }
  11997. if (addr.ss_family == AF_INET) {
  11998. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11999. } else if (addr.ss_family == AF_INET6) {
  12000. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12001. } else {
  12002. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12003. return -1;
  12004. }
  12005. } else {
  12006. return port;
  12007. }
  12008. }
  12009. inline bool Server::listen_internal() {
  12010. // A stop() between bind and listen leaves nothing to accept on. Report
  12011. // failure instead of returning success without ever serving, and mark the
  12012. // server decommissioned the way any failed listen does so that a concurrent
  12013. // wait_until_ready() wakes up instead of spinning forever.
  12014. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12015. is_decommissioned = true;
  12016. return false;
  12017. }
  12018. auto ret = true;
  12019. is_running_ = true;
  12020. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12021. if (start_handler_) { start_handler_(); }
  12022. {
  12023. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12024. while (svr_sock_ != INVALID_SOCKET) {
  12025. #ifndef _WIN32
  12026. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12027. #endif
  12028. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12029. idle_interval_usec_);
  12030. if (val == 0) { // Timeout
  12031. task_queue->on_idle();
  12032. continue;
  12033. }
  12034. #ifndef _WIN32
  12035. }
  12036. #endif
  12037. #if defined _WIN32
  12038. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12039. // OVERLAPPED
  12040. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12041. #elif defined SOCK_CLOEXEC
  12042. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12043. #else
  12044. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12045. #endif
  12046. if (sock == INVALID_SOCKET) {
  12047. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12048. // touches the CRT errno, so the two have to be asked platform by
  12049. // platform rather than by testing errno here.
  12050. if (detail::is_accept_resource_error()) {
  12051. // The per-process descriptor limit or the network stack's buffer
  12052. // space has been reached. Try to accept new connections after a
  12053. // short sleep.
  12054. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12055. continue;
  12056. } else if (detail::is_accept_transient_error()) {
  12057. continue;
  12058. }
  12059. // Take the descriptor out of svr_sock_ before closing it: a later
  12060. // stop() would otherwise shutdown()/close() a value the OS may have
  12061. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12062. // gone. The exchange also settles the race with a concurrent stop(),
  12063. // since whichever side takes the descriptor closes it exactly once.
  12064. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12065. if (listen_sock != INVALID_SOCKET) {
  12066. detail::close_socket(listen_sock);
  12067. ret = false;
  12068. output_error_log(Error::Connection, nullptr);
  12069. } else {
  12070. ; // The server socket was closed by user.
  12071. }
  12072. break;
  12073. }
  12074. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12075. read_timeout_sec_, read_timeout_usec_);
  12076. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12077. write_timeout_sec_, write_timeout_usec_);
  12078. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12079. if (!task_queue->enqueue(
  12080. [this, sock]() { process_and_close_socket(sock); })) {
  12081. output_error_log(Error::ResourceExhaustion, nullptr);
  12082. detail::shutdown_socket(sock);
  12083. detail::close_socket(sock);
  12084. }
  12085. }
  12086. task_queue->shutdown();
  12087. }
  12088. is_decommissioned = !ret;
  12089. return ret;
  12090. }
  12091. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  12092. if (pre_routing_handler_ &&
  12093. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12094. return true;
  12095. }
  12096. // File handler
  12097. if ((req.method == "GET" || req.method == "HEAD") &&
  12098. handle_file_request(req, res)) {
  12099. return true;
  12100. }
  12101. const auto *custom = find_custom_entry(req.method);
  12102. // The second clause mirrors what expect_content() does unconditionally for
  12103. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12104. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12105. // `allprop`) would skip its handler and fall through to 404.
  12106. if (detail::expect_content(req) ||
  12107. (custom && !custom->handlers_for_content_reader.empty())) {
  12108. // Content reader handler
  12109. {
  12110. // Track whether the ContentReader was aborted due to the decompressed
  12111. // payload exceeding `payload_max_length_`.
  12112. // The user handler runs after the lambda returns, so we must restore the
  12113. // 413 status if the handler overwrites it.
  12114. bool content_reader_payload_too_large = false;
  12115. ContentReader reader(
  12116. [&](ContentReceiver receiver) {
  12117. auto result = read_content_with_content_receiver(
  12118. strm, req, res, std::move(receiver), nullptr, nullptr);
  12119. if (!result) {
  12120. output_error_log(Error::Read, &req);
  12121. if (res.status == StatusCode::PayloadTooLarge_413) {
  12122. content_reader_payload_too_large = true;
  12123. }
  12124. }
  12125. return result;
  12126. },
  12127. [&](FormDataHeader header, ContentReceiver receiver) {
  12128. auto result = read_content_with_content_receiver(
  12129. strm, req, res, nullptr, std::move(header),
  12130. std::move(receiver));
  12131. if (!result) {
  12132. output_error_log(Error::Read, &req);
  12133. if (res.status == StatusCode::PayloadTooLarge_413) {
  12134. content_reader_payload_too_large = true;
  12135. }
  12136. }
  12137. return result;
  12138. });
  12139. bool dispatched = false;
  12140. if (req.method == "POST") {
  12141. dispatched = dispatch_request_for_content_reader(
  12142. req, res, std::move(reader), post_handlers_for_content_reader_);
  12143. } else if (req.method == "PUT") {
  12144. dispatched = dispatch_request_for_content_reader(
  12145. req, res, std::move(reader), put_handlers_for_content_reader_);
  12146. } else if (req.method == "PATCH") {
  12147. dispatched = dispatch_request_for_content_reader(
  12148. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12149. } else if (req.method == "DELETE") {
  12150. dispatched = dispatch_request_for_content_reader(
  12151. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12152. } else if (custom) {
  12153. dispatched = dispatch_request_for_content_reader(
  12154. req, res, std::move(reader), custom->handlers_for_content_reader);
  12155. }
  12156. if (dispatched) {
  12157. if (content_reader_payload_too_large) {
  12158. // Enforce the limit: override any status the handler may have set
  12159. // and return false so the error path sends a plain 413 response.
  12160. res.status = StatusCode::PayloadTooLarge_413;
  12161. detail::clear_content(res);
  12162. return false;
  12163. }
  12164. return true;
  12165. }
  12166. }
  12167. // NOTE: `req.body` is not read here. For a regular handler the body is
  12168. // read inside dispatch_request(), after the route has matched and the
  12169. // pre-request handler has approved the request, so that a rejected
  12170. // request (e.g. failed authentication) never forces us to buffer a
  12171. // potentially large body.
  12172. }
  12173. // Regular handler
  12174. if (req.method == "GET" || req.method == "HEAD") {
  12175. return dispatch_request(req, res, get_handlers_, strm);
  12176. } else if (req.method == "POST") {
  12177. return dispatch_request(req, res, post_handlers_, strm);
  12178. } else if (req.method == "PUT") {
  12179. return dispatch_request(req, res, put_handlers_, strm);
  12180. } else if (req.method == "DELETE") {
  12181. return dispatch_request(req, res, delete_handlers_, strm);
  12182. } else if (req.method == "OPTIONS") {
  12183. return dispatch_request(req, res, options_handlers_, strm);
  12184. } else if (req.method == "PATCH") {
  12185. return dispatch_request(req, res, patch_handlers_, strm);
  12186. } else if (custom) {
  12187. return dispatch_request(req, res, custom->handlers, strm);
  12188. }
  12189. res.status = StatusCode::BadRequest_400;
  12190. return false;
  12191. }
  12192. inline bool Server::dispatch_request(Request &req, Response &res,
  12193. const Handlers &handlers, Stream &strm) {
  12194. for (const auto &x : handlers) {
  12195. const auto &matcher = x.first;
  12196. const auto &handler = x.second;
  12197. if (matcher->match(req)) {
  12198. req.matched_route = matcher->pattern();
  12199. // Run the pre-request handler before reading the body so a rejected
  12200. // request (e.g. failed authentication) never forces us to buffer a
  12201. // potentially large body. `req.matched_route` is available here.
  12202. if (pre_request_handler_ &&
  12203. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12204. return true;
  12205. }
  12206. // The route matched and the request was approved; read the body now.
  12207. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12208. output_error_log(Error::Read, &req);
  12209. return false;
  12210. }
  12211. handler(req, res);
  12212. return true;
  12213. }
  12214. }
  12215. return false;
  12216. }
  12217. // Decides the content coding for a response served straight from a file. Both
  12218. // the ETag, which has to name the representation actually sent, and
  12219. // `apply_static_file_compression()` go through this, so the two cannot drift
  12220. // apart.
  12221. inline detail::EncodingType
  12222. Server::static_file_encoding(const Request &req, const Response &res,
  12223. const std::string &content_type,
  12224. size_t length) const {
  12225. if (!static_file_compression_) { return detail::EncodingType::None; }
  12226. // Nothing to compress, and an empty file already answers with
  12227. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12228. // turn an empty body into a 20-byte gzip stream.
  12229. if (length == 0) { return detail::EncodingType::None; }
  12230. // A file that already fits in a single packet gains nothing from being made
  12231. // smaller, since it still travels in that one segment, and a file of a few
  12232. // bytes comes out larger than it went in.
  12233. if (length < static_file_compression_min_length_) {
  12234. return detail::EncodingType::None;
  12235. }
  12236. // RFC 9110 applies Range to the representation after content coding, so a
  12237. // compressed 206 would mean compressing the whole file and then slicing it.
  12238. // Serve ranges from the identity representation instead.
  12239. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12240. if (static_file_compression_max_length_ > 0 &&
  12241. length > static_file_compression_max_length_) {
  12242. return detail::EncodingType::None;
  12243. }
  12244. return detail::encoding_type(req, res, content_type);
  12245. }
  12246. // Compresses a file-backed content provider into `res.body` and takes over the
  12247. // framing headers. Returns false when the response is left untouched.
  12248. inline bool Server::apply_static_file_compression(const Request &req,
  12249. Response &res) const {
  12250. auto type = res.content_coding_;
  12251. if (type == detail::EncodingType::None || !res.content_provider_) {
  12252. return false;
  12253. }
  12254. auto compressor = detail::make_compressor(type);
  12255. if (!compressor) { return false; }
  12256. output_pre_compression_log(req, res);
  12257. std::string compressed;
  12258. if (!detail::compress_content_provider(res.content_provider_,
  12259. res.content_length_, *compressor,
  12260. compressed)) {
  12261. return false;
  12262. }
  12263. res.body.swap(compressed);
  12264. // The provider was consumed in full, so its releaser hears about a success.
  12265. res.content_provider_success_ = true;
  12266. detail::clear_content_provider(res);
  12267. res.set_header("Content-Encoding", detail::encoding_name(type));
  12268. res.set_header("Vary", "Accept-Encoding");
  12269. res.set_header("Content-Length", std::to_string(res.body.size()));
  12270. return true;
  12271. }
  12272. inline void Server::apply_ranges(const Request &req, Response &res,
  12273. std::string &content_type,
  12274. std::string &boundary) const {
  12275. // A known-length content provider leaves `res.body` empty, so the compressor
  12276. // at the end of this function never runs for one (issue #2545). A file-backed
  12277. // provider is fully readable right here, so compress it and answer with an
  12278. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12279. // takes the same path as `set_content()` from here on. Range requests never
  12280. // get a content coding, so `Content-Range` still names identity bytes and
  12281. // none of the framing below applies.
  12282. if (apply_static_file_compression(req, res)) { return; }
  12283. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12284. auto it = res.headers.find("Content-Type");
  12285. if (it != res.headers.end()) {
  12286. content_type = it->second;
  12287. res.headers.erase(it);
  12288. }
  12289. boundary = detail::make_multipart_data_boundary();
  12290. res.set_header("Content-Type",
  12291. "multipart/byteranges; boundary=" + boundary);
  12292. }
  12293. auto type = detail::encoding_type(req, res);
  12294. if (res.body.empty()) {
  12295. if (res.content_length_ > 0) {
  12296. size_t length = 0;
  12297. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12298. length = res.content_length_;
  12299. } else if (req.ranges.size() == 1) {
  12300. auto offset_and_length = detail::get_range_offset_and_length(
  12301. req.ranges[0], res.content_length_);
  12302. length = offset_and_length.second;
  12303. auto content_range = detail::make_content_range_header_field(
  12304. offset_and_length, res.content_length_);
  12305. res.set_header("Content-Range", content_range);
  12306. } else {
  12307. length = detail::get_multipart_ranges_data_length(
  12308. req, boundary, content_type, res.content_length_);
  12309. }
  12310. res.set_header("Content-Length", std::to_string(length));
  12311. } else {
  12312. if (res.content_provider_) {
  12313. if (res.is_chunked_content_provider_) {
  12314. res.set_header("Transfer-Encoding", "chunked");
  12315. res.content_coding_ = type;
  12316. if (type != detail::EncodingType::None) {
  12317. res.set_header("Content-Encoding", detail::encoding_name(type));
  12318. res.set_header("Vary", "Accept-Encoding");
  12319. }
  12320. }
  12321. }
  12322. }
  12323. } else {
  12324. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12325. ;
  12326. } else if (req.ranges.size() == 1) {
  12327. auto offset_and_length =
  12328. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12329. auto offset = offset_and_length.first;
  12330. auto length = offset_and_length.second;
  12331. auto content_range = detail::make_content_range_header_field(
  12332. offset_and_length, res.body.size());
  12333. res.set_header("Content-Range", content_range);
  12334. assert(offset + length <= res.body.size());
  12335. res.body = res.body.substr(offset, length);
  12336. } else {
  12337. std::string data;
  12338. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12339. res.body.size(), data);
  12340. res.body.swap(data);
  12341. }
  12342. if (type != detail::EncodingType::None) {
  12343. output_pre_compression_log(req, res);
  12344. if (auto compressor = detail::make_compressor(type)) {
  12345. std::string compressed;
  12346. if (compressor->compress(res.body.data(), res.body.size(), true,
  12347. [&](const char *data, size_t data_len) {
  12348. compressed.append(data, data_len);
  12349. return true;
  12350. })) {
  12351. res.body.swap(compressed);
  12352. res.set_header("Content-Encoding", detail::encoding_name(type));
  12353. res.set_header("Vary", "Accept-Encoding");
  12354. }
  12355. }
  12356. }
  12357. res.content_length_ = res.body.size();
  12358. res.set_header("Content-Length", std::to_string(res.content_length_));
  12359. }
  12360. }
  12361. inline bool Server::dispatch_request_for_content_reader(
  12362. Request &req, Response &res, ContentReader content_reader,
  12363. const HandlersForContentReader &handlers) const {
  12364. for (const auto &x : handlers) {
  12365. const auto &matcher = x.first;
  12366. const auto &handler = x.second;
  12367. if (matcher->match(req)) {
  12368. req.matched_route = matcher->pattern();
  12369. if (!pre_request_handler_ ||
  12370. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12371. handler(req, res, content_reader);
  12372. }
  12373. return true;
  12374. }
  12375. }
  12376. return false;
  12377. }
  12378. inline std::string
  12379. get_client_ip(const std::string &x_forwarded_for,
  12380. const std::vector<std::string> &trusted_proxies) {
  12381. // X-Forwarded-For is a comma-separated list per RFC 7239
  12382. std::vector<std::string> ip_list;
  12383. detail::split(x_forwarded_for.data(),
  12384. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12385. [&](const char *b, const char *e) {
  12386. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12387. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12388. });
  12389. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12390. // no segments. Signal "no client IP derived" with an empty string so the
  12391. // caller can fall back to the connection-level remote address.
  12392. if (ip_list.empty()) { return std::string(); }
  12393. // Each hop appends the address it received the request from, so the rightmost
  12394. // entries are the ones written by our own infrastructure while the leftmost
  12395. // are whatever the original client chose to send. Walk from the right and
  12396. // skip trusted proxies; the first address that is not a trusted proxy is the
  12397. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12398. // from the left instead lets a client forge an arbitrary address by following
  12399. // it with a trusted proxy's address, which the left-to-right scan then
  12400. // returned as the client.
  12401. for (size_t i = ip_list.size(); i-- > 0;) {
  12402. const auto &ip = ip_list[i];
  12403. auto is_trusted_proxy =
  12404. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12405. [&](const std::string &proxy) { return ip == proxy; });
  12406. if (!is_trusted_proxy) { return ip; }
  12407. }
  12408. // Every hop was a trusted proxy; fall back to the first entry.
  12409. return ip_list.front();
  12410. }
  12411. inline bool
  12412. Server::process_request(Stream &strm, const std::string &remote_addr,
  12413. int remote_port, const std::string &local_addr,
  12414. int local_port, bool close_connection,
  12415. bool &connection_closed,
  12416. const std::function<void(Request &)> &setup_request,
  12417. bool *websocket_upgraded) {
  12418. std::array<char, 2048> buf{};
  12419. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12420. // Connection has been closed on client
  12421. if (!line_reader.getline()) { return false; }
  12422. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12423. // clients send an extra CRLF after a request body, which would otherwise be
  12424. // parsed as the next request on a persistent connection.
  12425. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12426. return false;
  12427. }
  12428. Request req;
  12429. req.start_time_ = std::chrono::steady_clock::now();
  12430. req.remote_addr = remote_addr;
  12431. req.remote_port = remote_port;
  12432. req.local_addr = local_addr;
  12433. req.local_port = local_port;
  12434. Response res;
  12435. res.version = "HTTP/1.1";
  12436. res.headers = default_headers_;
  12437. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12438. // close the connection after that response, whichever path wrote it (an
  12439. // error status, a handler, or a rejected request). Reading on would also
  12440. // parse whatever the client sent next on a connection it considers done.
  12441. auto honor_connection_close = detail::scope_exit([&] {
  12442. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12443. connection_closed = true;
  12444. }
  12445. });
  12446. // Request line and headers. A rejected message leaves the rest of it (and
  12447. // any body) unread, so the connection cannot be reused: the leftover bytes
  12448. // would be parsed as the next request.
  12449. if (!parse_request_line(line_reader.ptr(), req)) {
  12450. connection_closed = true;
  12451. res.status = StatusCode::BadRequest_400;
  12452. output_error_log(Error::InvalidRequestLine, &req);
  12453. return write_response(strm, close_connection, req, res);
  12454. }
  12455. // Request headers
  12456. if (!detail::read_headers(strm, req.headers)) {
  12457. connection_closed = true;
  12458. res.status = StatusCode::BadRequest_400;
  12459. output_error_log(Error::InvalidHeaders, &req);
  12460. return write_response(strm, close_connection, req, res);
  12461. }
  12462. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12463. // which would otherwise let an intermediary and this parser disagree on
  12464. // where the body ends and enable request smuggling. Three cases: a
  12465. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12466. // or empty), which would otherwise be read as "no body"; a non-zero
  12467. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12468. // tolerated for compatibility with existing clients); and a
  12469. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12470. // length undeterminable. None of them may fall through to the "no body"
  12471. // path, or the body bytes are parsed as the next request on a persistent
  12472. // connection.
  12473. auto is_invalid_content_length = false;
  12474. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12475. is_invalid_content_length);
  12476. if (is_invalid_content_length ||
  12477. detail::has_conflicting_content_length(req.headers) ||
  12478. (req.has_header("Transfer-Encoding") &&
  12479. !detail::is_chunked_transfer_encoding(req.headers))) {
  12480. connection_closed = true;
  12481. res.status = StatusCode::BadRequest_400;
  12482. return write_response(strm, close_connection, req, res);
  12483. }
  12484. // RFC 9112 §3.2: Reject more than one Host field line or an invalid Host
  12485. // value, so that every recipient of the request sees the same authority.
  12486. if (req.get_header_value_count("Host") > 1 ||
  12487. !detail::fields::is_host(req.get_header_value("Host"))) {
  12488. connection_closed = true;
  12489. res.status = StatusCode::BadRequest_400;
  12490. output_error_log(Error::InvalidHeaders, &req);
  12491. return write_response(strm, close_connection, req, res);
  12492. }
  12493. // Check if the request URI doesn't exceed the limit
  12494. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12495. connection_closed = true;
  12496. res.status = StatusCode::UriTooLong_414;
  12497. output_error_log(Error::ExceedUriMaxLength, &req);
  12498. return write_response(strm, close_connection, req, res);
  12499. }
  12500. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12501. connection_closed = true;
  12502. }
  12503. if (req.version == "HTTP/1.0" &&
  12504. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12505. connection_closed = true;
  12506. }
  12507. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12508. // itself a trusted proxy. Otherwise any direct client could spoof
  12509. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12510. auto is_trusted_peer = std::any_of(
  12511. trusted_proxies_.begin(), trusted_proxies_.end(),
  12512. [&](const std::string &proxy) { return proxy == remote_addr; });
  12513. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12514. // Some proxies append the address they observed as a separate
  12515. // X-Forwarded-For field line instead of extending the one the client sent
  12516. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12517. // be scanned. Reading only the first occurrence would hand back the
  12518. // client-supplied, and therefore forgeable, value.
  12519. auto x_forwarded_for =
  12520. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12521. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12522. req.remote_addr = derived.empty() ? remote_addr : derived;
  12523. } else {
  12524. req.remote_addr = remote_addr;
  12525. }
  12526. req.remote_port = remote_port;
  12527. req.local_addr = local_addr;
  12528. req.local_port = local_port;
  12529. if (req.has_header("Accept")) {
  12530. auto accept_header =
  12531. detail::get_combined_header_value(req.headers, "Accept");
  12532. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12533. connection_closed = true;
  12534. res.status = StatusCode::BadRequest_400;
  12535. output_error_log(Error::HTTPParsing, &req);
  12536. return write_response(strm, close_connection, req, res);
  12537. }
  12538. }
  12539. if (req.has_header("Range")) {
  12540. const auto &range_header_value = req.get_header_value("Range");
  12541. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12542. connection_closed = true;
  12543. res.status = StatusCode::RangeNotSatisfiable_416;
  12544. output_error_log(Error::InvalidRangeHeader, &req);
  12545. return write_response(strm, close_connection, req, res);
  12546. }
  12547. }
  12548. if (setup_request) { setup_request(req); }
  12549. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12550. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12551. // must be ignored. An expectation we do not recognize is left alone; the
  12552. // 417 the section allows for one is a MAY, not a requirement.
  12553. //
  12554. // `100 Continue` itself is deferred until the body is actually read (see
  12555. // read_content_core), so a request rejected by a later handler never
  12556. // invites the client to send a body nobody will read.
  12557. if (req.version != "HTTP/1.0" &&
  12558. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12559. int status = StatusCode::Continue_100;
  12560. if (expect_100_continue_handler_) {
  12561. status = expect_100_continue_handler_(req, res);
  12562. }
  12563. if (status == StatusCode::Continue_100) {
  12564. req.expect_100_continue_pending_ = true;
  12565. } else {
  12566. if (res.status == -1) { res.status = status; }
  12567. connection_closed = true;
  12568. return write_response(strm, true, req, res);
  12569. }
  12570. }
  12571. // Setup `is_connection_closed` method
  12572. auto sock = strm.socket();
  12573. req.is_connection_closed = [sock]() {
  12574. return !detail::is_socket_alive(sock);
  12575. };
  12576. // WebSocket upgrade
  12577. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12578. // that authentication and other middleware can reject the request with an
  12579. // HTTP response (e.g., 401) before the protocol switches.
  12580. if (detail::is_websocket_upgrade(req)) {
  12581. if (pre_routing_handler_ &&
  12582. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12583. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12584. return write_response_with_content(strm, close_connection, req, res);
  12585. }
  12586. // Find matching WebSocket handler
  12587. for (const auto &entry : websocket_handlers_) {
  12588. if (entry.matcher->match(req)) {
  12589. req.matched_route = entry.matcher->pattern();
  12590. if (pre_request_handler_ &&
  12591. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12592. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12593. return write_response_with_content(strm, close_connection, req, res);
  12594. }
  12595. // Compute accept key
  12596. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12597. auto accept_key = detail::websocket_accept_key(client_key);
  12598. // Negotiate subprotocol
  12599. std::string selected_subprotocol;
  12600. if (entry.sub_protocol_selector) {
  12601. auto protocol_header = detail::get_combined_header_value(
  12602. req.headers, "Sec-WebSocket-Protocol");
  12603. if (!protocol_header.empty()) {
  12604. std::vector<std::string> protocols;
  12605. detail::split(protocol_header.data(),
  12606. protocol_header.data() + protocol_header.size(), ',',
  12607. [&](const char *b, const char *e) {
  12608. protocols.emplace_back(b, e);
  12609. });
  12610. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12611. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12612. if (std::find(protocols.begin(), protocols.end(),
  12613. selected_subprotocol) == protocols.end()) {
  12614. selected_subprotocol.clear();
  12615. }
  12616. }
  12617. }
  12618. // Send 101 Switching Protocols
  12619. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12620. "Upgrade: websocket\r\n"
  12621. "Connection: Upgrade\r\n"
  12622. "Sec-WebSocket-Accept: " +
  12623. accept_key + "\r\n";
  12624. if (!selected_subprotocol.empty()) {
  12625. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12626. return false;
  12627. }
  12628. handshake_response +=
  12629. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12630. }
  12631. handshake_response += "\r\n";
  12632. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12633. 0) {
  12634. return false;
  12635. }
  12636. connection_closed = true;
  12637. if (websocket_upgraded) { *websocket_upgraded = true; }
  12638. {
  12639. #ifdef CPPHTTPLIB_SSL_ENABLED
  12640. if (req.ssl) {
  12641. // wss: the heartbeat ping thread and the read path enter the same
  12642. // TLS session from different threads. Hand the WebSocket a stream
  12643. // that serializes every TLS call, so the shared SSLSocketStream on
  12644. // the plain HTTP/HTTPS paths stays untouched.
  12645. auto ws_strm =
  12646. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12647. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12648. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12649. write_timeout_sec_, write_timeout_usec_));
  12650. ws::WebSocket ws(std::move(ws_strm), req, true,
  12651. websocket_ping_interval_sec_,
  12652. websocket_max_missed_pongs_);
  12653. entry.handler(req, ws);
  12654. return true;
  12655. }
  12656. #endif
  12657. // Use WebSocket-specific read timeout instead of HTTP timeout
  12658. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12659. 0);
  12660. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12661. websocket_max_missed_pongs_);
  12662. entry.handler(req, ws);
  12663. }
  12664. return true;
  12665. }
  12666. }
  12667. // No matching handler - fall through to 404
  12668. }
  12669. // Routing
  12670. auto routed = false;
  12671. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12672. routed = routing(req, res, strm);
  12673. #else
  12674. try {
  12675. routed = routing(req, res, strm);
  12676. } catch (std::exception &) {
  12677. if (exception_handler_) {
  12678. auto ep = std::current_exception();
  12679. exception_handler_(req, res, ep);
  12680. routed = true;
  12681. } else {
  12682. res.status = StatusCode::InternalServerError_500;
  12683. }
  12684. } catch (...) {
  12685. if (exception_handler_) {
  12686. auto ep = std::current_exception();
  12687. exception_handler_(req, res, ep);
  12688. routed = true;
  12689. } else {
  12690. res.status = StatusCode::InternalServerError_500;
  12691. }
  12692. }
  12693. #endif
  12694. auto ret = false;
  12695. if (routed) {
  12696. if (res.status == -1) {
  12697. res.status = req.ranges.empty() ? StatusCode::OK_200
  12698. : StatusCode::PartialContent_206;
  12699. }
  12700. // Before the Range checks below, so they see the body's own length.
  12701. detail::prefer_assigned_body(res);
  12702. // Serve file content by using a content provider
  12703. auto file_open_error = false;
  12704. if (!res.file_content_path_.empty()) {
  12705. const auto &path = res.file_content_path_;
  12706. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12707. if (!mm->is_open()) {
  12708. res.status = StatusCode::NotFound_404;
  12709. output_error_log(Error::OpenFile, &req);
  12710. file_open_error = true;
  12711. } else {
  12712. auto content_type = res.file_content_content_type_;
  12713. if (content_type.empty()) {
  12714. content_type = detail::find_content_type(
  12715. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12716. }
  12717. detail::set_file_content_provider(
  12718. res, mm, content_type,
  12719. static_file_encoding(req, res, content_type, mm->size()));
  12720. }
  12721. }
  12722. if (file_open_error) {
  12723. ret = write_response(strm, close_connection, req, res);
  12724. } else if (detail::range_error(req, res)) {
  12725. detail::clear_content(res);
  12726. res.status = StatusCode::RangeNotSatisfiable_416;
  12727. ret = write_response(strm, close_connection, req, res);
  12728. } else {
  12729. ret = write_response_with_content(strm, close_connection, req, res);
  12730. }
  12731. } else {
  12732. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12733. ret = write_response(strm, close_connection, req, res);
  12734. }
  12735. // Drain any unconsumed framed body to prevent request smuggling on
  12736. // keep-alive. Without framing there is no body to drain — reading would
  12737. // consume the next request (issue #2450). If the response has committed the
  12738. // connection to close, there is no next request to protect. A body read in
  12739. // part cannot be drained from where it stopped, so the connection closes.
  12740. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12741. !detail::has_header_token(res.headers, "Connection", "close")) {
  12742. int dummy_status;
  12743. if (req.body_read_started_ ||
  12744. !detail::read_content(
  12745. strm, req, payload_max_length_, dummy_status, nullptr,
  12746. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12747. connection_closed = true;
  12748. }
  12749. }
  12750. return ret;
  12751. }
  12752. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12753. inline bool Server::process_and_close_socket(socket_t sock) {
  12754. std::string remote_addr;
  12755. int remote_port = 0;
  12756. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12757. std::string local_addr;
  12758. int local_port = 0;
  12759. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12760. bool websocket_upgraded = false;
  12761. auto ret = serve_guarded([&]() {
  12762. return detail::process_server_socket(
  12763. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12764. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12765. write_timeout_usec_,
  12766. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12767. return process_request(strm, remote_addr, remote_port, local_addr,
  12768. local_port, close_connection,
  12769. connection_closed, nullptr,
  12770. &websocket_upgraded);
  12771. });
  12772. });
  12773. detail::drain_and_close_socket(sock);
  12774. return ret;
  12775. }
  12776. inline void Server::output_log(const Request &req, const Response &res) const {
  12777. if (logger_) {
  12778. std::lock_guard<std::mutex> guard(logger_mutex_);
  12779. logger_(req, res);
  12780. }
  12781. }
  12782. inline void Server::output_pre_compression_log(const Request &req,
  12783. const Response &res) const {
  12784. if (pre_compression_logger_) {
  12785. std::lock_guard<std::mutex> guard(logger_mutex_);
  12786. pre_compression_logger_(req, res);
  12787. }
  12788. }
  12789. inline void Server::output_error_log(const Error &err,
  12790. const Request *req) const {
  12791. if (error_logger_) {
  12792. std::lock_guard<std::mutex> guard(logger_mutex_);
  12793. error_logger_(err, req);
  12794. }
  12795. }
  12796. /*
  12797. * Group 5: ClientImpl and Client (Universal) implementation
  12798. */
  12799. // HTTP client implementation
  12800. inline ClientImpl::ClientImpl(const std::string &host)
  12801. : ClientImpl(host, 80, std::string(), std::string()) {}
  12802. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12803. : ClientImpl(host, port, std::string(), std::string()) {}
  12804. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12805. const std::string &client_cert_path,
  12806. const std::string &client_key_path)
  12807. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12808. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12809. inline ClientImpl::~ClientImpl() {
  12810. // Wait until all the requests in flight are handled.
  12811. size_t retry_count = 10;
  12812. while (retry_count-- > 0) {
  12813. {
  12814. std::lock_guard<std::mutex> guard(socket_mutex_);
  12815. if (socket_requests_in_flight_ == 0) { break; }
  12816. }
  12817. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12818. }
  12819. std::lock_guard<std::mutex> guard(socket_mutex_);
  12820. shutdown_socket(socket_);
  12821. close_socket(socket_);
  12822. }
  12823. inline bool ClientImpl::is_valid() const { return true; }
  12824. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12825. client_cert_path_ = rhs.client_cert_path_;
  12826. client_key_path_ = rhs.client_key_path_;
  12827. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12828. read_timeout_sec_ = rhs.read_timeout_sec_;
  12829. read_timeout_usec_ = rhs.read_timeout_usec_;
  12830. write_timeout_sec_ = rhs.write_timeout_sec_;
  12831. write_timeout_usec_ = rhs.write_timeout_usec_;
  12832. max_timeout_msec_ = rhs.max_timeout_msec_;
  12833. basic_auth_username_ = rhs.basic_auth_username_;
  12834. basic_auth_password_ = rhs.basic_auth_password_;
  12835. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12836. keep_alive_ = rhs.keep_alive_;
  12837. follow_location_ = rhs.follow_location_;
  12838. path_encode_ = rhs.path_encode_;
  12839. address_family_ = rhs.address_family_;
  12840. tcp_nodelay_ = rhs.tcp_nodelay_;
  12841. ipv6_v6only_ = rhs.ipv6_v6only_;
  12842. socket_options_ = rhs.socket_options_;
  12843. compress_ = rhs.compress_;
  12844. decompress_ = rhs.decompress_;
  12845. payload_max_length_ = rhs.payload_max_length_;
  12846. has_payload_max_length_ = rhs.has_payload_max_length_;
  12847. interface_ = rhs.interface_;
  12848. proxy_host_ = rhs.proxy_host_;
  12849. proxy_port_ = rhs.proxy_port_;
  12850. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12851. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12852. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12853. no_proxy_entries_ = rhs.no_proxy_entries_;
  12854. logger_ = rhs.logger_;
  12855. error_logger_ = rhs.error_logger_;
  12856. #ifdef CPPHTTPLIB_SSL_ENABLED
  12857. digest_auth_username_ = rhs.digest_auth_username_;
  12858. digest_auth_password_ = rhs.digest_auth_password_;
  12859. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12860. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12861. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12862. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12863. server_certificate_verification_ = rhs.server_certificate_verification_;
  12864. server_hostname_verification_ = rhs.server_hostname_verification_;
  12865. system_ca_mode_ = rhs.system_ca_mode_;
  12866. #endif
  12867. }
  12868. inline bool
  12869. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12870. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12871. if (no_proxy_entries_.empty()) { return true; }
  12872. // host_ is const so its normalized form is invariant; cache it. The
  12873. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12874. if (host == host_) {
  12875. if (!host_normalized_valid_) {
  12876. host_normalized_ = detail::normalize_target(host_);
  12877. host_normalized_valid_ = true;
  12878. }
  12879. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12880. }
  12881. auto target = detail::normalize_target(host);
  12882. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12883. }
  12884. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12885. if (is_proxy_enabled_for_host(host_)) {
  12886. return detail::create_client_socket(
  12887. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12888. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12889. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12890. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12891. }
  12892. // Check is custom IP or hostname specified for host_
  12893. std::string connect_host;
  12894. std::string ip;
  12895. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12896. return detail::create_client_socket(
  12897. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12898. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12899. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12900. write_timeout_usec_, interface_, error);
  12901. }
  12902. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12903. Error &error) {
  12904. auto sock = create_client_socket(error);
  12905. if (sock == INVALID_SOCKET) { return false; }
  12906. socket.sock = sock;
  12907. return true;
  12908. }
  12909. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12910. return create_and_connect_socket(socket, error);
  12911. }
  12912. inline bool ClientImpl::setup_proxy_connection(
  12913. Socket & /*socket*/,
  12914. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12915. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12916. return true;
  12917. }
  12918. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12919. bool /*shutdown_gracefully*/) {
  12920. // If there are any requests in flight from threads other than us, then it's
  12921. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12922. assert(socket_requests_in_flight_ == 0 ||
  12923. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12924. }
  12925. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12926. if (socket.sock == INVALID_SOCKET) { return; }
  12927. detail::shutdown_socket(socket.sock);
  12928. }
  12929. inline void ClientImpl::close_socket(Socket &socket) {
  12930. // If there are requests in flight in another thread, usually closing
  12931. // the socket will be fine and they will simply receive an error when
  12932. // using the closed socket, but it is still a bug since rarely the OS
  12933. // may reassign the socket id to be used for a new socket, and then
  12934. // suddenly they will be operating on a live socket that is different
  12935. // than the one they intended!
  12936. assert(socket_requests_in_flight_ == 0 ||
  12937. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12938. // It is also a bug if this happens while SSL is still active
  12939. #ifdef CPPHTTPLIB_SSL_ENABLED
  12940. assert(socket.ssl == nullptr);
  12941. #endif
  12942. if (socket.sock == INVALID_SOCKET) { return; }
  12943. detail::close_socket(socket.sock);
  12944. socket.sock = INVALID_SOCKET;
  12945. }
  12946. inline void ClientImpl::disconnect(bool gracefully) {
  12947. shutdown_ssl(socket_, gracefully);
  12948. shutdown_socket(socket_);
  12949. close_socket(socket_);
  12950. }
  12951. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12952. Response &res,
  12953. bool skip_100_continue) const {
  12954. std::array<char, 2048> buf{};
  12955. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12956. if (!line_reader.getline()) { return false; }
  12957. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12958. res.reason)) {
  12959. return req.method == "CONNECT";
  12960. }
  12961. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12962. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12963. if (!line_reader.getline()) { return false; } // CRLF
  12964. if (!line_reader.getline()) { return false; } // next response line
  12965. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12966. res.reason)) {
  12967. return false;
  12968. }
  12969. }
  12970. return true;
  12971. }
  12972. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12973. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12974. auto ret = send_(req, res, error);
  12975. if (error == Error::SSLPeerCouldBeClosed_) {
  12976. assert(!ret);
  12977. ret = send_(req, res, error);
  12978. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12979. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12980. }
  12981. return ret;
  12982. }
  12983. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12984. {
  12985. std::lock_guard<std::mutex> guard(socket_mutex_);
  12986. // Set this to false immediately - if it ever gets set to true by the end
  12987. // of the request, we know another thread instructed us to close the
  12988. // socket.
  12989. socket_should_be_closed_when_request_is_done_ = false;
  12990. auto is_alive = false;
  12991. if (socket_.is_open()) {
  12992. is_alive = detail::is_socket_alive(socket_.sock);
  12993. #ifdef CPPHTTPLIB_SSL_ENABLED
  12994. if (is_alive && is_ssl()) {
  12995. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12996. is_alive = false;
  12997. }
  12998. }
  12999. #endif
  13000. if (!is_alive) {
  13001. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13002. disconnect(/*gracefully=*/false);
  13003. }
  13004. }
  13005. if (!is_alive) {
  13006. if (!ensure_socket_connection(socket_, error)) {
  13007. output_error_log(error, &req);
  13008. return false;
  13009. }
  13010. {
  13011. auto success = true;
  13012. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13013. error)) {
  13014. if (!success) { output_error_log(error, &req); }
  13015. return success;
  13016. }
  13017. }
  13018. }
  13019. // Mark the current socket as being in use so that it cannot be closed by
  13020. // anyone else while this request is ongoing, even though we will be
  13021. // releasing the mutex.
  13022. if (socket_requests_in_flight_ > 1) {
  13023. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13024. }
  13025. socket_requests_in_flight_ += 1;
  13026. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13027. }
  13028. for (const auto &header : default_headers_) {
  13029. if (req.headers.find(header.first) == req.headers.end()) {
  13030. req.headers.insert(header);
  13031. }
  13032. }
  13033. auto ret = false;
  13034. auto close_connection = !keep_alive_;
  13035. auto se = detail::scope_exit([&]() {
  13036. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13037. std::lock_guard<std::mutex> guard(socket_mutex_);
  13038. socket_requests_in_flight_ -= 1;
  13039. if (socket_requests_in_flight_ <= 0) {
  13040. assert(socket_requests_in_flight_ == 0);
  13041. socket_requests_are_from_thread_ = std::thread::id();
  13042. }
  13043. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13044. !ret) {
  13045. disconnect(/*gracefully=*/true);
  13046. }
  13047. });
  13048. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13049. return handle_request(strm, req, res, close_connection, error);
  13050. });
  13051. if (!ret) {
  13052. if (error == Error::Success) {
  13053. error = Error::Unknown;
  13054. output_error_log(error, &req);
  13055. }
  13056. }
  13057. return ret;
  13058. }
  13059. inline Result ClientImpl::send(const Request &req) {
  13060. auto req2 = req;
  13061. return send_(std::move(req2));
  13062. }
  13063. inline Result ClientImpl::send_(Request &&req) {
  13064. auto res = detail::make_unique<Response>();
  13065. auto error = Error::Success;
  13066. auto ret = send(req, *res, error);
  13067. #ifdef CPPHTTPLIB_SSL_ENABLED
  13068. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13069. last_ssl_error_, last_backend_error_};
  13070. #else
  13071. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13072. #endif
  13073. }
  13074. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13075. const std::string &ct) {
  13076. (void)for_stream;
  13077. // Default headers are meant for the origin and may carry its credentials, so
  13078. // keep them off the CONNECT request the proxy reads.
  13079. if (r.method != "CONNECT") {
  13080. for (const auto &header : default_headers_) {
  13081. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13082. }
  13083. }
  13084. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13085. // prepend it rather than appending it after the caller's own fields.
  13086. if (!r.has_header("Host")) {
  13087. r.headers.emplace_front(
  13088. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13089. address_family_));
  13090. }
  13091. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13092. if (!r.content_receiver) {
  13093. if (!r.has_header("Accept-Encoding")) {
  13094. std::string accept_encoding;
  13095. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13096. accept_encoding = "br";
  13097. #endif
  13098. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13099. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13100. accept_encoding += "gzip, deflate";
  13101. #endif
  13102. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13103. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13104. accept_encoding += "zstd";
  13105. #endif
  13106. r.set_header("Accept-Encoding", accept_encoding);
  13107. }
  13108. detail::add_default_user_agent_header(r);
  13109. }
  13110. if (!r.body.empty()) {
  13111. if (!ct.empty() && !r.has_header("Content-Type")) {
  13112. r.headers.emplace("Content-Type", ct);
  13113. }
  13114. if (!r.has_header("Content-Length")) {
  13115. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13116. }
  13117. }
  13118. }
  13119. inline ClientImpl::StreamHandle
  13120. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13121. const Params &params, const Headers &headers,
  13122. const std::string &body,
  13123. const std::string &content_type) {
  13124. StreamHandle handle;
  13125. handle.response = detail::make_unique<Response>();
  13126. handle.error = Error::Success;
  13127. // Encode the target exactly like the buffered send path does, so that the
  13128. // same `path` produces the same request line through either API.
  13129. auto raw_query_path =
  13130. params.empty() ? path : append_query_params(path, params);
  13131. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13132. handle.connection_ = detail::make_unique<ClientConnection>();
  13133. {
  13134. std::lock_guard<std::mutex> guard(socket_mutex_);
  13135. auto is_alive = false;
  13136. if (socket_.is_open()) {
  13137. is_alive = detail::is_socket_alive(socket_.sock);
  13138. #ifdef CPPHTTPLIB_SSL_ENABLED
  13139. if (is_alive && is_ssl()) {
  13140. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13141. is_alive = false;
  13142. }
  13143. }
  13144. #endif
  13145. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13146. }
  13147. if (!is_alive) {
  13148. if (!ensure_socket_connection(socket_, handle.error)) {
  13149. handle.response.reset();
  13150. return handle;
  13151. }
  13152. {
  13153. auto success = true;
  13154. auto start_time = std::chrono::steady_clock::now();
  13155. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13156. success, handle.error)) {
  13157. if (!success) { handle.response.reset(); }
  13158. return handle;
  13159. }
  13160. }
  13161. }
  13162. transfer_socket_ownership_to_handle(handle);
  13163. }
  13164. #ifdef CPPHTTPLIB_SSL_ENABLED
  13165. if (is_ssl() && handle.connection_->session) {
  13166. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13167. handle.connection_->sock, handle.connection_->session,
  13168. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13169. write_timeout_usec_);
  13170. } else {
  13171. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13172. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13173. write_timeout_sec_, write_timeout_usec_);
  13174. }
  13175. #else
  13176. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13177. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13178. write_timeout_sec_, write_timeout_usec_);
  13179. #endif
  13180. handle.stream_ = handle.socket_stream_.get();
  13181. Request req;
  13182. req.method = method;
  13183. req.path = query_path;
  13184. req.headers = headers;
  13185. req.body = body;
  13186. prepare_default_headers(req, true, content_type);
  13187. auto &strm = *handle.stream_;
  13188. // Build the request line and headers in memory first, like write_request()
  13189. // does, so that a rejected header leaves nothing on the wire.
  13190. {
  13191. detail::BufferStream bstrm;
  13192. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13193. handle.error = Error::Write;
  13194. handle.response.reset();
  13195. return handle;
  13196. }
  13197. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13198. handle.error)) {
  13199. handle.response.reset();
  13200. return handle;
  13201. }
  13202. const auto &data = bstrm.get_buffer();
  13203. if (!detail::write_data(strm, data.data(), data.size())) {
  13204. handle.error = Error::Write;
  13205. handle.response.reset();
  13206. return handle;
  13207. }
  13208. }
  13209. if (!body.empty()) {
  13210. if (strm.write(body.data(), body.size()) < 0) {
  13211. handle.error = Error::Write;
  13212. handle.response.reset();
  13213. return handle;
  13214. }
  13215. }
  13216. if (!read_response_line(strm, req, *handle.response) ||
  13217. !detail::read_headers(strm, handle.response->headers)) {
  13218. handle.error = Error::Read;
  13219. handle.response.reset();
  13220. return handle;
  13221. }
  13222. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13223. // (204/304) response legitimately carries framing headers with no body.
  13224. if (method != "HEAD" &&
  13225. handle.response->status != StatusCode::NoContent_204 &&
  13226. handle.response->status != StatusCode::NotModified_304 &&
  13227. detail::has_conflicting_content_length(handle.response->headers)) {
  13228. handle.error = Error::Read;
  13229. handle.response.reset();
  13230. return handle;
  13231. }
  13232. handle.body_reader_.stream = handle.stream_;
  13233. handle.body_reader_.payload_max_length = payload_max_length_;
  13234. if (handle.response->has_header("Content-Length")) {
  13235. bool is_invalid = false;
  13236. auto content_length = detail::get_header_value_u64(
  13237. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13238. if (is_invalid) {
  13239. handle.error = Error::Read;
  13240. handle.response.reset();
  13241. return handle;
  13242. }
  13243. handle.body_reader_.has_content_length = true;
  13244. handle.body_reader_.content_length = content_length;
  13245. }
  13246. handle.body_reader_.chunked =
  13247. detail::is_chunked_transfer_encoding(handle.response->headers);
  13248. auto content_encoding = detail::get_combined_header_value(
  13249. handle.response->headers, "Content-Encoding");
  13250. if (!content_encoding.empty()) {
  13251. // Same policy as prepare_content_receiver(): reject a coding we know about
  13252. // but were not built with, pass an unrecognized one through as-is.
  13253. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13254. if (!handle.decompressor_) {
  13255. if (detail::is_known_content_encoding(content_encoding)) {
  13256. handle.error = Error::UnsupportedContentEncoding;
  13257. handle.response.reset();
  13258. return handle;
  13259. }
  13260. } else if (!handle.decompressor_->is_valid()) {
  13261. handle.error = Error::Compression;
  13262. handle.response.reset();
  13263. return handle;
  13264. }
  13265. }
  13266. return handle;
  13267. }
  13268. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13269. if (!is_valid() || !response) { return -1; }
  13270. if (decompressor_) { return read_with_decompression(buf, len); }
  13271. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13272. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13273. trailers_parsed_ = true;
  13274. if (body_reader_.chunked_decoder) {
  13275. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13276. response->trailers, response->headers)) {
  13277. return n;
  13278. }
  13279. } else {
  13280. detail::ChunkedDecoder dec(*stream_);
  13281. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13282. return n;
  13283. }
  13284. }
  13285. }
  13286. return n;
  13287. }
  13288. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13289. size_t len) {
  13290. if (decompress_offset_ < decompress_buffer_.size()) {
  13291. auto available = decompress_buffer_.size() - decompress_offset_;
  13292. auto to_copy = (std::min)(len, available);
  13293. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13294. decompress_offset_ += to_copy;
  13295. decompressed_bytes_read_ += to_copy;
  13296. return static_cast<ssize_t>(to_copy);
  13297. }
  13298. decompress_buffer_.clear();
  13299. decompress_offset_ = 0;
  13300. constexpr size_t kDecompressionBufferSize = 8192;
  13301. char compressed_buf[kDecompressionBufferSize];
  13302. while (true) {
  13303. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13304. sizeof(compressed_buf));
  13305. if (n <= 0) { return n; }
  13306. bool decompress_ok = decompressor_->decompress(
  13307. compressed_buf, static_cast<size_t>(n),
  13308. [this](const char *data, size_t data_len) {
  13309. decompress_buffer_.append(data, data_len);
  13310. auto limit = body_reader_.payload_max_length;
  13311. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  13312. return false;
  13313. }
  13314. return true;
  13315. });
  13316. if (!decompress_ok) {
  13317. body_reader_.last_error = Error::Read;
  13318. return -1;
  13319. }
  13320. if (!decompress_buffer_.empty()) { break; }
  13321. }
  13322. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13323. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13324. decompress_offset_ = to_copy;
  13325. decompressed_bytes_read_ += to_copy;
  13326. return static_cast<ssize_t>(to_copy);
  13327. }
  13328. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13329. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13330. return;
  13331. }
  13332. trailers_parsed_ = true;
  13333. const auto bufsiz = 128;
  13334. char line_buf[bufsiz];
  13335. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13336. if (!line_reader.getline()) { return; }
  13337. if (!detail::parse_trailers(line_reader, response->trailers,
  13338. response->headers)) {
  13339. return;
  13340. }
  13341. }
  13342. namespace detail {
  13343. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13344. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13345. size_t &out_chunk_offset,
  13346. size_t &out_chunk_total) {
  13347. if (finished) { return 0; }
  13348. if (chunk_remaining == 0) {
  13349. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13350. if (!lr.getline()) { return -1; }
  13351. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13352. // the line terminator is never mistaken for line content.
  13353. const char *eol = lr.ptr() + lr.size();
  13354. if (lr.end_with_crlf()) {
  13355. eol -= 2;
  13356. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13357. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13358. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13359. // has to come off here or the check below would reject the line.
  13360. eol -= 1;
  13361. }
  13362. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13363. const char *p = lr.ptr();
  13364. int v = 0;
  13365. if (p == eol || !is_hex(*p, v)) { return -1; }
  13366. size_t chunk_len = 0;
  13367. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13368. for (; p < eol && is_hex(*p, v); ++p) {
  13369. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13370. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13371. }
  13372. while (p < eol && is_space_or_tab(*p)) {
  13373. ++p;
  13374. }
  13375. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13376. // terminator, and it is built from tokens and quoted-strings, so it never
  13377. // holds a CR, LF or any other control character. getline() reads up to the
  13378. // CRLF, so a bare LF left in here would be swallowed as extension text
  13379. // while an intermediary that ends the line on it delimits the chunks
  13380. // differently, and the two disagree on where the body ends (request
  13381. // smuggling).
  13382. if (p < eol && *p != ';') { return -1; }
  13383. for (; p < eol; ++p) {
  13384. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13385. }
  13386. if (chunk_len == 0) {
  13387. chunk_remaining = 0;
  13388. finished = true;
  13389. out_chunk_offset = 0;
  13390. out_chunk_total = 0;
  13391. return 0;
  13392. }
  13393. chunk_remaining = chunk_len;
  13394. last_chunk_total = chunk_remaining;
  13395. last_chunk_offset = 0;
  13396. }
  13397. auto to_read = (std::min)(chunk_remaining, len);
  13398. auto n = strm.read(buf, to_read);
  13399. if (n <= 0) { return -1; }
  13400. auto offset_before = last_chunk_offset;
  13401. last_chunk_offset += static_cast<size_t>(n);
  13402. chunk_remaining -= static_cast<size_t>(n);
  13403. out_chunk_offset = offset_before;
  13404. out_chunk_total = last_chunk_total;
  13405. if (chunk_remaining == 0) {
  13406. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13407. if (!lr.getline()) { return -1; }
  13408. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13409. }
  13410. return n;
  13411. }
  13412. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13413. const Headers &src_headers) {
  13414. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13415. if (!lr.getline()) { return false; }
  13416. return parse_trailers(lr, dest, src_headers);
  13417. }
  13418. } // namespace detail
  13419. inline void
  13420. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13421. handle.connection_->sock = socket_.sock;
  13422. #ifdef CPPHTTPLIB_SSL_ENABLED
  13423. handle.connection_->session = socket_.ssl;
  13424. socket_.ssl = nullptr;
  13425. #endif
  13426. socket_.sock = INVALID_SOCKET;
  13427. }
  13428. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13429. Response &res, bool close_connection,
  13430. Error &error) {
  13431. if (req.path.empty()) {
  13432. error = Error::Connection;
  13433. output_error_log(error, &req);
  13434. return false;
  13435. }
  13436. auto req_save = req;
  13437. bool ret;
  13438. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13439. auto req2 = req;
  13440. req2.path = "http://" +
  13441. detail::make_host_and_port_string(host_, port_, false) +
  13442. req.path;
  13443. ret = process_request(strm, req2, res, close_connection, error);
  13444. req = std::move(req2);
  13445. req.path = req_save.path;
  13446. } else {
  13447. ret = process_request(strm, req, res, close_connection, error);
  13448. }
  13449. if (!ret) { return false; }
  13450. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13451. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13452. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13453. // for this to be safe.
  13454. // This is safe to call because handle_request is only called by send_
  13455. // which locks the request mutex during the process. It would be a bug
  13456. // to call it from a different thread since it's a thread-safety issue
  13457. // to do these things to the socket if another thread is using the socket.
  13458. std::lock_guard<std::mutex> guard(socket_mutex_);
  13459. disconnect(/*gracefully=*/true);
  13460. }
  13461. if (300 < res.status && res.status < 400 && follow_location_) {
  13462. req = std::move(req_save);
  13463. // The client that followed the redirect has answered any challenge it
  13464. // could. Retrying below would sign another host's challenge and send it
  13465. // here.
  13466. return redirect(req, res, error);
  13467. }
  13468. #ifdef CPPHTTPLIB_SSL_ENABLED
  13469. if ((res.status == StatusCode::Unauthorized_401 ||
  13470. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13471. req.authorization_count_ < 5) {
  13472. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13473. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13474. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13475. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13476. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13477. return ret;
  13478. }
  13479. const auto &username =
  13480. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13481. const auto &password =
  13482. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13483. if (!username.empty() && !password.empty()) {
  13484. std::map<std::string, std::string> auth;
  13485. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13486. Request new_req = req;
  13487. new_req.authorization_count_ += 1;
  13488. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13489. : "Authorization");
  13490. new_req.headers.insert(detail::make_digest_authentication_header(
  13491. req, auth, new_req.authorization_count_, detail::random_string(10),
  13492. username, password, is_proxy));
  13493. Response new_res;
  13494. ret = send(new_req, new_res, error);
  13495. if (ret) { res = std::move(new_res); }
  13496. }
  13497. }
  13498. }
  13499. #endif
  13500. return ret;
  13501. }
  13502. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13503. if (req.redirect_count_ == 0) {
  13504. error = Error::ExceedRedirectCount;
  13505. output_error_log(error, &req);
  13506. return false;
  13507. }
  13508. auto location = res.get_header_value("location");
  13509. if (location.empty()) { return false; }
  13510. detail::UrlComponents uc;
  13511. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13512. uc)) {
  13513. return false;
  13514. }
  13515. // Only follow http/https redirects
  13516. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13517. return false;
  13518. }
  13519. auto scheme = is_ssl() ? "https" : "http";
  13520. auto next_scheme = std::move(uc.scheme);
  13521. auto next_host = std::move(uc.host);
  13522. auto port_str = std::move(uc.port);
  13523. auto next_path = std::move(uc.path);
  13524. auto next_query = std::move(uc.query);
  13525. auto next_port = port_;
  13526. if (!port_str.empty()) {
  13527. if (!detail::parse_port(port_str, next_port)) { return false; }
  13528. } else if (!next_scheme.empty()) {
  13529. next_port = next_scheme == "https" ? 443 : 80;
  13530. }
  13531. if (next_scheme.empty()) { next_scheme = scheme; }
  13532. if (next_host.empty()) { next_host = host_; }
  13533. if (next_path.empty()) { next_path = "/"; }
  13534. auto path = std::move(next_path) + next_query;
  13535. // Same host redirect - use current client
  13536. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13537. return detail::redirect(*this, req, res, path, location, error);
  13538. }
  13539. // Cross-host/scheme redirect - create new client with robust setup
  13540. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13541. path, location, error);
  13542. }
  13543. // New method for robust redirect client creation
  13544. inline bool ClientImpl::create_redirect_client(
  13545. const std::string &scheme, const std::string &host, int port, Request &req,
  13546. Response &res, const std::string &path, const std::string &location,
  13547. Error &error) {
  13548. // Determine if we need SSL
  13549. auto need_ssl = (scheme == "https");
  13550. // Clean up request headers that are host/client specific
  13551. // Remove headers that should not be carried over to new host
  13552. auto headers_to_remove = std::vector<std::string>{
  13553. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13554. for (const auto &header_name : headers_to_remove) {
  13555. auto it = req.headers.find(header_name);
  13556. while (it != req.headers.end()) {
  13557. it = req.headers.erase(it);
  13558. it = req.headers.find(header_name);
  13559. }
  13560. }
  13561. // Create appropriate client type and handle redirect
  13562. if (need_ssl) {
  13563. #ifdef CPPHTTPLIB_SSL_ENABLED
  13564. // Create SSL client for HTTPS redirect
  13565. SSLClient redirect_client(host, port);
  13566. // Setup basic client configuration first
  13567. setup_redirect_client(redirect_client);
  13568. redirect_client.enable_server_certificate_verification(
  13569. server_certificate_verification_);
  13570. redirect_client.enable_server_hostname_verification(
  13571. server_hostname_verification_);
  13572. redirect_client.system_ca_mode_ = system_ca_mode_;
  13573. // Transfer CA certificate to redirect client
  13574. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13575. ca_cert_pem_.size());
  13576. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13577. if (is_ssl()) {
  13578. auto &self = static_cast<SSLClient &>(*this);
  13579. // A store given to set_ca_cert_store() lives only in this client's
  13580. // context, so pass on the CA certificates the context holds.
  13581. if (self.ca_cert_store_set_) {
  13582. auto pem = detail::ca_certs_to_pem(self.ctx_);
  13583. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13584. }
  13585. redirect_client.set_session_verifier(self.session_verifier_);
  13586. if (self.server_certificate_verifier_) {
  13587. redirect_client.set_server_certificate_verifier(
  13588. self.server_certificate_verifier_);
  13589. }
  13590. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13591. redirect_client.enable_windows_cert_verification_ =
  13592. self.enable_windows_cert_verification_;
  13593. #endif
  13594. }
  13595. // Client certificates are set through constructor for SSLClient
  13596. // NOTE: SSLClient constructor already takes client_cert_path and
  13597. // client_key_path so we need to create it properly if client certs are
  13598. // needed
  13599. // Execute the redirect
  13600. return detail::redirect(redirect_client, req, res, path, location, error);
  13601. #else
  13602. // SSL not supported - set appropriate error
  13603. error = Error::SSLConnection;
  13604. output_error_log(error, &req);
  13605. return false;
  13606. #endif
  13607. } else {
  13608. // HTTP redirect
  13609. ClientImpl redirect_client(host, port);
  13610. // Setup client with robust configuration
  13611. setup_redirect_client(redirect_client);
  13612. // Execute the redirect
  13613. return detail::redirect(redirect_client, req, res, path, location, error);
  13614. }
  13615. }
  13616. // New method for robust client setup (based on basic_manual_redirect.cpp
  13617. // logic)
  13618. template <typename ClientType>
  13619. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13620. // Copy basic settings first
  13621. client.set_connection_timeout(connection_timeout_sec_,
  13622. connection_timeout_usec_);
  13623. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13624. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13625. client.set_max_timeout(max_timeout_msec_);
  13626. if (has_payload_max_length_) {
  13627. client.set_payload_max_length(payload_max_length_);
  13628. }
  13629. client.set_keep_alive(keep_alive_);
  13630. client.set_follow_location(
  13631. true); // Enable redirects to handle multi-step redirects
  13632. client.set_path_encode(path_encode_);
  13633. client.set_compress(compress_);
  13634. client.set_decompress(decompress_);
  13635. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13636. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13637. // 15.4, credentials must not be forwarded when redirecting to a different
  13638. // host. This function is only called for cross-host redirects; same-host
  13639. // redirects are handled directly in ClientImpl::redirect().
  13640. // Copy the proxy configuration unconditionally; the per-target bypass is
  13641. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13642. // still use the proxy.
  13643. client.no_proxy_entries_ = no_proxy_entries_;
  13644. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13645. client.set_proxy(proxy_host_, proxy_port_);
  13646. if (!proxy_basic_auth_username_.empty() ||
  13647. !proxy_basic_auth_password_.empty()) {
  13648. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13649. proxy_basic_auth_password_);
  13650. }
  13651. if (!proxy_bearer_token_auth_token_.empty()) {
  13652. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13653. }
  13654. #ifdef CPPHTTPLIB_SSL_ENABLED
  13655. if (!proxy_digest_auth_username_.empty()) {
  13656. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13657. proxy_digest_auth_password_);
  13658. }
  13659. #endif
  13660. }
  13661. // Copy network and socket settings
  13662. client.addr_map_ = addr_map_;
  13663. client.set_address_family(address_family_);
  13664. client.set_tcp_nodelay(tcp_nodelay_);
  13665. client.set_ipv6_v6only(ipv6_v6only_);
  13666. if (socket_options_) { client.set_socket_options(socket_options_); }
  13667. if (!interface_.empty()) { client.set_interface(interface_); }
  13668. // Copy logging and headers
  13669. if (logger_) { client.set_logger(logger_); }
  13670. if (error_logger_) { client.set_error_logger(error_logger_); }
  13671. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13672. // Each new client should generate its own headers based on its target host
  13673. }
  13674. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13675. const Request &req,
  13676. Error &error) const {
  13677. auto is_shutting_down = []() { return false; };
  13678. if (req.is_chunked_content_provider_) {
  13679. auto compressor = compress_ ? detail::create_compressor().first
  13680. : std::unique_ptr<detail::compressor>();
  13681. if (!compressor) {
  13682. compressor = detail::make_unique<detail::nocompressor>();
  13683. }
  13684. return detail::write_content_chunked(strm, req.content_provider_,
  13685. is_shutting_down, *compressor, error);
  13686. } else {
  13687. return detail::write_content_with_progress(
  13688. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13689. req.upload_progress, error);
  13690. }
  13691. }
  13692. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13693. bool close_connection, Error &error,
  13694. bool skip_body, bool &rejected_locally) {
  13695. rejected_locally = false;
  13696. // Prepare additional headers
  13697. if (close_connection) {
  13698. if (!req.has_header("Connection")) {
  13699. req.set_header("Connection", "close");
  13700. }
  13701. }
  13702. std::string ct_for_defaults;
  13703. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13704. ct_for_defaults = "text/plain";
  13705. }
  13706. prepare_default_headers(req, false, ct_for_defaults);
  13707. if (req.body.empty()) {
  13708. if (req.content_provider_) {
  13709. if (!req.is_chunked_content_provider_) {
  13710. if (!req.has_header("Content-Length")) {
  13711. auto length = std::to_string(req.content_length_);
  13712. req.set_header("Content-Length", length);
  13713. }
  13714. }
  13715. } else {
  13716. if (req.method == "POST" || req.method == "PUT" ||
  13717. req.method == "PATCH") {
  13718. req.set_header("Content-Length", "0");
  13719. }
  13720. }
  13721. }
  13722. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13723. // it opens is read by the origin. Each credential goes only to its own hop.
  13724. auto is_connect = req.method == "CONNECT";
  13725. if (!is_connect && !req.has_header("Authorization")) {
  13726. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13727. req.headers.insert(make_basic_authentication_header(
  13728. basic_auth_username_, basic_auth_password_, false));
  13729. } else if (!bearer_token_auth_token_.empty()) {
  13730. req.headers.insert(make_bearer_token_authentication_header(
  13731. bearer_token_auth_token_, false));
  13732. }
  13733. }
  13734. // Proxy-Authorization is only sent when the proxy reads this message —
  13735. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13736. // would leak proxy credentials to the destination server.
  13737. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13738. if ((!proxy_basic_auth_username_.empty() ||
  13739. !proxy_basic_auth_password_.empty()) &&
  13740. !req.has_header("Proxy-Authorization")) {
  13741. req.headers.insert(make_basic_authentication_header(
  13742. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13743. }
  13744. if (!proxy_bearer_token_auth_token_.empty() &&
  13745. !req.has_header("Proxy-Authorization")) {
  13746. req.headers.insert(make_bearer_token_authentication_header(
  13747. proxy_bearer_token_auth_token_, true));
  13748. }
  13749. }
  13750. // Request line and headers
  13751. {
  13752. detail::BufferStream bstrm;
  13753. // Extract the query from req.path. The encoding itself is delegated to
  13754. // `encode_request_target`; the raw query is still needed here to decide
  13755. // between populating `req.params` from it and falling back to building a
  13756. // query out of caller-supplied `req.params`.
  13757. auto query_pos = req.path.find('?');
  13758. auto query_part = query_pos == std::string::npos
  13759. ? std::string()
  13760. : req.path.substr(query_pos + 1);
  13761. auto path_with_query =
  13762. detail::encode_request_target(req.path, path_encode_);
  13763. if (!query_part.empty()) {
  13764. // The query already came in through `req.path`; still populate
  13765. // `req.params` for handlers/users who read them.
  13766. detail::parse_query_text(query_part, req.params);
  13767. } else if (!req.params.empty()) {
  13768. // No query in `req.path`; build one from `req.params` so existing
  13769. // callers that pass `Params` separately continue to work.
  13770. path_with_query = append_query_params(path_with_query, req.params);
  13771. }
  13772. // Write request line and headers
  13773. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13774. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13775. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  13776. // fail the request cleanly instead of emitting a request-line-less,
  13777. // header-injecting request.
  13778. error = Error::Write;
  13779. rejected_locally = true;
  13780. output_error_log(error, &req);
  13781. return false;
  13782. }
  13783. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13784. error)) {
  13785. rejected_locally = true;
  13786. output_error_log(error, &req);
  13787. return false;
  13788. }
  13789. // Flush buffer
  13790. auto &data = bstrm.get_buffer();
  13791. if (!detail::write_data(strm, data.data(), data.size())) {
  13792. error = Error::Write;
  13793. output_error_log(error, &req);
  13794. return false;
  13795. }
  13796. }
  13797. // After sending request line and headers, wait briefly for an early server
  13798. // response (e.g. 4xx) and avoid sending a potentially large request body
  13799. // unnecessarily. This workaround is only enabled on Windows because Unix
  13800. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13801. // buffering can accept large writes even when the peer already responded.
  13802. // Check the stream first (which covers SSL via `is_readable()`), then
  13803. // fall back to select on the socket. Only perform the wait for very large
  13804. // request bodies to avoid interfering with normal small requests and
  13805. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13806. // response. Skip this check when using Expect: 100-continue, as the protocol
  13807. // handles early responses properly.
  13808. #if defined(_WIN32)
  13809. if (!skip_body &&
  13810. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13811. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13812. auto start = std::chrono::high_resolution_clock::now();
  13813. for (;;) {
  13814. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13815. // from SSL internals. If the underlying socket is readable, assume an
  13816. // early response may be present.
  13817. auto sock = strm.socket();
  13818. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13819. return false;
  13820. }
  13821. // Fallback to stream-level check for non-socket streams or when the
  13822. // socket isn't reporting readable. Avoid using `is_readable()` for
  13823. // SSL, since `SSL_pending()` may report buffered records that do not
  13824. // indicate a complete application-level response yet.
  13825. if (!is_ssl() && strm.is_readable()) { return false; }
  13826. auto now = std::chrono::high_resolution_clock::now();
  13827. auto elapsed =
  13828. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13829. .count();
  13830. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13831. break;
  13832. }
  13833. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13834. }
  13835. }
  13836. #endif
  13837. // Body
  13838. if (skip_body) { return true; }
  13839. return write_request_body(strm, req, error);
  13840. }
  13841. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13842. Error &error) {
  13843. if (req.body.empty()) {
  13844. return write_content_with_provider(strm, req, error);
  13845. }
  13846. if (req.upload_progress) {
  13847. auto body_size = req.body.size();
  13848. size_t written = 0;
  13849. auto data = req.body.data();
  13850. while (written < body_size) {
  13851. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13852. if (!detail::write_data(strm, data + written, to_write)) {
  13853. error = Error::Write;
  13854. output_error_log(error, &req);
  13855. return false;
  13856. }
  13857. written += to_write;
  13858. if (!req.upload_progress(written, body_size)) {
  13859. error = Error::Canceled;
  13860. output_error_log(error, &req);
  13861. return false;
  13862. }
  13863. }
  13864. } else {
  13865. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13866. error = Error::Write;
  13867. output_error_log(error, &req);
  13868. return false;
  13869. }
  13870. }
  13871. return true;
  13872. }
  13873. inline std::unique_ptr<Response>
  13874. ClientImpl::send_with_content_provider_and_receiver(
  13875. Request &req, const char *body, size_t content_length,
  13876. ContentProvider content_provider,
  13877. ContentProviderWithoutLength content_provider_without_length,
  13878. const std::string &content_type, ContentReceiver content_receiver,
  13879. Error &error) {
  13880. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13881. auto enc = compress_
  13882. ? detail::create_compressor()
  13883. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13884. nullptr, nullptr);
  13885. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13886. if (enc.first && !content_provider_without_length) {
  13887. auto &compressor = enc.first;
  13888. if (content_provider) {
  13889. auto ok = true;
  13890. auto finished = false;
  13891. size_t offset = 0;
  13892. DataSink data_sink;
  13893. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13894. if (ok) {
  13895. auto last = offset + data_len == content_length;
  13896. auto ret = compressor->compress(
  13897. data, data_len, last,
  13898. [&](const char *compressed_data, size_t compressed_data_len) {
  13899. req.body.append(compressed_data, compressed_data_len);
  13900. return true;
  13901. });
  13902. if (ret) {
  13903. offset += data_len;
  13904. } else {
  13905. ok = false;
  13906. }
  13907. }
  13908. return ok;
  13909. };
  13910. // As in detail::write_content_with_progress(): the body is framed by
  13911. // content_length, so a provider that finishes early has truncated it.
  13912. // Stop and report that instead of calling the provider forever.
  13913. data_sink.done = [&]() { finished = true; };
  13914. while (ok && !finished && offset < content_length) {
  13915. if (!content_provider(offset, content_length - offset, data_sink)) {
  13916. error = Error::Canceled;
  13917. output_error_log(error, &req);
  13918. return nullptr;
  13919. }
  13920. }
  13921. // A short body here means either the provider stopped early or the
  13922. // compressor gave up. The branch below reports a failing compressor as
  13923. // Error::Compression, so keep the two distinguishable.
  13924. if (offset < content_length) {
  13925. error = ok ? Error::Write : Error::Compression;
  13926. output_error_log(error, &req);
  13927. return nullptr;
  13928. }
  13929. } else {
  13930. if (!compressor->compress(body, content_length, true,
  13931. [&](const char *data, size_t data_len) {
  13932. req.body.append(data, data_len);
  13933. return true;
  13934. })) {
  13935. error = Error::Compression;
  13936. output_error_log(error, &req);
  13937. return nullptr;
  13938. }
  13939. }
  13940. } else {
  13941. if (content_provider) {
  13942. req.content_length_ = content_length;
  13943. req.content_provider_ = std::move(content_provider);
  13944. req.is_chunked_content_provider_ = false;
  13945. } else if (content_provider_without_length) {
  13946. req.content_length_ = 0;
  13947. req.content_provider_ = detail::ContentProviderAdapter(
  13948. std::move(content_provider_without_length));
  13949. req.is_chunked_content_provider_ = true;
  13950. req.set_header("Transfer-Encoding", "chunked");
  13951. } else {
  13952. req.body.assign(body, content_length);
  13953. }
  13954. }
  13955. if (content_receiver) {
  13956. req.content_receiver =
  13957. [content_receiver](const char *data, size_t data_length,
  13958. size_t /*offset*/, size_t /*total_length*/) {
  13959. return content_receiver(data, data_length);
  13960. };
  13961. }
  13962. auto res = detail::make_unique<Response>();
  13963. return send(req, *res, error) ? std::move(res) : nullptr;
  13964. }
  13965. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13966. const std::string &method, const std::string &path, const Headers &headers,
  13967. const char *body, size_t content_length, ContentProvider content_provider,
  13968. ContentProviderWithoutLength content_provider_without_length,
  13969. const std::string &content_type, ContentReceiver content_receiver,
  13970. UploadProgress progress) {
  13971. Request req;
  13972. req.method = method;
  13973. req.headers = headers;
  13974. req.path = path;
  13975. req.upload_progress = std::move(progress);
  13976. if (max_timeout_msec_ > 0) {
  13977. req.start_time_ = std::chrono::steady_clock::now();
  13978. }
  13979. auto error = Error::Success;
  13980. auto res = send_with_content_provider_and_receiver(
  13981. req, body, content_length, std::move(content_provider),
  13982. std::move(content_provider_without_length), content_type,
  13983. std::move(content_receiver), error);
  13984. #ifdef CPPHTTPLIB_SSL_ENABLED
  13985. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13986. last_backend_error_};
  13987. #else
  13988. return Result{std::move(res), error, std::move(req.headers)};
  13989. #endif
  13990. }
  13991. inline void ClientImpl::output_log(const Request &req,
  13992. const Response &res) const {
  13993. if (logger_) {
  13994. std::lock_guard<std::mutex> guard(logger_mutex_);
  13995. logger_(req, res);
  13996. }
  13997. }
  13998. inline void ClientImpl::output_error_log(const Error &err,
  13999. const Request *req) const {
  14000. if (error_logger_) {
  14001. std::lock_guard<std::mutex> guard(logger_mutex_);
  14002. error_logger_(err, req);
  14003. }
  14004. }
  14005. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14006. Response &res, bool close_connection,
  14007. Error &error) {
  14008. // Auto-add Expect: 100-continue for large bodies
  14009. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14010. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14011. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14012. req.set_header("Expect", "100-continue");
  14013. }
  14014. }
  14015. // Check for Expect: 100-continue
  14016. auto expect_100_continue =
  14017. detail::has_header_token(req.headers, "Expect", "100-continue");
  14018. // Send request (skip body if using Expect: 100-continue)
  14019. auto rejected_locally = false;
  14020. auto write_request_success =
  14021. write_request(strm, req, close_connection, error, expect_100_continue,
  14022. rejected_locally);
  14023. // A failed write normally still reads the response below, since the server
  14024. // may have answered early (e.g. 413/414) and closed while the body was being
  14025. // sent. A request rejected before any byte reached the socket gets no such
  14026. // response, and waiting for one would block until the read timeout.
  14027. if (rejected_locally) { return false; }
  14028. #ifdef CPPHTTPLIB_SSL_ENABLED
  14029. if (is_ssl() && !expect_100_continue) {
  14030. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14031. if (!is_proxy_enabled) {
  14032. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14033. error = Error::SSLPeerCouldBeClosed_;
  14034. output_error_log(error, &req);
  14035. return false;
  14036. }
  14037. }
  14038. }
  14039. #endif
  14040. // Handle Expect: 100-continue.
  14041. //
  14042. // Wait for an interim/early response by attempting to read the status line
  14043. // under a short timeout, instead of trusting raw socket readability. Over
  14044. // TLS, post-handshake records (e.g. session tickets) make the socket
  14045. // readable without any HTTP response being available; relying on
  14046. // `select_read` there caused the body to be withheld forever and the
  14047. // request to fail with `Read` (#2458). If no status line arrives within the
  14048. // timeout, send the body anyway (matching curl's behavior).
  14049. auto status_line_read = false;
  14050. if (expect_100_continue && write_request_success) {
  14051. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14052. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14053. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14054. strm.set_read_timeout(sec, usec);
  14055. status_line_read = read_response_line(strm, req, res, false);
  14056. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14057. }
  14058. if (!status_line_read) {
  14059. // No interim response within the timeout: send the body and handle the
  14060. // response as usual.
  14061. if (!write_request_body(strm, req, error)) { return false; }
  14062. expect_100_continue = false; // Switch to normal response handling
  14063. }
  14064. }
  14065. // Receive response and headers
  14066. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14067. if ((!status_line_read &&
  14068. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14069. !detail::read_headers(strm, res.headers)) {
  14070. if (write_request_success) { error = Error::Read; }
  14071. output_error_log(error, &req);
  14072. return false;
  14073. }
  14074. if (!write_request_success) { return false; }
  14075. // Handle Expect: 100-continue response
  14076. if (expect_100_continue) {
  14077. if (res.status == StatusCode::Continue_100) {
  14078. // Server accepted, send the body
  14079. if (!write_request_body(strm, req, error)) { return false; }
  14080. // Read the actual response
  14081. res.headers.clear();
  14082. res.body.clear();
  14083. if (!read_response_line(strm, req, res) ||
  14084. !detail::read_headers(strm, res.headers)) {
  14085. error = Error::Read;
  14086. output_error_log(error, &req);
  14087. return false;
  14088. }
  14089. }
  14090. // If not 100 Continue, server returned an error; proceed with that response
  14091. }
  14092. // Body
  14093. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14094. req.method != "CONNECT") {
  14095. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14096. // whose final transfer coding is not chunked is not ambiguous: its body
  14097. // runs until the server closes the connection, so it is not rejected.
  14098. // HEAD/204 are excluded above and a 304 carries no body.
  14099. if (res.status != StatusCode::NotModified_304 &&
  14100. detail::has_conflicting_content_length(res.headers)) {
  14101. error = Error::Read;
  14102. output_error_log(error, &req);
  14103. return false;
  14104. }
  14105. auto redirect = 300 < res.status && res.status < 400 &&
  14106. res.status != StatusCode::NotModified_304 &&
  14107. follow_location_;
  14108. if (req.response_handler && !redirect) {
  14109. if (!req.response_handler(res)) {
  14110. error = Error::Canceled;
  14111. output_error_log(error, &req);
  14112. return false;
  14113. }
  14114. }
  14115. auto out =
  14116. req.content_receiver
  14117. ? static_cast<ContentReceiverWithProgress>(
  14118. [&](const char *buf, size_t n, size_t off, size_t len) {
  14119. if (redirect) { return true; }
  14120. auto ret = req.content_receiver(buf, n, off, len);
  14121. if (!ret) {
  14122. error = Error::Canceled;
  14123. output_error_log(error, &req);
  14124. }
  14125. return ret;
  14126. })
  14127. : static_cast<ContentReceiverWithProgress>(
  14128. [&](const char *buf, size_t n, size_t /*off*/,
  14129. size_t /*len*/) {
  14130. assert(res.body.size() + n <= res.body.max_size());
  14131. if (payload_max_length_ > 0 &&
  14132. (res.body.size() >= payload_max_length_ ||
  14133. n > payload_max_length_ - res.body.size())) {
  14134. return false;
  14135. }
  14136. res.body.append(buf, n);
  14137. return true;
  14138. });
  14139. auto progress = [&](size_t current, size_t total) {
  14140. if (!req.download_progress || redirect) { return true; }
  14141. auto ret = req.download_progress(current, total);
  14142. if (!ret) {
  14143. error = Error::Canceled;
  14144. output_error_log(error, &req);
  14145. }
  14146. return ret;
  14147. };
  14148. if (res.has_header("Content-Length")) {
  14149. if (!req.content_receiver) {
  14150. auto len = res.get_header_value_u64("Content-Length");
  14151. if (len > res.body.max_size()) {
  14152. error = Error::Read;
  14153. output_error_log(error, &req);
  14154. return false;
  14155. }
  14156. // Cap the reservation by payload_max_length_ to avoid OOM when a
  14157. // hostile or malformed server sends an enormous Content-Length.
  14158. // The actual body read below is bounded by payload_max_length_,
  14159. // so reserving more than that is never useful.
  14160. auto reserve_len = static_cast<size_t>(len);
  14161. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  14162. reserve_len = payload_max_length_;
  14163. }
  14164. res.body.reserve(reserve_len);
  14165. }
  14166. }
  14167. if (res.status != StatusCode::NotModified_304) {
  14168. auto content_status = 0;
  14169. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14170. ? (std::numeric_limits<size_t>::max)()
  14171. : payload_max_length_;
  14172. if (!detail::read_content(strm, res, max_length, content_status,
  14173. std::move(progress), std::move(out),
  14174. decompress_)) {
  14175. if (error != Error::Canceled) {
  14176. // Tell the caller apart from a plain read failure when the body could
  14177. // not be decoded because of its Content-Encoding.
  14178. switch (content_status) {
  14179. case StatusCode::UnsupportedMediaType_415:
  14180. error = Error::UnsupportedContentEncoding;
  14181. break;
  14182. case StatusCode::InternalServerError_500:
  14183. error = Error::Compression;
  14184. break;
  14185. default: error = Error::Read; break;
  14186. }
  14187. }
  14188. output_error_log(error, &req);
  14189. return false;
  14190. }
  14191. }
  14192. }
  14193. // Log
  14194. output_log(req, res);
  14195. return true;
  14196. }
  14197. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14198. const std::string &boundary, const UploadFormDataItems &items,
  14199. const FormDataProviderItems &provider_items) const {
  14200. size_t cur_item = 0;
  14201. size_t cur_start = 0;
  14202. // cur_item and cur_start are copied to within the std::function and
  14203. // maintain state between successive calls
  14204. return [&, cur_item, cur_start](size_t offset,
  14205. DataSink &sink) mutable -> bool {
  14206. if (!offset && !items.empty()) {
  14207. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14208. return true;
  14209. } else if (cur_item < provider_items.size()) {
  14210. if (!cur_start) {
  14211. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14212. provider_items[cur_item], boundary);
  14213. offset += begin.size();
  14214. cur_start = offset;
  14215. sink.os << begin;
  14216. }
  14217. DataSink cur_sink;
  14218. auto has_data = true;
  14219. cur_sink.write = sink.write;
  14220. // Forward is_writable so a provider item asking whether it may keep
  14221. // going gets the outer sink's answer rather than the default `true`.
  14222. cur_sink.is_writable = sink.is_writable;
  14223. cur_sink.done = [&]() { has_data = false; };
  14224. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14225. return false;
  14226. }
  14227. if (!has_data) {
  14228. sink.os << detail::serialize_multipart_formdata_item_end();
  14229. cur_item++;
  14230. cur_start = 0;
  14231. }
  14232. return true;
  14233. } else {
  14234. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14235. sink.done();
  14236. return true;
  14237. }
  14238. };
  14239. }
  14240. inline bool ClientImpl::process_socket(
  14241. const Socket &socket,
  14242. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14243. std::function<bool(Stream &strm)> callback) {
  14244. return detail::process_client_socket(
  14245. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14246. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14247. }
  14248. inline bool ClientImpl::is_ssl() const { return false; }
  14249. inline Result ClientImpl::Get(const std::string &path,
  14250. DownloadProgress progress) {
  14251. return Get(path, Headers(), std::move(progress));
  14252. }
  14253. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14254. DownloadProgress progress) {
  14255. return Get(path, params, Headers(), std::move(progress));
  14256. }
  14257. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14258. const Headers &headers,
  14259. DownloadProgress progress) {
  14260. if (params.empty()) { return Get(path, headers); }
  14261. std::string path_with_query = append_query_params(path, params);
  14262. return Get(path_with_query, headers, std::move(progress));
  14263. }
  14264. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14265. DownloadProgress progress) {
  14266. Request req;
  14267. req.method = "GET";
  14268. req.path = path;
  14269. req.headers = headers;
  14270. req.download_progress = std::move(progress);
  14271. if (max_timeout_msec_ > 0) {
  14272. req.start_time_ = std::chrono::steady_clock::now();
  14273. }
  14274. return send_(std::move(req));
  14275. }
  14276. inline Result ClientImpl::Get(const std::string &path,
  14277. ContentReceiver content_receiver,
  14278. DownloadProgress progress) {
  14279. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14280. std::move(progress));
  14281. }
  14282. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14283. ContentReceiver content_receiver,
  14284. DownloadProgress progress) {
  14285. return Get(path, headers, nullptr, std::move(content_receiver),
  14286. std::move(progress));
  14287. }
  14288. inline Result ClientImpl::Get(const std::string &path,
  14289. ResponseHandler response_handler,
  14290. ContentReceiver content_receiver,
  14291. DownloadProgress progress) {
  14292. return Get(path, Headers(), std::move(response_handler),
  14293. std::move(content_receiver), std::move(progress));
  14294. }
  14295. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14296. ResponseHandler response_handler,
  14297. ContentReceiver content_receiver,
  14298. DownloadProgress progress) {
  14299. Request req;
  14300. req.method = "GET";
  14301. req.path = path;
  14302. req.headers = headers;
  14303. req.response_handler = std::move(response_handler);
  14304. req.content_receiver =
  14305. [content_receiver](const char *data, size_t data_length,
  14306. size_t /*offset*/, size_t /*total_length*/) {
  14307. return content_receiver(data, data_length);
  14308. };
  14309. req.download_progress = std::move(progress);
  14310. if (max_timeout_msec_ > 0) {
  14311. req.start_time_ = std::chrono::steady_clock::now();
  14312. }
  14313. return send_(std::move(req));
  14314. }
  14315. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14316. const Headers &headers,
  14317. ContentReceiver content_receiver,
  14318. DownloadProgress progress) {
  14319. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14320. std::move(progress));
  14321. }
  14322. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14323. const Headers &headers,
  14324. ResponseHandler response_handler,
  14325. ContentReceiver content_receiver,
  14326. DownloadProgress progress) {
  14327. if (params.empty()) {
  14328. return Get(path, headers, std::move(response_handler),
  14329. std::move(content_receiver), std::move(progress));
  14330. }
  14331. std::string path_with_query = append_query_params(path, params);
  14332. return Get(path_with_query, headers, std::move(response_handler),
  14333. std::move(content_receiver), std::move(progress));
  14334. }
  14335. inline Result ClientImpl::Head(const std::string &path) {
  14336. return Head(path, Headers());
  14337. }
  14338. inline Result ClientImpl::Head(const std::string &path,
  14339. const Headers &headers) {
  14340. Request req;
  14341. req.method = "HEAD";
  14342. req.headers = headers;
  14343. req.path = path;
  14344. if (max_timeout_msec_ > 0) {
  14345. req.start_time_ = std::chrono::steady_clock::now();
  14346. }
  14347. return send_(std::move(req));
  14348. }
  14349. inline Result ClientImpl::Post(const std::string &path) {
  14350. return Post(path, std::string(), std::string());
  14351. }
  14352. inline Result ClientImpl::Post(const std::string &path,
  14353. const Headers &headers) {
  14354. return Post(path, headers, nullptr, 0, std::string());
  14355. }
  14356. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14357. size_t content_length,
  14358. const std::string &content_type,
  14359. UploadProgress progress) {
  14360. return Post(path, Headers(), body, content_length, content_type, progress);
  14361. }
  14362. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14363. const std::string &content_type,
  14364. UploadProgress progress) {
  14365. return Post(path, Headers(), body, content_type, progress);
  14366. }
  14367. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14368. return Post(path, Headers(), params);
  14369. }
  14370. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14371. ContentProvider content_provider,
  14372. const std::string &content_type,
  14373. UploadProgress progress) {
  14374. return Post(path, Headers(), content_length, std::move(content_provider),
  14375. content_type, progress);
  14376. }
  14377. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14378. ContentProvider content_provider,
  14379. const std::string &content_type,
  14380. ContentReceiver content_receiver,
  14381. UploadProgress progress) {
  14382. return Post(path, Headers(), content_length, std::move(content_provider),
  14383. content_type, std::move(content_receiver), progress);
  14384. }
  14385. inline Result ClientImpl::Post(const std::string &path,
  14386. ContentProviderWithoutLength content_provider,
  14387. const std::string &content_type,
  14388. UploadProgress progress) {
  14389. return Post(path, Headers(), std::move(content_provider), content_type,
  14390. progress);
  14391. }
  14392. inline Result ClientImpl::Post(const std::string &path,
  14393. ContentProviderWithoutLength content_provider,
  14394. const std::string &content_type,
  14395. ContentReceiver content_receiver,
  14396. UploadProgress progress) {
  14397. return Post(path, Headers(), std::move(content_provider), content_type,
  14398. std::move(content_receiver), progress);
  14399. }
  14400. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14401. const Params &params) {
  14402. auto query = detail::params_to_query_str(params);
  14403. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14404. }
  14405. inline Result ClientImpl::Post(const std::string &path,
  14406. const UploadFormDataItems &items,
  14407. UploadProgress progress) {
  14408. return Post(path, Headers(), items, progress);
  14409. }
  14410. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14411. const UploadFormDataItems &items,
  14412. UploadProgress progress) {
  14413. const auto &boundary = detail::make_multipart_data_boundary();
  14414. const auto &content_type =
  14415. detail::serialize_multipart_formdata_get_content_type(boundary);
  14416. auto content_length = detail::get_multipart_content_length(items, boundary);
  14417. return Post(path, headers, content_length,
  14418. detail::make_multipart_content_provider(items, boundary),
  14419. content_type, progress);
  14420. }
  14421. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14422. const UploadFormDataItems &items,
  14423. const std::string &boundary,
  14424. UploadProgress progress) {
  14425. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14426. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14427. }
  14428. const auto &content_type =
  14429. detail::serialize_multipart_formdata_get_content_type(boundary);
  14430. auto content_length = detail::get_multipart_content_length(items, boundary);
  14431. return Post(path, headers, content_length,
  14432. detail::make_multipart_content_provider(items, boundary),
  14433. content_type, progress);
  14434. }
  14435. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14436. const char *body, size_t content_length,
  14437. const std::string &content_type,
  14438. UploadProgress progress) {
  14439. return send_with_content_provider_and_receiver(
  14440. "POST", path, headers, body, content_length, nullptr, nullptr,
  14441. content_type, nullptr, progress);
  14442. }
  14443. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14444. const std::string &body,
  14445. const std::string &content_type,
  14446. UploadProgress progress) {
  14447. return send_with_content_provider_and_receiver(
  14448. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14449. content_type, nullptr, progress);
  14450. }
  14451. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14452. size_t content_length,
  14453. ContentProvider content_provider,
  14454. const std::string &content_type,
  14455. UploadProgress progress) {
  14456. return send_with_content_provider_and_receiver(
  14457. "POST", path, headers, nullptr, content_length,
  14458. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14459. }
  14460. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14461. size_t content_length,
  14462. ContentProvider content_provider,
  14463. const std::string &content_type,
  14464. ContentReceiver content_receiver,
  14465. DownloadProgress progress) {
  14466. return send_with_content_provider_and_receiver(
  14467. "POST", path, headers, nullptr, content_length,
  14468. std::move(content_provider), nullptr, content_type,
  14469. std::move(content_receiver), std::move(progress));
  14470. }
  14471. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14472. ContentProviderWithoutLength content_provider,
  14473. const std::string &content_type,
  14474. UploadProgress progress) {
  14475. return send_with_content_provider_and_receiver(
  14476. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14477. content_type, nullptr, progress);
  14478. }
  14479. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14480. ContentProviderWithoutLength content_provider,
  14481. const std::string &content_type,
  14482. ContentReceiver content_receiver,
  14483. DownloadProgress progress) {
  14484. return send_with_content_provider_and_receiver(
  14485. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14486. content_type, std::move(content_receiver), std::move(progress));
  14487. }
  14488. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14489. const UploadFormDataItems &items,
  14490. const FormDataProviderItems &provider_items,
  14491. UploadProgress progress) {
  14492. const auto &boundary = detail::make_multipart_data_boundary();
  14493. const auto &content_type =
  14494. detail::serialize_multipart_formdata_get_content_type(boundary);
  14495. return send_with_content_provider_and_receiver(
  14496. "POST", path, headers, nullptr, 0, nullptr,
  14497. get_multipart_content_provider(boundary, items, provider_items),
  14498. content_type, nullptr, progress);
  14499. }
  14500. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14501. const std::string &body,
  14502. const std::string &content_type,
  14503. ContentReceiver content_receiver,
  14504. DownloadProgress progress) {
  14505. Request req;
  14506. req.method = "POST";
  14507. req.path = path;
  14508. req.headers = headers;
  14509. req.body = body;
  14510. req.content_receiver =
  14511. [content_receiver](const char *data, size_t data_length,
  14512. size_t /*offset*/, size_t /*total_length*/) {
  14513. return content_receiver(data, data_length);
  14514. };
  14515. req.download_progress = std::move(progress);
  14516. if (max_timeout_msec_ > 0) {
  14517. req.start_time_ = std::chrono::steady_clock::now();
  14518. }
  14519. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14520. return send_(std::move(req));
  14521. }
  14522. inline Result ClientImpl::Put(const std::string &path) {
  14523. return Put(path, std::string(), std::string());
  14524. }
  14525. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14526. return Put(path, headers, nullptr, 0, std::string());
  14527. }
  14528. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14529. size_t content_length,
  14530. const std::string &content_type,
  14531. UploadProgress progress) {
  14532. return Put(path, Headers(), body, content_length, content_type, progress);
  14533. }
  14534. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14535. const std::string &content_type,
  14536. UploadProgress progress) {
  14537. return Put(path, Headers(), body, content_type, progress);
  14538. }
  14539. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14540. return Put(path, Headers(), params);
  14541. }
  14542. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14543. ContentProvider content_provider,
  14544. const std::string &content_type,
  14545. UploadProgress progress) {
  14546. return Put(path, Headers(), content_length, std::move(content_provider),
  14547. content_type, progress);
  14548. }
  14549. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14550. ContentProvider content_provider,
  14551. const std::string &content_type,
  14552. ContentReceiver content_receiver,
  14553. UploadProgress progress) {
  14554. return Put(path, Headers(), content_length, std::move(content_provider),
  14555. content_type, std::move(content_receiver), progress);
  14556. }
  14557. inline Result ClientImpl::Put(const std::string &path,
  14558. ContentProviderWithoutLength content_provider,
  14559. const std::string &content_type,
  14560. UploadProgress progress) {
  14561. return Put(path, Headers(), std::move(content_provider), content_type,
  14562. progress);
  14563. }
  14564. inline Result ClientImpl::Put(const std::string &path,
  14565. ContentProviderWithoutLength content_provider,
  14566. const std::string &content_type,
  14567. ContentReceiver content_receiver,
  14568. UploadProgress progress) {
  14569. return Put(path, Headers(), std::move(content_provider), content_type,
  14570. std::move(content_receiver), progress);
  14571. }
  14572. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14573. const Params &params) {
  14574. auto query = detail::params_to_query_str(params);
  14575. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14576. }
  14577. inline Result ClientImpl::Put(const std::string &path,
  14578. const UploadFormDataItems &items,
  14579. UploadProgress progress) {
  14580. return Put(path, Headers(), items, progress);
  14581. }
  14582. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14583. const UploadFormDataItems &items,
  14584. UploadProgress progress) {
  14585. const auto &boundary = detail::make_multipart_data_boundary();
  14586. const auto &content_type =
  14587. detail::serialize_multipart_formdata_get_content_type(boundary);
  14588. auto content_length = detail::get_multipart_content_length(items, boundary);
  14589. return Put(path, headers, content_length,
  14590. detail::make_multipart_content_provider(items, boundary),
  14591. content_type, progress);
  14592. }
  14593. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14594. const UploadFormDataItems &items,
  14595. const std::string &boundary,
  14596. UploadProgress progress) {
  14597. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14598. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14599. }
  14600. const auto &content_type =
  14601. detail::serialize_multipart_formdata_get_content_type(boundary);
  14602. auto content_length = detail::get_multipart_content_length(items, boundary);
  14603. return Put(path, headers, content_length,
  14604. detail::make_multipart_content_provider(items, boundary),
  14605. content_type, progress);
  14606. }
  14607. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14608. const char *body, size_t content_length,
  14609. const std::string &content_type,
  14610. UploadProgress progress) {
  14611. return send_with_content_provider_and_receiver(
  14612. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14613. content_type, nullptr, progress);
  14614. }
  14615. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14616. const std::string &body,
  14617. const std::string &content_type,
  14618. UploadProgress progress) {
  14619. return send_with_content_provider_and_receiver(
  14620. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14621. content_type, nullptr, progress);
  14622. }
  14623. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14624. size_t content_length,
  14625. ContentProvider content_provider,
  14626. const std::string &content_type,
  14627. UploadProgress progress) {
  14628. return send_with_content_provider_and_receiver(
  14629. "PUT", path, headers, nullptr, content_length,
  14630. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14631. }
  14632. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14633. size_t content_length,
  14634. ContentProvider content_provider,
  14635. const std::string &content_type,
  14636. ContentReceiver content_receiver,
  14637. UploadProgress progress) {
  14638. return send_with_content_provider_and_receiver(
  14639. "PUT", path, headers, nullptr, content_length,
  14640. std::move(content_provider), nullptr, content_type,
  14641. std::move(content_receiver), progress);
  14642. }
  14643. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14644. ContentProviderWithoutLength content_provider,
  14645. const std::string &content_type,
  14646. UploadProgress progress) {
  14647. return send_with_content_provider_and_receiver(
  14648. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14649. content_type, nullptr, progress);
  14650. }
  14651. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14652. ContentProviderWithoutLength content_provider,
  14653. const std::string &content_type,
  14654. ContentReceiver content_receiver,
  14655. UploadProgress progress) {
  14656. return send_with_content_provider_and_receiver(
  14657. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14658. content_type, std::move(content_receiver), progress);
  14659. }
  14660. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14661. const UploadFormDataItems &items,
  14662. const FormDataProviderItems &provider_items,
  14663. UploadProgress progress) {
  14664. const auto &boundary = detail::make_multipart_data_boundary();
  14665. const auto &content_type =
  14666. detail::serialize_multipart_formdata_get_content_type(boundary);
  14667. return send_with_content_provider_and_receiver(
  14668. "PUT", path, headers, nullptr, 0, nullptr,
  14669. get_multipart_content_provider(boundary, items, provider_items),
  14670. content_type, nullptr, progress);
  14671. }
  14672. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14673. const std::string &body,
  14674. const std::string &content_type,
  14675. ContentReceiver content_receiver,
  14676. DownloadProgress progress) {
  14677. Request req;
  14678. req.method = "PUT";
  14679. req.path = path;
  14680. req.headers = headers;
  14681. req.body = body;
  14682. req.content_receiver =
  14683. [content_receiver](const char *data, size_t data_length,
  14684. size_t /*offset*/, size_t /*total_length*/) {
  14685. return content_receiver(data, data_length);
  14686. };
  14687. req.download_progress = std::move(progress);
  14688. if (max_timeout_msec_ > 0) {
  14689. req.start_time_ = std::chrono::steady_clock::now();
  14690. }
  14691. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14692. return send_(std::move(req));
  14693. }
  14694. inline Result ClientImpl::Patch(const std::string &path) {
  14695. return Patch(path, std::string(), std::string());
  14696. }
  14697. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14698. UploadProgress progress) {
  14699. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14700. }
  14701. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14702. size_t content_length,
  14703. const std::string &content_type,
  14704. UploadProgress progress) {
  14705. return Patch(path, Headers(), body, content_length, content_type, progress);
  14706. }
  14707. inline Result ClientImpl::Patch(const std::string &path,
  14708. const std::string &body,
  14709. const std::string &content_type,
  14710. UploadProgress progress) {
  14711. return Patch(path, Headers(), body, content_type, progress);
  14712. }
  14713. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14714. return Patch(path, Headers(), params);
  14715. }
  14716. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14717. ContentProvider content_provider,
  14718. const std::string &content_type,
  14719. UploadProgress progress) {
  14720. return Patch(path, Headers(), content_length, std::move(content_provider),
  14721. content_type, progress);
  14722. }
  14723. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14724. ContentProvider content_provider,
  14725. const std::string &content_type,
  14726. ContentReceiver content_receiver,
  14727. UploadProgress progress) {
  14728. return Patch(path, Headers(), content_length, std::move(content_provider),
  14729. content_type, std::move(content_receiver), progress);
  14730. }
  14731. inline Result ClientImpl::Patch(const std::string &path,
  14732. ContentProviderWithoutLength content_provider,
  14733. const std::string &content_type,
  14734. UploadProgress progress) {
  14735. return Patch(path, Headers(), std::move(content_provider), content_type,
  14736. progress);
  14737. }
  14738. inline Result ClientImpl::Patch(const std::string &path,
  14739. ContentProviderWithoutLength content_provider,
  14740. const std::string &content_type,
  14741. ContentReceiver content_receiver,
  14742. UploadProgress progress) {
  14743. return Patch(path, Headers(), std::move(content_provider), content_type,
  14744. std::move(content_receiver), progress);
  14745. }
  14746. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14747. const Params &params) {
  14748. auto query = detail::params_to_query_str(params);
  14749. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14750. }
  14751. inline Result ClientImpl::Patch(const std::string &path,
  14752. const UploadFormDataItems &items,
  14753. UploadProgress progress) {
  14754. return Patch(path, Headers(), items, progress);
  14755. }
  14756. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14757. const UploadFormDataItems &items,
  14758. UploadProgress progress) {
  14759. const auto &boundary = detail::make_multipart_data_boundary();
  14760. const auto &content_type =
  14761. detail::serialize_multipart_formdata_get_content_type(boundary);
  14762. auto content_length = detail::get_multipart_content_length(items, boundary);
  14763. return Patch(path, headers, content_length,
  14764. detail::make_multipart_content_provider(items, boundary),
  14765. content_type, progress);
  14766. }
  14767. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14768. const UploadFormDataItems &items,
  14769. const std::string &boundary,
  14770. UploadProgress progress) {
  14771. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14772. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14773. }
  14774. const auto &content_type =
  14775. detail::serialize_multipart_formdata_get_content_type(boundary);
  14776. auto content_length = detail::get_multipart_content_length(items, boundary);
  14777. return Patch(path, headers, content_length,
  14778. detail::make_multipart_content_provider(items, boundary),
  14779. content_type, progress);
  14780. }
  14781. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14782. const char *body, size_t content_length,
  14783. const std::string &content_type,
  14784. UploadProgress progress) {
  14785. return send_with_content_provider_and_receiver(
  14786. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14787. content_type, nullptr, progress);
  14788. }
  14789. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14790. const std::string &body,
  14791. const std::string &content_type,
  14792. UploadProgress progress) {
  14793. return send_with_content_provider_and_receiver(
  14794. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14795. content_type, nullptr, progress);
  14796. }
  14797. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14798. size_t content_length,
  14799. ContentProvider content_provider,
  14800. const std::string &content_type,
  14801. UploadProgress progress) {
  14802. return send_with_content_provider_and_receiver(
  14803. "PATCH", path, headers, nullptr, content_length,
  14804. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14805. }
  14806. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14807. size_t content_length,
  14808. ContentProvider content_provider,
  14809. const std::string &content_type,
  14810. ContentReceiver content_receiver,
  14811. UploadProgress progress) {
  14812. return send_with_content_provider_and_receiver(
  14813. "PATCH", path, headers, nullptr, content_length,
  14814. std::move(content_provider), nullptr, content_type,
  14815. std::move(content_receiver), progress);
  14816. }
  14817. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14818. ContentProviderWithoutLength content_provider,
  14819. const std::string &content_type,
  14820. UploadProgress progress) {
  14821. return send_with_content_provider_and_receiver(
  14822. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14823. content_type, nullptr, progress);
  14824. }
  14825. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14826. ContentProviderWithoutLength content_provider,
  14827. const std::string &content_type,
  14828. ContentReceiver content_receiver,
  14829. UploadProgress progress) {
  14830. return send_with_content_provider_and_receiver(
  14831. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14832. content_type, std::move(content_receiver), progress);
  14833. }
  14834. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14835. const UploadFormDataItems &items,
  14836. const FormDataProviderItems &provider_items,
  14837. UploadProgress progress) {
  14838. const auto &boundary = detail::make_multipart_data_boundary();
  14839. const auto &content_type =
  14840. detail::serialize_multipart_formdata_get_content_type(boundary);
  14841. return send_with_content_provider_and_receiver(
  14842. "PATCH", path, headers, nullptr, 0, nullptr,
  14843. get_multipart_content_provider(boundary, items, provider_items),
  14844. content_type, nullptr, progress);
  14845. }
  14846. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14847. const std::string &body,
  14848. const std::string &content_type,
  14849. ContentReceiver content_receiver,
  14850. DownloadProgress progress) {
  14851. Request req;
  14852. req.method = "PATCH";
  14853. req.path = path;
  14854. req.headers = headers;
  14855. req.body = body;
  14856. req.content_receiver =
  14857. [content_receiver](const char *data, size_t data_length,
  14858. size_t /*offset*/, size_t /*total_length*/) {
  14859. return content_receiver(data, data_length);
  14860. };
  14861. req.download_progress = std::move(progress);
  14862. if (max_timeout_msec_ > 0) {
  14863. req.start_time_ = std::chrono::steady_clock::now();
  14864. }
  14865. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14866. return send_(std::move(req));
  14867. }
  14868. inline Result ClientImpl::Delete(const std::string &path,
  14869. DownloadProgress progress) {
  14870. return Delete(path, Headers(), std::string(), std::string(), progress);
  14871. }
  14872. inline Result ClientImpl::Delete(const std::string &path,
  14873. const Headers &headers,
  14874. DownloadProgress progress) {
  14875. return Delete(path, headers, std::string(), std::string(), progress);
  14876. }
  14877. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14878. size_t content_length,
  14879. const std::string &content_type,
  14880. DownloadProgress progress) {
  14881. return Delete(path, Headers(), body, content_length, content_type, progress);
  14882. }
  14883. inline Result ClientImpl::Delete(const std::string &path,
  14884. const std::string &body,
  14885. const std::string &content_type,
  14886. DownloadProgress progress) {
  14887. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14888. progress);
  14889. }
  14890. inline Result ClientImpl::Delete(const std::string &path,
  14891. const Headers &headers,
  14892. const std::string &body,
  14893. const std::string &content_type,
  14894. DownloadProgress progress) {
  14895. return Delete(path, headers, body.data(), body.size(), content_type,
  14896. progress);
  14897. }
  14898. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14899. DownloadProgress progress) {
  14900. return Delete(path, Headers(), params, progress);
  14901. }
  14902. inline Result ClientImpl::Delete(const std::string &path,
  14903. const Headers &headers, const Params &params,
  14904. DownloadProgress progress) {
  14905. auto query = detail::params_to_query_str(params);
  14906. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14907. progress);
  14908. }
  14909. inline Result ClientImpl::Delete(const std::string &path,
  14910. const Headers &headers, const char *body,
  14911. size_t content_length,
  14912. const std::string &content_type,
  14913. DownloadProgress progress) {
  14914. Request req;
  14915. req.method = "DELETE";
  14916. req.headers = headers;
  14917. req.path = path;
  14918. req.download_progress = std::move(progress);
  14919. if (max_timeout_msec_ > 0) {
  14920. req.start_time_ = std::chrono::steady_clock::now();
  14921. }
  14922. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14923. req.body.assign(body, content_length);
  14924. return send_(std::move(req));
  14925. }
  14926. inline Result ClientImpl::Options(const std::string &path) {
  14927. return Options(path, Headers());
  14928. }
  14929. inline Result ClientImpl::Options(const std::string &path,
  14930. const Headers &headers) {
  14931. Request req;
  14932. req.method = "OPTIONS";
  14933. req.headers = headers;
  14934. req.path = path;
  14935. if (max_timeout_msec_ > 0) {
  14936. req.start_time_ = std::chrono::steady_clock::now();
  14937. }
  14938. return send_(std::move(req));
  14939. }
  14940. inline void ClientImpl::stop() {
  14941. std::lock_guard<std::mutex> guard(socket_mutex_);
  14942. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14943. // do is to shutdown_socket, so that threads using this socket suddenly
  14944. // discover they can't read/write any more and error out. Everything else
  14945. // (closing the socket, shutting ssl down) is unsafe because these actions
  14946. // are not thread-safe.
  14947. if (socket_requests_in_flight_ > 0) {
  14948. shutdown_socket(socket_);
  14949. // Aside from that, we set a flag for the socket to be closed when we're
  14950. // done.
  14951. socket_should_be_closed_when_request_is_done_ = true;
  14952. return;
  14953. }
  14954. disconnect(/*gracefully=*/true);
  14955. }
  14956. inline std::string ClientImpl::host() const { return host_; }
  14957. inline int ClientImpl::port() const { return port_; }
  14958. inline size_t ClientImpl::is_socket_open() const {
  14959. std::lock_guard<std::mutex> guard(socket_mutex_);
  14960. return socket_.is_open();
  14961. }
  14962. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14963. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14964. connection_timeout_sec_ = sec;
  14965. connection_timeout_usec_ = usec;
  14966. }
  14967. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14968. read_timeout_sec_ = sec;
  14969. read_timeout_usec_ = usec;
  14970. }
  14971. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14972. write_timeout_sec_ = sec;
  14973. write_timeout_usec_ = usec;
  14974. }
  14975. inline void ClientImpl::set_max_timeout(time_t msec) {
  14976. max_timeout_msec_ = msec;
  14977. }
  14978. inline void ClientImpl::set_basic_auth(const std::string &username,
  14979. const std::string &password) {
  14980. basic_auth_username_ = username;
  14981. basic_auth_password_ = password;
  14982. }
  14983. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14984. bearer_token_auth_token_ = token;
  14985. }
  14986. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14987. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14988. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14989. inline void
  14990. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14991. addr_map_ = std::move(addr_map);
  14992. }
  14993. inline void ClientImpl::set_default_headers(Headers headers) {
  14994. default_headers_ = std::move(headers);
  14995. }
  14996. inline void ClientImpl::set_header_writer(
  14997. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14998. header_writer_ = writer;
  14999. }
  15000. inline void ClientImpl::set_address_family(int family) {
  15001. address_family_ = family;
  15002. }
  15003. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15004. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15005. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15006. socket_options_ = std::move(socket_options);
  15007. }
  15008. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15009. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15010. inline void ClientImpl::set_payload_max_length(size_t length) {
  15011. payload_max_length_ = length;
  15012. has_payload_max_length_ = true;
  15013. }
  15014. inline void ClientImpl::set_interface(const std::string &intf) {
  15015. interface_ = intf;
  15016. }
  15017. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15018. proxy_host_ = host;
  15019. proxy_port_ = port;
  15020. std::lock_guard<std::mutex> guard(socket_mutex_);
  15021. disconnect(/*gracefully=*/true);
  15022. }
  15023. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15024. const std::string &password) {
  15025. proxy_basic_auth_username_ = username;
  15026. proxy_basic_auth_password_ = password;
  15027. }
  15028. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15029. proxy_bearer_token_auth_token_ = token;
  15030. }
  15031. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15032. std::vector<detail::NoProxyEntry> parsed;
  15033. parsed.reserve(patterns.size());
  15034. for (const auto &p : patterns) {
  15035. auto trimmed = detail::trim_copy(p);
  15036. if (trimmed.empty()) { continue; }
  15037. detail::NoProxyEntry entry;
  15038. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  15039. parsed.push_back(std::move(entry));
  15040. }
  15041. }
  15042. no_proxy_entries_ = std::move(parsed);
  15043. std::lock_guard<std::mutex> guard(socket_mutex_);
  15044. disconnect(/*gracefully=*/true);
  15045. }
  15046. #ifdef CPPHTTPLIB_SSL_ENABLED
  15047. inline void ClientImpl::set_digest_auth(const std::string &username,
  15048. const std::string &password) {
  15049. digest_auth_username_ = username;
  15050. digest_auth_password_ = password;
  15051. }
  15052. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15053. const std::string &ca_cert_dir_path) {
  15054. ca_cert_file_path_ = ca_cert_file_path;
  15055. ca_cert_dir_path_ = ca_cert_dir_path;
  15056. }
  15057. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15058. const std::string &password) {
  15059. proxy_digest_auth_username_ = username;
  15060. proxy_digest_auth_password_ = password;
  15061. }
  15062. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15063. server_certificate_verification_ = enabled;
  15064. }
  15065. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15066. server_hostname_verification_ = enabled;
  15067. }
  15068. inline void ClientImpl::enable_system_ca(bool enabled) {
  15069. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15070. }
  15071. #endif
  15072. inline void ClientImpl::set_logger(Logger logger) {
  15073. logger_ = std::move(logger);
  15074. }
  15075. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15076. error_logger_ = std::move(error_logger);
  15077. }
  15078. /*
  15079. * SSL/TLS Common Implementation
  15080. */
  15081. inline ClientConnection::~ClientConnection() {
  15082. #ifdef CPPHTTPLIB_SSL_ENABLED
  15083. if (session) {
  15084. tls::shutdown(session, true);
  15085. tls::free_session(session);
  15086. session = nullptr;
  15087. }
  15088. #endif
  15089. if (sock != INVALID_SOCKET) {
  15090. detail::close_socket(sock);
  15091. sock = INVALID_SOCKET;
  15092. }
  15093. }
  15094. // Universal client implementation
  15095. inline Client::Client(const std::string &scheme_host_port)
  15096. : Client(scheme_host_port, std::string(), std::string()) {}
  15097. inline Client::Client(const std::string &scheme_host_port,
  15098. const std::string &client_cert_path,
  15099. const std::string &client_key_path) {
  15100. detail::UrlComponents uc;
  15101. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15102. auto &scheme = uc.scheme;
  15103. #ifdef CPPHTTPLIB_SSL_ENABLED
  15104. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15105. #else
  15106. if (!scheme.empty() && scheme != "http") {
  15107. #endif
  15108. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15109. std::string msg = "'" + scheme + "' scheme is not supported.";
  15110. throw std::invalid_argument(msg);
  15111. #endif
  15112. return;
  15113. }
  15114. auto is_ssl = scheme == "https";
  15115. auto host = std::move(uc.host);
  15116. auto port = is_ssl ? 443 : 80;
  15117. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  15118. if (is_ssl) {
  15119. #ifdef CPPHTTPLIB_SSL_ENABLED
  15120. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15121. client_key_path);
  15122. is_ssl_ = is_ssl;
  15123. #endif
  15124. } else {
  15125. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15126. client_key_path);
  15127. }
  15128. } else {
  15129. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15130. // if port param below changes.
  15131. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15132. client_cert_path, client_key_path);
  15133. }
  15134. }
  15135. inline Client::Client(const std::string &host, int port)
  15136. : Client(host, port, std::string(), std::string()) {}
  15137. inline Client::Client(const std::string &host, int port,
  15138. const std::string &client_cert_path,
  15139. const std::string &client_key_path)
  15140. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15141. client_key_path)) {}
  15142. inline Client::~Client() = default;
  15143. inline bool Client::is_valid() const {
  15144. return cli_ != nullptr && cli_->is_valid();
  15145. }
  15146. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15147. return cli_->Get(path, std::move(progress));
  15148. }
  15149. inline Result Client::Get(const std::string &path, const Headers &headers,
  15150. DownloadProgress progress) {
  15151. return cli_->Get(path, headers, std::move(progress));
  15152. }
  15153. inline Result Client::Get(const std::string &path,
  15154. ContentReceiver content_receiver,
  15155. DownloadProgress progress) {
  15156. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15157. }
  15158. inline Result Client::Get(const std::string &path, const Headers &headers,
  15159. ContentReceiver content_receiver,
  15160. DownloadProgress progress) {
  15161. return cli_->Get(path, headers, std::move(content_receiver),
  15162. std::move(progress));
  15163. }
  15164. inline Result Client::Get(const std::string &path,
  15165. ResponseHandler response_handler,
  15166. ContentReceiver content_receiver,
  15167. DownloadProgress progress) {
  15168. return cli_->Get(path, std::move(response_handler),
  15169. std::move(content_receiver), std::move(progress));
  15170. }
  15171. inline Result Client::Get(const std::string &path, const Headers &headers,
  15172. ResponseHandler response_handler,
  15173. ContentReceiver content_receiver,
  15174. DownloadProgress progress) {
  15175. return cli_->Get(path, headers, std::move(response_handler),
  15176. std::move(content_receiver), std::move(progress));
  15177. }
  15178. inline Result Client::Get(const std::string &path, const Params &params,
  15179. DownloadProgress progress) {
  15180. return cli_->Get(path, params, std::move(progress));
  15181. }
  15182. inline Result Client::Get(const std::string &path, const Params &params,
  15183. const Headers &headers, DownloadProgress progress) {
  15184. return cli_->Get(path, params, headers, std::move(progress));
  15185. }
  15186. inline Result Client::Get(const std::string &path, const Params &params,
  15187. const Headers &headers,
  15188. ContentReceiver content_receiver,
  15189. DownloadProgress progress) {
  15190. return cli_->Get(path, params, headers, std::move(content_receiver),
  15191. std::move(progress));
  15192. }
  15193. inline Result Client::Get(const std::string &path, const Params &params,
  15194. const Headers &headers,
  15195. ResponseHandler response_handler,
  15196. ContentReceiver content_receiver,
  15197. DownloadProgress progress) {
  15198. return cli_->Get(path, params, headers, std::move(response_handler),
  15199. std::move(content_receiver), std::move(progress));
  15200. }
  15201. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15202. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15203. return cli_->Head(path, headers);
  15204. }
  15205. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15206. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15207. return cli_->Post(path, headers);
  15208. }
  15209. inline Result Client::Post(const std::string &path, const char *body,
  15210. size_t content_length,
  15211. const std::string &content_type,
  15212. UploadProgress progress) {
  15213. return cli_->Post(path, body, content_length, content_type, progress);
  15214. }
  15215. inline Result Client::Post(const std::string &path, const Headers &headers,
  15216. const char *body, size_t content_length,
  15217. const std::string &content_type,
  15218. UploadProgress progress) {
  15219. return cli_->Post(path, headers, body, content_length, content_type,
  15220. progress);
  15221. }
  15222. inline Result Client::Post(const std::string &path, const std::string &body,
  15223. const std::string &content_type,
  15224. UploadProgress progress) {
  15225. return cli_->Post(path, body, content_type, progress);
  15226. }
  15227. inline Result Client::Post(const std::string &path, const Headers &headers,
  15228. const std::string &body,
  15229. const std::string &content_type,
  15230. UploadProgress progress) {
  15231. return cli_->Post(path, headers, body, content_type, progress);
  15232. }
  15233. inline Result Client::Post(const std::string &path, size_t content_length,
  15234. ContentProvider content_provider,
  15235. const std::string &content_type,
  15236. UploadProgress progress) {
  15237. return cli_->Post(path, content_length, std::move(content_provider),
  15238. content_type, progress);
  15239. }
  15240. inline Result Client::Post(const std::string &path, size_t content_length,
  15241. ContentProvider content_provider,
  15242. const std::string &content_type,
  15243. ContentReceiver content_receiver,
  15244. UploadProgress progress) {
  15245. return cli_->Post(path, content_length, std::move(content_provider),
  15246. content_type, std::move(content_receiver), progress);
  15247. }
  15248. inline Result Client::Post(const std::string &path,
  15249. ContentProviderWithoutLength content_provider,
  15250. const std::string &content_type,
  15251. UploadProgress progress) {
  15252. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15253. }
  15254. inline Result Client::Post(const std::string &path,
  15255. ContentProviderWithoutLength content_provider,
  15256. const std::string &content_type,
  15257. ContentReceiver content_receiver,
  15258. UploadProgress progress) {
  15259. return cli_->Post(path, std::move(content_provider), content_type,
  15260. std::move(content_receiver), progress);
  15261. }
  15262. inline Result Client::Post(const std::string &path, const Headers &headers,
  15263. size_t content_length,
  15264. ContentProvider content_provider,
  15265. const std::string &content_type,
  15266. UploadProgress progress) {
  15267. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15268. content_type, progress);
  15269. }
  15270. inline Result Client::Post(const std::string &path, const Headers &headers,
  15271. size_t content_length,
  15272. ContentProvider content_provider,
  15273. const std::string &content_type,
  15274. ContentReceiver content_receiver,
  15275. DownloadProgress progress) {
  15276. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15277. content_type, std::move(content_receiver), progress);
  15278. }
  15279. inline Result Client::Post(const std::string &path, const Headers &headers,
  15280. ContentProviderWithoutLength content_provider,
  15281. const std::string &content_type,
  15282. UploadProgress progress) {
  15283. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15284. progress);
  15285. }
  15286. inline Result Client::Post(const std::string &path, const Headers &headers,
  15287. ContentProviderWithoutLength content_provider,
  15288. const std::string &content_type,
  15289. ContentReceiver content_receiver,
  15290. DownloadProgress progress) {
  15291. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15292. std::move(content_receiver), progress);
  15293. }
  15294. inline Result Client::Post(const std::string &path, const Params &params) {
  15295. return cli_->Post(path, params);
  15296. }
  15297. inline Result Client::Post(const std::string &path, const Headers &headers,
  15298. const Params &params) {
  15299. return cli_->Post(path, headers, params);
  15300. }
  15301. inline Result Client::Post(const std::string &path,
  15302. const UploadFormDataItems &items,
  15303. UploadProgress progress) {
  15304. return cli_->Post(path, items, progress);
  15305. }
  15306. inline Result Client::Post(const std::string &path, const Headers &headers,
  15307. const UploadFormDataItems &items,
  15308. UploadProgress progress) {
  15309. return cli_->Post(path, headers, items, progress);
  15310. }
  15311. inline Result Client::Post(const std::string &path, const Headers &headers,
  15312. const UploadFormDataItems &items,
  15313. const std::string &boundary,
  15314. UploadProgress progress) {
  15315. return cli_->Post(path, headers, items, boundary, progress);
  15316. }
  15317. inline Result Client::Post(const std::string &path, const Headers &headers,
  15318. const UploadFormDataItems &items,
  15319. const FormDataProviderItems &provider_items,
  15320. UploadProgress progress) {
  15321. return cli_->Post(path, headers, items, provider_items, progress);
  15322. }
  15323. inline Result Client::Post(const std::string &path, const Headers &headers,
  15324. const std::string &body,
  15325. const std::string &content_type,
  15326. ContentReceiver content_receiver,
  15327. DownloadProgress progress) {
  15328. return cli_->Post(path, headers, body, content_type,
  15329. std::move(content_receiver), progress);
  15330. }
  15331. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15332. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15333. return cli_->Put(path, headers);
  15334. }
  15335. inline Result Client::Put(const std::string &path, const char *body,
  15336. size_t content_length,
  15337. const std::string &content_type,
  15338. UploadProgress progress) {
  15339. return cli_->Put(path, body, content_length, content_type, progress);
  15340. }
  15341. inline Result Client::Put(const std::string &path, const Headers &headers,
  15342. const char *body, size_t content_length,
  15343. const std::string &content_type,
  15344. UploadProgress progress) {
  15345. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15346. }
  15347. inline Result Client::Put(const std::string &path, const std::string &body,
  15348. const std::string &content_type,
  15349. UploadProgress progress) {
  15350. return cli_->Put(path, body, content_type, progress);
  15351. }
  15352. inline Result Client::Put(const std::string &path, const Headers &headers,
  15353. const std::string &body,
  15354. const std::string &content_type,
  15355. UploadProgress progress) {
  15356. return cli_->Put(path, headers, body, content_type, progress);
  15357. }
  15358. inline Result Client::Put(const std::string &path, size_t content_length,
  15359. ContentProvider content_provider,
  15360. const std::string &content_type,
  15361. UploadProgress progress) {
  15362. return cli_->Put(path, content_length, std::move(content_provider),
  15363. content_type, progress);
  15364. }
  15365. inline Result Client::Put(const std::string &path, size_t content_length,
  15366. ContentProvider content_provider,
  15367. const std::string &content_type,
  15368. ContentReceiver content_receiver,
  15369. UploadProgress progress) {
  15370. return cli_->Put(path, content_length, std::move(content_provider),
  15371. content_type, std::move(content_receiver), progress);
  15372. }
  15373. inline Result Client::Put(const std::string &path,
  15374. ContentProviderWithoutLength content_provider,
  15375. const std::string &content_type,
  15376. UploadProgress progress) {
  15377. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15378. }
  15379. inline Result Client::Put(const std::string &path,
  15380. ContentProviderWithoutLength content_provider,
  15381. const std::string &content_type,
  15382. ContentReceiver content_receiver,
  15383. UploadProgress progress) {
  15384. return cli_->Put(path, std::move(content_provider), content_type,
  15385. std::move(content_receiver), progress);
  15386. }
  15387. inline Result Client::Put(const std::string &path, const Headers &headers,
  15388. size_t content_length,
  15389. ContentProvider content_provider,
  15390. const std::string &content_type,
  15391. UploadProgress progress) {
  15392. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15393. content_type, progress);
  15394. }
  15395. inline Result Client::Put(const std::string &path, const Headers &headers,
  15396. size_t content_length,
  15397. ContentProvider content_provider,
  15398. const std::string &content_type,
  15399. ContentReceiver content_receiver,
  15400. UploadProgress progress) {
  15401. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15402. content_type, std::move(content_receiver), progress);
  15403. }
  15404. inline Result Client::Put(const std::string &path, const Headers &headers,
  15405. ContentProviderWithoutLength content_provider,
  15406. const std::string &content_type,
  15407. UploadProgress progress) {
  15408. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15409. progress);
  15410. }
  15411. inline Result Client::Put(const std::string &path, const Headers &headers,
  15412. ContentProviderWithoutLength content_provider,
  15413. const std::string &content_type,
  15414. ContentReceiver content_receiver,
  15415. UploadProgress progress) {
  15416. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15417. std::move(content_receiver), progress);
  15418. }
  15419. inline Result Client::Put(const std::string &path, const Params &params) {
  15420. return cli_->Put(path, params);
  15421. }
  15422. inline Result Client::Put(const std::string &path, const Headers &headers,
  15423. const Params &params) {
  15424. return cli_->Put(path, headers, params);
  15425. }
  15426. inline Result Client::Put(const std::string &path,
  15427. const UploadFormDataItems &items,
  15428. UploadProgress progress) {
  15429. return cli_->Put(path, items, progress);
  15430. }
  15431. inline Result Client::Put(const std::string &path, const Headers &headers,
  15432. const UploadFormDataItems &items,
  15433. UploadProgress progress) {
  15434. return cli_->Put(path, headers, items, progress);
  15435. }
  15436. inline Result Client::Put(const std::string &path, const Headers &headers,
  15437. const UploadFormDataItems &items,
  15438. const std::string &boundary,
  15439. UploadProgress progress) {
  15440. return cli_->Put(path, headers, items, boundary, progress);
  15441. }
  15442. inline Result Client::Put(const std::string &path, const Headers &headers,
  15443. const UploadFormDataItems &items,
  15444. const FormDataProviderItems &provider_items,
  15445. UploadProgress progress) {
  15446. return cli_->Put(path, headers, items, provider_items, progress);
  15447. }
  15448. inline Result Client::Put(const std::string &path, const Headers &headers,
  15449. const std::string &body,
  15450. const std::string &content_type,
  15451. ContentReceiver content_receiver,
  15452. DownloadProgress progress) {
  15453. return cli_->Put(path, headers, body, content_type, content_receiver,
  15454. progress);
  15455. }
  15456. inline Result Client::Patch(const std::string &path) {
  15457. return cli_->Patch(path);
  15458. }
  15459. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15460. return cli_->Patch(path, headers);
  15461. }
  15462. inline Result Client::Patch(const std::string &path, const char *body,
  15463. size_t content_length,
  15464. const std::string &content_type,
  15465. UploadProgress progress) {
  15466. return cli_->Patch(path, body, content_length, content_type, progress);
  15467. }
  15468. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15469. const char *body, size_t content_length,
  15470. const std::string &content_type,
  15471. UploadProgress progress) {
  15472. return cli_->Patch(path, headers, body, content_length, content_type,
  15473. progress);
  15474. }
  15475. inline Result Client::Patch(const std::string &path, const std::string &body,
  15476. const std::string &content_type,
  15477. UploadProgress progress) {
  15478. return cli_->Patch(path, body, content_type, progress);
  15479. }
  15480. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15481. const std::string &body,
  15482. const std::string &content_type,
  15483. UploadProgress progress) {
  15484. return cli_->Patch(path, headers, body, content_type, progress);
  15485. }
  15486. inline Result Client::Patch(const std::string &path, size_t content_length,
  15487. ContentProvider content_provider,
  15488. const std::string &content_type,
  15489. UploadProgress progress) {
  15490. return cli_->Patch(path, content_length, std::move(content_provider),
  15491. content_type, progress);
  15492. }
  15493. inline Result Client::Patch(const std::string &path, size_t content_length,
  15494. ContentProvider content_provider,
  15495. const std::string &content_type,
  15496. ContentReceiver content_receiver,
  15497. UploadProgress progress) {
  15498. return cli_->Patch(path, content_length, std::move(content_provider),
  15499. content_type, std::move(content_receiver), progress);
  15500. }
  15501. inline Result Client::Patch(const std::string &path,
  15502. ContentProviderWithoutLength content_provider,
  15503. const std::string &content_type,
  15504. UploadProgress progress) {
  15505. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15506. }
  15507. inline Result Client::Patch(const std::string &path,
  15508. ContentProviderWithoutLength content_provider,
  15509. const std::string &content_type,
  15510. ContentReceiver content_receiver,
  15511. UploadProgress progress) {
  15512. return cli_->Patch(path, std::move(content_provider), content_type,
  15513. std::move(content_receiver), progress);
  15514. }
  15515. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15516. size_t content_length,
  15517. ContentProvider content_provider,
  15518. const std::string &content_type,
  15519. UploadProgress progress) {
  15520. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15521. content_type, progress);
  15522. }
  15523. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15524. size_t content_length,
  15525. ContentProvider content_provider,
  15526. const std::string &content_type,
  15527. ContentReceiver content_receiver,
  15528. UploadProgress progress) {
  15529. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15530. content_type, std::move(content_receiver), progress);
  15531. }
  15532. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15533. ContentProviderWithoutLength content_provider,
  15534. const std::string &content_type,
  15535. UploadProgress progress) {
  15536. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15537. progress);
  15538. }
  15539. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15540. ContentProviderWithoutLength content_provider,
  15541. const std::string &content_type,
  15542. ContentReceiver content_receiver,
  15543. UploadProgress progress) {
  15544. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15545. std::move(content_receiver), progress);
  15546. }
  15547. inline Result Client::Patch(const std::string &path, const Params &params) {
  15548. return cli_->Patch(path, params);
  15549. }
  15550. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15551. const Params &params) {
  15552. return cli_->Patch(path, headers, params);
  15553. }
  15554. inline Result Client::Patch(const std::string &path,
  15555. const UploadFormDataItems &items,
  15556. UploadProgress progress) {
  15557. return cli_->Patch(path, items, progress);
  15558. }
  15559. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15560. const UploadFormDataItems &items,
  15561. UploadProgress progress) {
  15562. return cli_->Patch(path, headers, items, progress);
  15563. }
  15564. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15565. const UploadFormDataItems &items,
  15566. const std::string &boundary,
  15567. UploadProgress progress) {
  15568. return cli_->Patch(path, headers, items, boundary, progress);
  15569. }
  15570. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15571. const UploadFormDataItems &items,
  15572. const FormDataProviderItems &provider_items,
  15573. UploadProgress progress) {
  15574. return cli_->Patch(path, headers, items, provider_items, progress);
  15575. }
  15576. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15577. const std::string &body,
  15578. const std::string &content_type,
  15579. ContentReceiver content_receiver,
  15580. DownloadProgress progress) {
  15581. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15582. progress);
  15583. }
  15584. inline Result Client::Delete(const std::string &path,
  15585. DownloadProgress progress) {
  15586. return cli_->Delete(path, progress);
  15587. }
  15588. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15589. DownloadProgress progress) {
  15590. return cli_->Delete(path, headers, progress);
  15591. }
  15592. inline Result Client::Delete(const std::string &path, const char *body,
  15593. size_t content_length,
  15594. const std::string &content_type,
  15595. DownloadProgress progress) {
  15596. return cli_->Delete(path, body, content_length, content_type, progress);
  15597. }
  15598. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15599. const char *body, size_t content_length,
  15600. const std::string &content_type,
  15601. DownloadProgress progress) {
  15602. return cli_->Delete(path, headers, body, content_length, content_type,
  15603. progress);
  15604. }
  15605. inline Result Client::Delete(const std::string &path, const std::string &body,
  15606. const std::string &content_type,
  15607. DownloadProgress progress) {
  15608. return cli_->Delete(path, body, content_type, progress);
  15609. }
  15610. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15611. const std::string &body,
  15612. const std::string &content_type,
  15613. DownloadProgress progress) {
  15614. return cli_->Delete(path, headers, body, content_type, progress);
  15615. }
  15616. inline Result Client::Delete(const std::string &path, const Params &params,
  15617. DownloadProgress progress) {
  15618. return cli_->Delete(path, params, progress);
  15619. }
  15620. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15621. const Params &params, DownloadProgress progress) {
  15622. return cli_->Delete(path, headers, params, progress);
  15623. }
  15624. inline Result Client::Options(const std::string &path) {
  15625. return cli_->Options(path);
  15626. }
  15627. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15628. return cli_->Options(path, headers);
  15629. }
  15630. inline ClientImpl::StreamHandle
  15631. Client::open_stream(const std::string &method, const std::string &path,
  15632. const Params &params, const Headers &headers,
  15633. const std::string &body, const std::string &content_type) {
  15634. return cli_->open_stream(method, path, params, headers, body, content_type);
  15635. }
  15636. inline bool Client::send(Request &req, Response &res, Error &error) {
  15637. return cli_->send(req, res, error);
  15638. }
  15639. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15640. inline void Client::stop() { cli_->stop(); }
  15641. inline std::string Client::host() const { return cli_->host(); }
  15642. inline int Client::port() const { return cli_->port(); }
  15643. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15644. inline socket_t Client::socket() const { return cli_->socket(); }
  15645. inline void
  15646. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15647. cli_->set_hostname_addr_map(std::move(addr_map));
  15648. }
  15649. inline void Client::set_default_headers(Headers headers) {
  15650. cli_->set_default_headers(std::move(headers));
  15651. }
  15652. inline void Client::set_header_writer(
  15653. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15654. cli_->set_header_writer(writer);
  15655. }
  15656. inline void Client::set_address_family(int family) {
  15657. cli_->set_address_family(family);
  15658. }
  15659. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15660. inline void Client::set_socket_options(SocketOptions socket_options) {
  15661. cli_->set_socket_options(std::move(socket_options));
  15662. }
  15663. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15664. cli_->set_connection_timeout(sec, usec);
  15665. }
  15666. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15667. cli_->set_read_timeout(sec, usec);
  15668. }
  15669. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15670. cli_->set_write_timeout(sec, usec);
  15671. }
  15672. inline void Client::set_basic_auth(const std::string &username,
  15673. const std::string &password) {
  15674. cli_->set_basic_auth(username, password);
  15675. }
  15676. inline void Client::set_bearer_token_auth(const std::string &token) {
  15677. cli_->set_bearer_token_auth(token);
  15678. }
  15679. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15680. inline void Client::set_follow_location(bool on) {
  15681. cli_->set_follow_location(on);
  15682. }
  15683. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15684. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15685. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15686. inline void Client::set_payload_max_length(size_t length) {
  15687. cli_->set_payload_max_length(length);
  15688. }
  15689. inline void Client::set_interface(const std::string &intf) {
  15690. cli_->set_interface(intf);
  15691. }
  15692. inline void Client::set_proxy(const std::string &host, int port) {
  15693. cli_->set_proxy(host, port);
  15694. }
  15695. inline void Client::set_proxy_basic_auth(const std::string &username,
  15696. const std::string &password) {
  15697. cli_->set_proxy_basic_auth(username, password);
  15698. }
  15699. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15700. cli_->set_proxy_bearer_token_auth(token);
  15701. }
  15702. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15703. cli_->set_no_proxy(patterns);
  15704. }
  15705. inline void Client::set_logger(Logger logger) {
  15706. cli_->set_logger(std::move(logger));
  15707. }
  15708. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15709. cli_->set_error_logger(std::move(error_logger));
  15710. }
  15711. /*
  15712. * Group 6: SSL Server and Client implementation
  15713. */
  15714. #ifdef CPPHTTPLIB_SSL_ENABLED
  15715. // SSL HTTP server implementation
  15716. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15717. const char *client_ca_cert_file_path,
  15718. const char *client_ca_cert_dir_path,
  15719. const char *private_key_password) {
  15720. using namespace tls;
  15721. ctx_ = create_server_context();
  15722. if (!ctx_) { return; }
  15723. // Load server certificate and private key
  15724. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15725. private_key_password)) {
  15726. last_ssl_error_ = static_cast<int>(get_error());
  15727. free_context(ctx_);
  15728. ctx_ = nullptr;
  15729. return;
  15730. }
  15731. // Load client CA certificates for client authentication
  15732. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15733. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15734. client_ca_cert_dir_path)) {
  15735. last_ssl_error_ = static_cast<int>(get_error());
  15736. free_context(ctx_);
  15737. ctx_ = nullptr;
  15738. return;
  15739. }
  15740. // Enable client certificate verification
  15741. set_verify_client(ctx_, true);
  15742. }
  15743. }
  15744. inline SSLServer::SSLServer(const PemMemory &pem) {
  15745. using namespace tls;
  15746. ctx_ = create_server_context();
  15747. if (ctx_) {
  15748. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15749. pem.private_key_password)) {
  15750. last_ssl_error_ = static_cast<int>(get_error());
  15751. free_context(ctx_);
  15752. ctx_ = nullptr;
  15753. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15754. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15755. last_ssl_error_ = static_cast<int>(get_error());
  15756. free_context(ctx_);
  15757. ctx_ = nullptr;
  15758. } else {
  15759. set_verify_client(ctx_, true);
  15760. }
  15761. }
  15762. }
  15763. }
  15764. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15765. using namespace tls;
  15766. ctx_ = create_server_context();
  15767. if (ctx_) {
  15768. if (!setup_callback(ctx_)) {
  15769. free_context(ctx_);
  15770. ctx_ = nullptr;
  15771. }
  15772. }
  15773. }
  15774. inline SSLServer::~SSLServer() {
  15775. if (ctx_) { tls::free_context(ctx_); }
  15776. }
  15777. inline bool SSLServer::is_valid() const {
  15778. return ctx_ != nullptr && Server::is_valid();
  15779. }
  15780. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15781. using namespace tls;
  15782. session_t session = nullptr;
  15783. {
  15784. std::unique_lock<std::mutex> lock(ctx_mutex_);
  15785. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  15786. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15787. if (session) { handshakes_in_progress_++; }
  15788. }
  15789. if (!session) {
  15790. last_ssl_error_ = static_cast<int>(get_error());
  15791. detail::shutdown_socket(sock);
  15792. detail::close_socket(sock);
  15793. return false;
  15794. }
  15795. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15796. bool handshake_done = false;
  15797. bool ret = false;
  15798. bool websocket_upgraded = false;
  15799. auto cleanup = detail::scope_exit([&] {
  15800. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15801. free_session(session);
  15802. detail::shutdown_socket(sock);
  15803. detail::close_socket(sock);
  15804. });
  15805. // Perform TLS accept handshake with timeout
  15806. TlsError tls_err;
  15807. auto accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  15808. read_timeout_usec_, &tls_err);
  15809. {
  15810. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15811. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  15812. }
  15813. if (!accepted) {
  15814. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15815. // Map TlsError to legacy ssl_error for backward compatibility
  15816. if (tls_err.code == ErrorCode::WantRead) {
  15817. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15818. } else if (tls_err.code == ErrorCode::WantWrite) {
  15819. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15820. } else {
  15821. last_ssl_error_ = SSL_ERROR_SSL;
  15822. }
  15823. #else
  15824. last_ssl_error_ = static_cast<int>(get_error());
  15825. #endif
  15826. return false;
  15827. }
  15828. handshake_done = true;
  15829. std::string remote_addr;
  15830. int remote_port = 0;
  15831. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15832. std::string local_addr;
  15833. int local_port = 0;
  15834. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15835. ret = serve_guarded([&]() {
  15836. return detail::process_server_socket_ssl(
  15837. svr_sock_, session, sock, keep_alive_max_count_,
  15838. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15839. write_timeout_sec_, write_timeout_usec_,
  15840. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15841. return process_request(
  15842. strm, remote_addr, remote_port, local_addr, local_port,
  15843. close_connection, connection_closed,
  15844. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15845. });
  15846. });
  15847. return ret;
  15848. }
  15849. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15850. const char *key_pem,
  15851. const char *client_ca_pem,
  15852. const char *password) {
  15853. if (!ctx_) { return false; }
  15854. std::unique_lock<std::mutex> lock(ctx_mutex_);
  15855. updates_pending_++;
  15856. auto se = detail::scope_exit([&] {
  15857. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  15858. });
  15859. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  15860. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15861. return false;
  15862. }
  15863. if (client_ca_pem) {
  15864. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15865. }
  15866. return true;
  15867. }
  15868. // SSL HTTP client implementation
  15869. inline SSLClient::~SSLClient() {
  15870. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15871. // base function rather than the derived function once we get to the
  15872. // base class destructor, and won't free the SSL (causing a leak).
  15873. // This must happen before the context is freed below: some backends
  15874. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15875. // context, so freeing the context first leaves close_notify reading
  15876. // freed memory.
  15877. shutdown_ssl_impl(socket_, true);
  15878. if (ctx_) {
  15879. tls::free_context(ctx_);
  15880. ctx_ = nullptr;
  15881. }
  15882. }
  15883. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15884. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15885. shutdown_ssl_impl(socket, shutdown_gracefully);
  15886. }
  15887. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15888. bool shutdown_gracefully) {
  15889. if (socket.sock == INVALID_SOCKET) {
  15890. assert(socket.ssl == nullptr);
  15891. return;
  15892. }
  15893. if (socket.ssl) {
  15894. tls::shutdown(socket.ssl, shutdown_gracefully);
  15895. {
  15896. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15897. tls::free_session(socket.ssl);
  15898. }
  15899. socket.ssl = nullptr;
  15900. }
  15901. assert(socket.ssl == nullptr);
  15902. }
  15903. inline bool SSLClient::process_socket(
  15904. const Socket &socket,
  15905. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15906. std::function<bool(Stream &strm)> callback) {
  15907. assert(socket.ssl);
  15908. return detail::process_client_socket_ssl(
  15909. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15910. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15911. std::move(callback));
  15912. }
  15913. inline bool SSLClient::is_ssl() const { return true; }
  15914. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15915. if (!is_valid()) {
  15916. error = Error::SSLConnection;
  15917. return false;
  15918. }
  15919. return ClientImpl::create_and_connect_socket(socket, error);
  15920. }
  15921. inline bool SSLClient::setup_proxy_connection(
  15922. Socket &socket,
  15923. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15924. Response &res, bool &success, Error &error) {
  15925. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15926. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15927. return false;
  15928. }
  15929. if (!initialize_ssl(socket, error)) {
  15930. success = false;
  15931. return false;
  15932. }
  15933. return true;
  15934. }
  15935. // Assumes that socket_mutex_ is locked and that there are no requests in
  15936. // flight
  15937. inline bool SSLClient::connect_with_proxy(
  15938. Socket &socket,
  15939. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15940. Response &res, bool &success, Error &error) {
  15941. success = true;
  15942. Response proxy_res;
  15943. if (!detail::process_client_socket(
  15944. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15945. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15946. start_time, [&](Stream &strm) {
  15947. Request req2;
  15948. req2.method = "CONNECT";
  15949. req2.path =
  15950. detail::make_host_and_port_string_always_port(host_, port_);
  15951. if (max_timeout_msec_ > 0) {
  15952. req2.start_time_ = std::chrono::steady_clock::now();
  15953. }
  15954. return process_request(strm, req2, proxy_res, false, error);
  15955. })) {
  15956. // Thread-safe to close everything because we are assuming there are no
  15957. // requests in flight
  15958. shutdown_ssl(socket, true);
  15959. shutdown_socket(socket);
  15960. close_socket(socket);
  15961. success = false;
  15962. return false;
  15963. }
  15964. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15965. if (!proxy_digest_auth_username_.empty() &&
  15966. !proxy_digest_auth_password_.empty()) {
  15967. std::map<std::string, std::string> auth;
  15968. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15969. // Close the current socket and create a new one for the authenticated
  15970. // request
  15971. shutdown_ssl(socket, true);
  15972. shutdown_socket(socket);
  15973. close_socket(socket);
  15974. // Create a new socket for the authenticated CONNECT request
  15975. if (!ensure_socket_connection(socket, error)) {
  15976. success = false;
  15977. output_error_log(error, nullptr);
  15978. return false;
  15979. }
  15980. proxy_res = Response();
  15981. if (!detail::process_client_socket(
  15982. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15983. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15984. start_time, [&](Stream &strm) {
  15985. Request req3;
  15986. req3.method = "CONNECT";
  15987. req3.path = detail::make_host_and_port_string_always_port(
  15988. host_, port_);
  15989. req3.headers.insert(detail::make_digest_authentication_header(
  15990. req3, auth, 1, detail::random_string(10),
  15991. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15992. true));
  15993. if (max_timeout_msec_ > 0) {
  15994. req3.start_time_ = std::chrono::steady_clock::now();
  15995. }
  15996. return process_request(strm, req3, proxy_res, false, error);
  15997. })) {
  15998. // Thread-safe to close everything because we are assuming there are
  15999. // no requests in flight
  16000. shutdown_ssl(socket, true);
  16001. shutdown_socket(socket);
  16002. close_socket(socket);
  16003. success = false;
  16004. return false;
  16005. }
  16006. }
  16007. }
  16008. }
  16009. // If status code is not 200, proxy request is failed.
  16010. // Set error to ProxyConnection and return proxy response
  16011. // as the response of the request
  16012. if (proxy_res.status != StatusCode::OK_200) {
  16013. error = Error::ProxyConnection;
  16014. output_error_log(error, nullptr);
  16015. res = std::move(proxy_res);
  16016. // Thread-safe to close everything because we are assuming there are
  16017. // no requests in flight
  16018. shutdown_ssl(socket, true);
  16019. shutdown_socket(socket);
  16020. close_socket(socket);
  16021. return false;
  16022. }
  16023. return true;
  16024. }
  16025. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16026. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16027. if (is_proxy_enabled_for_host(host_)) { return true; }
  16028. if (!initialize_ssl(socket, error)) {
  16029. shutdown_socket(socket);
  16030. close_socket(socket);
  16031. return false;
  16032. }
  16033. return true;
  16034. }
  16035. // SSL HTTP client implementation
  16036. inline SSLClient::SSLClient(const std::string &host)
  16037. : SSLClient(host, 443, std::string(), std::string()) {}
  16038. inline SSLClient::SSLClient(const std::string &host, int port)
  16039. : SSLClient(host, port, std::string(), std::string()) {}
  16040. inline void SSLClient::init_ctx() {
  16041. ctx_ = tls::create_client_context();
  16042. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16043. }
  16044. inline void SSLClient::reset_ctx_on_error() {
  16045. last_backend_error_ = tls::get_error();
  16046. tls::free_context(ctx_);
  16047. ctx_ = nullptr;
  16048. }
  16049. inline SSLClient::SSLClient(const std::string &host, int port,
  16050. const std::string &client_cert_path,
  16051. const std::string &client_key_path,
  16052. const std::string &private_key_password)
  16053. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16054. init_ctx();
  16055. if (!ctx_) { return; }
  16056. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16057. const char *password =
  16058. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16059. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16060. client_key_path.c_str(), password)) {
  16061. reset_ctx_on_error();
  16062. }
  16063. }
  16064. }
  16065. inline SSLClient::SSLClient(const std::string &host, int port,
  16066. const PemMemory &pem)
  16067. : ClientImpl(host, port) {
  16068. init_ctx();
  16069. if (!ctx_) { return; }
  16070. if (pem.cert_pem && pem.key_pem) {
  16071. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  16072. pem.private_key_password)) {
  16073. reset_ctx_on_error();
  16074. }
  16075. }
  16076. }
  16077. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16078. if (ca_cert_store && ctx_) {
  16079. // set_ca_store takes ownership of ca_cert_store
  16080. tls::set_ca_store(ctx_, ca_cert_store);
  16081. ca_cert_store_set_ = true;
  16082. } else if (ca_cert_store) {
  16083. tls::free_ca_store(ca_cert_store);
  16084. }
  16085. }
  16086. inline void
  16087. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16088. if (!ctx_) { return; }
  16089. server_certificate_verifier_ = verifier;
  16090. tls::set_verify_callback(ctx_, std::move(verifier));
  16091. }
  16092. inline void SSLClient::set_session_verifier(
  16093. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16094. session_verifier_ = std::move(verifier);
  16095. }
  16096. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16097. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16098. enable_windows_cert_verification_ = enabled;
  16099. }
  16100. #endif
  16101. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16102. std::size_t size) {
  16103. if (ctx_ && ca_cert && size > 0) {
  16104. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  16105. tls::load_ca_pem(ctx_, ca_cert, size);
  16106. }
  16107. }
  16108. inline bool SSLClient::load_certs() {
  16109. auto ret = true;
  16110. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16111. // one client is shared across concurrent requests here.
  16112. std::call_once(initialize_cert_, [&]() {
  16113. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16114. ret = detail::load_client_ca_config(
  16115. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  16116. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  16117. last_backend_error_);
  16118. });
  16119. return ret;
  16120. }
  16121. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16122. // Load CA certificates if server verification is enabled
  16123. if (server_certificate_verification_) {
  16124. if (!load_certs()) {
  16125. error = Error::SSLLoadingCerts;
  16126. output_error_log(error, nullptr);
  16127. return false;
  16128. }
  16129. }
  16130. detail::ClientTlsSessionOptions options;
  16131. options.server_hostname_verification = server_hostname_verification_;
  16132. options.session_verifier = session_verifier_;
  16133. options.ctx_mutex = &ctx_mutex_;
  16134. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16135. // Skip Schannel when a custom CA cert is specified, as the Windows
  16136. // certificate store would not know about user-provided CA certificates.
  16137. // Also skip when system CA trust is explicitly disabled.
  16138. options.windows_cert_verification =
  16139. enable_windows_cert_verification_ &&
  16140. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16141. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16142. // Only a verifier set through set_server_certificate_verifier() is seen
  16143. // here, not one installed with tls::set_verify_callback() directly.
  16144. options.server_certificate_verifier_set =
  16145. static_cast<bool>(server_certificate_verifier_);
  16146. #endif
  16147. tls::session_t session = nullptr;
  16148. // Use scope_exit to ensure session is freed on error paths
  16149. bool success = false;
  16150. auto session_guard = detail::scope_exit([&] {
  16151. if (!success) { tls::free_session(session); }
  16152. });
  16153. detail::ClientTlsSessionError tls_error;
  16154. if (!detail::setup_client_tls_session(
  16155. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16156. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16157. options)) {
  16158. error = tls_error.error;
  16159. last_ssl_error_ = tls_error.ssl_error;
  16160. last_backend_error_ = tls_error.backend_error;
  16161. output_error_log(error, nullptr);
  16162. return false;
  16163. }
  16164. success = true;
  16165. socket.ssl = session;
  16166. return true;
  16167. }
  16168. inline void Client::set_digest_auth(const std::string &username,
  16169. const std::string &password) {
  16170. cli_->set_digest_auth(username, password);
  16171. }
  16172. inline void Client::set_proxy_digest_auth(const std::string &username,
  16173. const std::string &password) {
  16174. cli_->set_proxy_digest_auth(username, password);
  16175. }
  16176. inline void Client::enable_server_certificate_verification(bool enabled) {
  16177. cli_->enable_server_certificate_verification(enabled);
  16178. }
  16179. inline void Client::enable_server_hostname_verification(bool enabled) {
  16180. cli_->enable_server_hostname_verification(enabled);
  16181. }
  16182. inline void Client::enable_system_ca(bool enabled) {
  16183. cli_->enable_system_ca(enabled);
  16184. }
  16185. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16186. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16187. if (is_ssl_) {
  16188. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16189. enabled);
  16190. }
  16191. }
  16192. #endif
  16193. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16194. const std::string &ca_cert_dir_path) {
  16195. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16196. }
  16197. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16198. if (is_ssl_) {
  16199. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16200. } else if (ca_cert_store) {
  16201. tls::free_ca_store(ca_cert_store);
  16202. }
  16203. }
  16204. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16205. if (is_ssl_) {
  16206. // Use the PEM-based path so the CA data is retained for redirect transfer
  16207. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16208. }
  16209. }
  16210. inline void
  16211. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16212. if (is_ssl_) {
  16213. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16214. std::move(verifier));
  16215. }
  16216. }
  16217. inline void Client::set_session_verifier(
  16218. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16219. if (is_ssl_) {
  16220. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16221. }
  16222. }
  16223. inline tls::ctx_t Client::tls_context() const {
  16224. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16225. return nullptr;
  16226. }
  16227. #endif // CPPHTTPLIB_SSL_ENABLED
  16228. /*
  16229. * Group 7: TLS abstraction layer - Common API
  16230. */
  16231. #ifdef CPPHTTPLIB_SSL_ENABLED
  16232. namespace tls {
  16233. // Helper for PeerCert construction
  16234. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16235. return PeerCert(get_peer_cert(session));
  16236. }
  16237. namespace impl {
  16238. // Check if a string is an IPv4 address
  16239. inline bool is_ipv4_address(const std::string &str) {
  16240. int dots = 0;
  16241. for (char c : str) {
  16242. if (c == '.') {
  16243. dots++;
  16244. } else if (!detail::is_ascii_digit(c)) {
  16245. return false;
  16246. }
  16247. }
  16248. return dots == 3;
  16249. }
  16250. // Parse IPv4 address string to bytes
  16251. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16252. const char *p = str.c_str();
  16253. for (int i = 0; i < 4; i++) {
  16254. if (i > 0) {
  16255. if (*p != '.') { return false; }
  16256. p++;
  16257. }
  16258. int val = 0;
  16259. int digits = 0;
  16260. while (detail::is_ascii_digit(*p)) {
  16261. val = val * 10 + (*p - '0');
  16262. if (val > 255) { return false; }
  16263. p++;
  16264. digits++;
  16265. }
  16266. if (digits == 0) { return false; }
  16267. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16268. if (digits > 1 && *(p - digits) == '0') { return false; }
  16269. out[i] = static_cast<unsigned char>(val);
  16270. }
  16271. return *p == '\0';
  16272. }
  16273. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16274. // `out` must have room for at least 16 bytes. Returns the address length
  16275. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16276. // literal. Used to match a host against iPAddress SANs the same way the
  16277. // OpenSSL backend does via X509_check_ip.
  16278. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16279. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16280. struct in6_addr addr6 = {};
  16281. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16282. memcpy(out, &addr6, 16);
  16283. return 16;
  16284. }
  16285. return 0;
  16286. }
  16287. #ifdef _WIN32
  16288. // Enumerate Windows system certificates and call callback with DER data
  16289. template <typename Callback>
  16290. inline bool enumerate_windows_system_certs(Callback cb) {
  16291. bool loaded = false;
  16292. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16293. for (auto store_name : store_names) {
  16294. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16295. if (hStore) {
  16296. PCCERT_CONTEXT pContext = nullptr;
  16297. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16298. nullptr) {
  16299. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16300. loaded = true;
  16301. }
  16302. }
  16303. CertCloseStore(hStore, 0);
  16304. }
  16305. }
  16306. return loaded;
  16307. }
  16308. #endif
  16309. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16310. // Enumerate macOS Keychain certificates and call callback with DER data
  16311. template <typename Callback>
  16312. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16313. bool loaded = false;
  16314. const SecTrustSettingsDomain domains[] = {
  16315. kSecTrustSettingsDomainSystem,
  16316. kSecTrustSettingsDomainAdmin,
  16317. kSecTrustSettingsDomainUser,
  16318. };
  16319. for (auto domain : domains) {
  16320. CFArrayRef certs = nullptr;
  16321. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16322. if (status != errSecSuccess || !certs) {
  16323. if (certs) CFRelease(certs);
  16324. continue;
  16325. }
  16326. CFIndex count = CFArrayGetCount(certs);
  16327. for (CFIndex i = 0; i < count; i++) {
  16328. SecCertificateRef cert =
  16329. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16330. CFDataRef data = SecCertificateCopyData(cert);
  16331. if (data) {
  16332. if (cb(CFDataGetBytePtr(data),
  16333. static_cast<size_t>(CFDataGetLength(data)))) {
  16334. loaded = true;
  16335. }
  16336. CFRelease(data);
  16337. }
  16338. }
  16339. CFRelease(certs);
  16340. }
  16341. return loaded;
  16342. }
  16343. #endif
  16344. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16345. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16346. // Common CA certificate file paths on Linux/Unix
  16347. inline const char **system_ca_paths() {
  16348. static const char *paths[] = {
  16349. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16350. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16351. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16352. "/etc/pki/tls/cacert.pem", // OpenELEC
  16353. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16354. nullptr};
  16355. return paths;
  16356. }
  16357. // Common CA certificate directory paths on Linux/Unix
  16358. inline const char **system_ca_dirs() {
  16359. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16360. "/etc/pki/tls/certs", // RHEL/CentOS
  16361. "/usr/share/ca-certificates", // Other
  16362. nullptr};
  16363. return dirs;
  16364. }
  16365. #endif
  16366. } // namespace impl
  16367. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16368. const char *ca_dir) {
  16369. if (!ctx) { return false; }
  16370. bool success = true;
  16371. if (ca_file && *ca_file) {
  16372. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16373. }
  16374. if (ca_dir && *ca_dir) {
  16375. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16376. }
  16377. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16378. // Set CA list for client certificate request (CertificateRequest message)
  16379. if (ca_file && *ca_file) {
  16380. auto list = SSL_load_client_CA_file(ca_file);
  16381. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16382. }
  16383. #endif
  16384. return success;
  16385. }
  16386. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16387. const char *password) {
  16388. return set_client_cert_pem(ctx, cert, key, password);
  16389. }
  16390. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16391. const char *key_path, const char *password) {
  16392. return set_client_cert_file(ctx, cert_path, key_path, password);
  16393. }
  16394. // PeerCert implementation
  16395. inline PeerCert::PeerCert() = default;
  16396. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16397. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16398. other.cert_ = nullptr;
  16399. }
  16400. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16401. if (this != &other) {
  16402. if (cert_) { free_cert(cert_); }
  16403. cert_ = other.cert_;
  16404. other.cert_ = nullptr;
  16405. }
  16406. return *this;
  16407. }
  16408. inline PeerCert::~PeerCert() {
  16409. if (cert_) { free_cert(cert_); }
  16410. }
  16411. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16412. inline std::string PeerCert::subject_cn() const {
  16413. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16414. }
  16415. inline std::string PeerCert::issuer_name() const {
  16416. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16417. }
  16418. inline bool PeerCert::check_hostname(const char *hostname) const {
  16419. return cert_ ? verify_hostname(cert_, hostname) : false;
  16420. }
  16421. inline std::vector<SanEntry> PeerCert::sans() const {
  16422. std::vector<SanEntry> result;
  16423. if (cert_) { get_cert_sans(cert_, result); }
  16424. return result;
  16425. }
  16426. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16427. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16428. }
  16429. inline std::string PeerCert::serial() const {
  16430. return cert_ ? get_cert_serial(cert_) : std::string();
  16431. }
  16432. // VerifyContext method implementations
  16433. inline std::string VerifyContext::subject_cn() const {
  16434. return cert ? get_cert_subject_cn(cert) : std::string();
  16435. }
  16436. inline std::string VerifyContext::issuer_name() const {
  16437. return cert ? get_cert_issuer_name(cert) : std::string();
  16438. }
  16439. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16440. return cert ? verify_hostname(cert, hostname) : false;
  16441. }
  16442. inline std::vector<SanEntry> VerifyContext::sans() const {
  16443. std::vector<SanEntry> result;
  16444. if (cert) { get_cert_sans(cert, result); }
  16445. return result;
  16446. }
  16447. inline bool VerifyContext::validity(time_t &not_before,
  16448. time_t &not_after) const {
  16449. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16450. }
  16451. inline std::string VerifyContext::serial() const {
  16452. return cert ? get_cert_serial(cert) : std::string();
  16453. }
  16454. // TlsError static method implementation
  16455. inline std::string TlsError::verify_error_to_string(long error_code) {
  16456. return verify_error_string(error_code);
  16457. }
  16458. } // namespace tls
  16459. // Request::peer_cert() implementation
  16460. inline tls::PeerCert Request::peer_cert() const {
  16461. return tls::get_peer_cert_from_session(ssl);
  16462. }
  16463. // Request::sni() implementation
  16464. inline std::string Request::sni() const {
  16465. if (!ssl) { return std::string(); }
  16466. const char *s = tls::get_sni(ssl);
  16467. return s ? std::string(s) : std::string();
  16468. }
  16469. #endif // CPPHTTPLIB_SSL_ENABLED
  16470. /*
  16471. * Group 8: TLS abstraction layer - OpenSSL backend
  16472. */
  16473. /*
  16474. * OpenSSL Backend Implementation
  16475. */
  16476. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16477. namespace tls {
  16478. namespace impl {
  16479. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16480. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16481. switch (ssl_error) {
  16482. case SSL_ERROR_NONE: return ErrorCode::Success;
  16483. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16484. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16485. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16486. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16487. case SSL_ERROR_SSL:
  16488. default: return ErrorCode::Fatal;
  16489. }
  16490. }
  16491. // Helper: Create client CA list from PEM string
  16492. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16493. // Caller takes ownership of returned list
  16494. inline STACK_OF(X509_NAME) *
  16495. create_client_ca_list_from_pem(const char *ca_pem) {
  16496. if (!ca_pem) { return nullptr; }
  16497. auto ca_list = sk_X509_NAME_new_null();
  16498. if (!ca_list) { return nullptr; }
  16499. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16500. if (!bio) {
  16501. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16502. return nullptr;
  16503. }
  16504. X509 *cert = nullptr;
  16505. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16506. nullptr) {
  16507. const X509_NAME *name = X509_get_subject_name(cert);
  16508. if (name) {
  16509. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16510. }
  16511. X509_free(cert);
  16512. }
  16513. BIO_free(bio);
  16514. return ca_list;
  16515. }
  16516. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16517. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16518. long /*argl*/, void * /*argp*/) {
  16519. delete static_cast<VerifyCallback *>(ptr);
  16520. }
  16521. // The SSL_CTX owns its verify callback, so each client or server sees only
  16522. // its own, on whichever thread runs the handshake.
  16523. inline int verify_callback_index() {
  16524. static const auto index = SSL_CTX_get_ex_new_index(
  16525. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16526. return index;
  16527. }
  16528. // OpenSSL verify callback wrapper
  16529. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16530. // Get SSL object from X509_STORE_CTX
  16531. auto ssl = static_cast<SSL *>(
  16532. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16533. if (!ssl) { return preverify_ok; }
  16534. auto callback = static_cast<VerifyCallback *>(
  16535. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16536. if (!callback) { return preverify_ok; }
  16537. // Get current certificate and depth
  16538. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16539. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16540. int error = X509_STORE_CTX_get_error(ctx);
  16541. // Build context
  16542. VerifyContext verify_ctx;
  16543. verify_ctx.session = static_cast<session_t>(ssl);
  16544. verify_ctx.cert = static_cast<cert_t>(cert);
  16545. verify_ctx.depth = depth;
  16546. verify_ctx.preverify_ok = (preverify_ok != 0);
  16547. verify_ctx.error_code = error;
  16548. verify_ctx.error_string =
  16549. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16550. return (*callback)(verify_ctx) ? 1 : 0;
  16551. }
  16552. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16553. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16554. // that must be released with release_store_objects
  16555. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16556. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16557. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16558. #endif
  16559. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16560. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16561. return X509_STORE_get1_objects(store);
  16562. #else
  16563. return X509_STORE_get0_objects(store);
  16564. #endif
  16565. }
  16566. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16567. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16568. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16569. #else
  16570. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16571. #endif
  16572. }
  16573. } // namespace impl
  16574. inline ctx_t create_client_context() {
  16575. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16576. if (ctx) {
  16577. // Disable auto-retry to properly handle non-blocking I/O
  16578. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16579. // Set minimum TLS version
  16580. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16581. }
  16582. return static_cast<ctx_t>(ctx);
  16583. }
  16584. inline void free_context(ctx_t ctx) {
  16585. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16586. }
  16587. inline bool set_min_version(ctx_t ctx, Version version) {
  16588. if (!ctx) return false;
  16589. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16590. static_cast<int>(version)) == 1;
  16591. }
  16592. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16593. if (!ctx || !pem || len == 0) return false;
  16594. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16595. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16596. if (!store) return false;
  16597. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16598. if (!bio) return false;
  16599. bool ok = true;
  16600. X509 *cert = nullptr;
  16601. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16602. nullptr) {
  16603. if (X509_STORE_add_cert(store, cert) != 1) {
  16604. // Ignore duplicate errors
  16605. auto err = ERR_peek_last_error();
  16606. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16607. ok = false;
  16608. }
  16609. }
  16610. X509_free(cert);
  16611. if (!ok) break;
  16612. }
  16613. BIO_free(bio);
  16614. // Clear any "no more certificates" errors
  16615. ERR_clear_error();
  16616. return ok;
  16617. }
  16618. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16619. if (!ctx || !file_path) return false;
  16620. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16621. nullptr) == 1;
  16622. }
  16623. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16624. if (!ctx || !dir_path) return false;
  16625. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16626. dir_path) == 1;
  16627. }
  16628. inline bool load_system_certs(ctx_t ctx) {
  16629. if (!ctx) return false;
  16630. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16631. #ifdef _WIN32
  16632. // Windows: Load from system certificate store (ROOT and CA)
  16633. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16634. if (!store) return false;
  16635. bool loaded_any = false;
  16636. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16637. for (auto store_name : store_names) {
  16638. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16639. if (!hStore) continue;
  16640. PCCERT_CONTEXT pContext = nullptr;
  16641. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16642. nullptr) {
  16643. const unsigned char *data = pContext->pbCertEncoded;
  16644. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16645. if (x509) {
  16646. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16647. X509_free(x509);
  16648. }
  16649. }
  16650. CertCloseStore(hStore, 0);
  16651. }
  16652. return loaded_any;
  16653. #elif defined(__APPLE__)
  16654. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16655. // macOS: Load from Keychain
  16656. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16657. if (!store) return false;
  16658. bool loaded_any = false;
  16659. const SecTrustSettingsDomain domains[] = {
  16660. kSecTrustSettingsDomainSystem,
  16661. kSecTrustSettingsDomainAdmin,
  16662. kSecTrustSettingsDomainUser,
  16663. };
  16664. for (auto domain : domains) {
  16665. CFArrayRef certs = nullptr;
  16666. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16667. !certs) {
  16668. if (certs) CFRelease(certs);
  16669. continue;
  16670. }
  16671. auto count = CFArrayGetCount(certs);
  16672. for (CFIndex i = 0; i < count; i++) {
  16673. auto cert = reinterpret_cast<SecCertificateRef>(
  16674. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16675. CFDataRef der = SecCertificateCopyData(cert);
  16676. if (der) {
  16677. const unsigned char *data = CFDataGetBytePtr(der);
  16678. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16679. if (x509) {
  16680. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16681. X509_free(x509);
  16682. }
  16683. CFRelease(der);
  16684. }
  16685. }
  16686. CFRelease(certs);
  16687. }
  16688. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16689. #else
  16690. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16691. #endif
  16692. #else
  16693. // Other Unix: use default verify paths
  16694. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16695. #endif
  16696. }
  16697. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16698. const char *password) {
  16699. if (!ctx || !cert || !key) return false;
  16700. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16701. // Load certificate
  16702. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16703. if (!cert_bio) return false;
  16704. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16705. BIO_free(cert_bio);
  16706. if (!x509) return false;
  16707. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16708. X509_free(x509);
  16709. if (!cert_ok) return false;
  16710. // Load private key
  16711. auto key_bio = BIO_new_mem_buf(key, -1);
  16712. if (!key_bio) return false;
  16713. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16714. password ? const_cast<char *>(password)
  16715. : nullptr);
  16716. BIO_free(key_bio);
  16717. if (!pkey) return false;
  16718. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16719. EVP_PKEY_free(pkey);
  16720. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16721. }
  16722. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16723. const char *key_path, const char *password) {
  16724. if (!ctx || !cert_path || !key_path) return false;
  16725. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16726. if (password && password[0] != '\0') {
  16727. SSL_CTX_set_default_passwd_cb_userdata(
  16728. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16729. }
  16730. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16731. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16732. }
  16733. inline ctx_t create_server_context() {
  16734. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16735. if (ctx) {
  16736. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16737. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16738. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16739. }
  16740. return static_cast<ctx_t>(ctx);
  16741. }
  16742. inline void set_verify_client(ctx_t ctx, bool require) {
  16743. if (!ctx) return;
  16744. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16745. require
  16746. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16747. : SSL_VERIFY_NONE,
  16748. nullptr);
  16749. }
  16750. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16751. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16752. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16753. SSL *ssl = SSL_new(ssl_ctx);
  16754. if (!ssl) return nullptr;
  16755. // Disable auto-retry for proper non-blocking I/O handling
  16756. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16757. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16758. if (!bio) {
  16759. SSL_free(ssl);
  16760. return nullptr;
  16761. }
  16762. SSL_set_bio(ssl, bio, bio);
  16763. return static_cast<session_t>(ssl);
  16764. }
  16765. inline void free_session(session_t session) {
  16766. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16767. }
  16768. inline bool set_sni(session_t session, const char *hostname,
  16769. bool /*verify_hostname*/) {
  16770. if (!session || !hostname) return false;
  16771. auto ssl = static_cast<SSL *>(session);
  16772. // Set SNI (Server Name Indication) only - does not enable verification.
  16773. // OpenSSL never binds identity checking to SNI (that happens post-
  16774. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16775. #if defined(OPENSSL_IS_BORINGSSL)
  16776. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16777. #else
  16778. // Direct call instead of macro to suppress -Wold-style-cast warning
  16779. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16780. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16781. #endif
  16782. }
  16783. inline TlsError connect(session_t session) {
  16784. if (!session) { return TlsError(); }
  16785. auto ssl = static_cast<SSL *>(session);
  16786. auto ret = SSL_connect(ssl);
  16787. TlsError err;
  16788. if (ret == 1) {
  16789. err.code = ErrorCode::Success;
  16790. } else {
  16791. auto ssl_err = SSL_get_error(ssl, ret);
  16792. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16793. err.backend_code = ERR_get_error();
  16794. }
  16795. return err;
  16796. }
  16797. inline TlsError accept(session_t session) {
  16798. if (!session) { return TlsError(); }
  16799. auto ssl = static_cast<SSL *>(session);
  16800. auto ret = SSL_accept(ssl);
  16801. TlsError err;
  16802. if (ret == 1) {
  16803. err.code = ErrorCode::Success;
  16804. } else {
  16805. auto ssl_err = SSL_get_error(ssl, ret);
  16806. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16807. err.backend_code = ERR_get_error();
  16808. }
  16809. return err;
  16810. }
  16811. inline bool connect_nonblocking(session_t session, socket_t sock,
  16812. time_t timeout_sec, time_t timeout_usec,
  16813. TlsError *err) {
  16814. if (!session) {
  16815. if (err) { err->code = ErrorCode::Fatal; }
  16816. return false;
  16817. }
  16818. auto ssl = static_cast<SSL *>(session);
  16819. auto bio = SSL_get_rbio(ssl);
  16820. // Set non-blocking mode for handshake
  16821. detail::set_nonblocking(sock, true);
  16822. if (bio) { BIO_set_nbio(bio, 1); }
  16823. auto cleanup = detail::scope_exit([&]() {
  16824. // Restore blocking mode after handshake
  16825. if (bio) { BIO_set_nbio(bio, 0); }
  16826. detail::set_nonblocking(sock, false);
  16827. });
  16828. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  16829. auto res = 0;
  16830. while ((res = SSL_connect(ssl)) != 1) {
  16831. auto ssl_err = SSL_get_error(ssl, res);
  16832. switch (ssl_err) {
  16833. case SSL_ERROR_WANT_READ:
  16834. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  16835. break;
  16836. case SSL_ERROR_WANT_WRITE:
  16837. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  16838. break;
  16839. default: break;
  16840. }
  16841. if (err) {
  16842. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16843. err->backend_code = ERR_get_error();
  16844. }
  16845. return false;
  16846. }
  16847. if (err) { err->code = ErrorCode::Success; }
  16848. return true;
  16849. }
  16850. inline bool accept_nonblocking(session_t session, socket_t sock,
  16851. time_t timeout_sec, time_t timeout_usec,
  16852. TlsError *err) {
  16853. if (!session) {
  16854. if (err) { err->code = ErrorCode::Fatal; }
  16855. return false;
  16856. }
  16857. auto ssl = static_cast<SSL *>(session);
  16858. auto bio = SSL_get_rbio(ssl);
  16859. // Set non-blocking mode for handshake
  16860. detail::set_nonblocking(sock, true);
  16861. if (bio) { BIO_set_nbio(bio, 1); }
  16862. auto cleanup = detail::scope_exit([&]() {
  16863. // Restore blocking mode after handshake
  16864. if (bio) { BIO_set_nbio(bio, 0); }
  16865. detail::set_nonblocking(sock, false);
  16866. });
  16867. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  16868. auto res = 0;
  16869. while ((res = SSL_accept(ssl)) != 1) {
  16870. auto ssl_err = SSL_get_error(ssl, res);
  16871. switch (ssl_err) {
  16872. case SSL_ERROR_WANT_READ:
  16873. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  16874. break;
  16875. case SSL_ERROR_WANT_WRITE:
  16876. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  16877. break;
  16878. default: break;
  16879. }
  16880. if (err) {
  16881. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16882. err->backend_code = ERR_get_error();
  16883. }
  16884. return false;
  16885. }
  16886. if (err) { err->code = ErrorCode::Success; }
  16887. return true;
  16888. }
  16889. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16890. if (!session || !buf) {
  16891. err.code = ErrorCode::Fatal;
  16892. return -1;
  16893. }
  16894. auto ssl = static_cast<SSL *>(session);
  16895. constexpr auto max_len =
  16896. static_cast<size_t>((std::numeric_limits<int>::max)());
  16897. if (len > max_len) { len = max_len; }
  16898. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16899. if (ret > 0) {
  16900. err.code = ErrorCode::Success;
  16901. return ret;
  16902. }
  16903. auto ssl_err = SSL_get_error(ssl, ret);
  16904. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16905. if (err.code == ErrorCode::PeerClosed) {
  16906. return 0;
  16907. } // Gracefully handle the peer closed state.
  16908. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16909. return -1;
  16910. }
  16911. inline ssize_t write(session_t session, const void *buf, size_t len,
  16912. TlsError &err) {
  16913. if (!session || !buf) {
  16914. err.code = ErrorCode::Fatal;
  16915. return -1;
  16916. }
  16917. auto ssl = static_cast<SSL *>(session);
  16918. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16919. if (ret > 0) {
  16920. err.code = ErrorCode::Success;
  16921. return ret;
  16922. }
  16923. auto ssl_err = SSL_get_error(ssl, ret);
  16924. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16925. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16926. return -1;
  16927. }
  16928. inline int pending(const_session_t session) {
  16929. if (!session) return 0;
  16930. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16931. }
  16932. inline void shutdown(session_t session, bool graceful) {
  16933. if (!session) return;
  16934. auto ssl = static_cast<SSL *>(session);
  16935. if (graceful) {
  16936. // Send close_notify without waiting for the peer's. The connection is
  16937. // closed right after this, so a unidirectional shutdown is enough, and an
  16938. // idle peer that never answers would otherwise hold this thread until the
  16939. // read timeout. The other backends do not wait either.
  16940. SSL_shutdown(ssl);
  16941. }
  16942. }
  16943. inline bool is_peer_closed(session_t session, socket_t sock) {
  16944. if (!session) return true;
  16945. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16946. detail::set_nonblocking(sock, true);
  16947. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16948. auto ssl = static_cast<SSL *>(session);
  16949. char buf;
  16950. auto ret = SSL_peek(ssl, &buf, 1);
  16951. if (ret > 0) return false;
  16952. auto err = SSL_get_error(ssl, ret);
  16953. return err == SSL_ERROR_ZERO_RETURN;
  16954. }
  16955. inline cert_t get_peer_cert(const_session_t session) {
  16956. if (!session) return nullptr;
  16957. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16958. static_cast<SSL *>(const_cast<void *>(session))));
  16959. }
  16960. inline size_t get_peer_certs(const_session_t session,
  16961. std::vector<cert_t> &certs) {
  16962. certs.clear();
  16963. if (!session) { return 0; }
  16964. auto ssl = static_cast<const SSL *>(session);
  16965. // On the server side, the chain leaves out the peer's own certificate
  16966. if (SSL_is_server(ssl)) {
  16967. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  16968. }
  16969. auto sk = SSL_get_peer_cert_chain(ssl);
  16970. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  16971. auto x509 = sk_X509_value(sk, i);
  16972. X509_up_ref(x509);
  16973. certs.push_back(static_cast<cert_t>(x509));
  16974. }
  16975. return certs.size();
  16976. }
  16977. inline void free_cert(cert_t cert) {
  16978. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16979. }
  16980. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16981. if (!cert || !hostname) return false;
  16982. auto x509 = static_cast<X509 *>(cert);
  16983. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16984. if (detail::is_ip_address(hostname)) {
  16985. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16986. }
  16987. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16988. }
  16989. inline uint64_t hostname_mismatch_code() {
  16990. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16991. }
  16992. inline long get_verify_result(const_session_t session) {
  16993. if (!session) return X509_V_ERR_UNSPECIFIED;
  16994. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16995. }
  16996. inline std::string get_cert_subject_cn(cert_t cert) {
  16997. if (!cert) return "";
  16998. auto x509 = static_cast<X509 *>(cert);
  16999. auto subject_name = X509_get_subject_name(x509);
  17000. if (!subject_name) return "";
  17001. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17002. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17003. if (idx < 0) return "";
  17004. auto entry = X509_NAME_get_entry(subject_name, idx);
  17005. if (!entry) return "";
  17006. auto data = X509_NAME_ENTRY_get_data(entry);
  17007. if (!data) return "";
  17008. return std::string(
  17009. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17010. static_cast<size_t>(ASN1_STRING_length(data)));
  17011. }
  17012. inline std::string get_cert_issuer_name(cert_t cert) {
  17013. if (!cert) return "";
  17014. auto x509 = static_cast<X509 *>(cert);
  17015. auto issuer_name = X509_get_issuer_name(x509);
  17016. if (!issuer_name) return "";
  17017. char buf[256];
  17018. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17019. return std::string(buf);
  17020. }
  17021. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17022. sans.clear();
  17023. if (!cert) return false;
  17024. auto x509 = static_cast<X509 *>(cert);
  17025. auto names = static_cast<GENERAL_NAMES *>(
  17026. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17027. if (!names) return true; // No SANs is valid
  17028. auto count = sk_GENERAL_NAME_num(names);
  17029. for (decltype(count) i = 0; i < count; i++) {
  17030. auto gen = sk_GENERAL_NAME_value(names, i);
  17031. if (!gen) continue;
  17032. SanEntry entry;
  17033. switch (gen->type) {
  17034. case GEN_DNS:
  17035. entry.type = SanType::DNS;
  17036. if (gen->d.dNSName) {
  17037. entry.value = std::string(
  17038. reinterpret_cast<const char *>(
  17039. ASN1_STRING_get0_data(gen->d.dNSName)),
  17040. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17041. }
  17042. break;
  17043. case GEN_IPADD:
  17044. entry.type = SanType::IP;
  17045. if (gen->d.iPAddress) {
  17046. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17047. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17048. if (len == 4) {
  17049. // IPv4
  17050. char buf[INET_ADDRSTRLEN];
  17051. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17052. entry.value = buf;
  17053. } else if (len == 16) {
  17054. // IPv6
  17055. char buf[INET6_ADDRSTRLEN];
  17056. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17057. entry.value = buf;
  17058. }
  17059. }
  17060. break;
  17061. case GEN_EMAIL:
  17062. entry.type = SanType::EMAIL;
  17063. if (gen->d.rfc822Name) {
  17064. entry.value = std::string(
  17065. reinterpret_cast<const char *>(
  17066. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17067. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17068. }
  17069. break;
  17070. case GEN_URI:
  17071. entry.type = SanType::URI;
  17072. if (gen->d.uniformResourceIdentifier) {
  17073. entry.value = std::string(
  17074. reinterpret_cast<const char *>(
  17075. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17076. static_cast<size_t>(
  17077. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17078. }
  17079. break;
  17080. default: entry.type = SanType::OTHER; break;
  17081. }
  17082. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17083. }
  17084. GENERAL_NAMES_free(names);
  17085. return true;
  17086. }
  17087. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17088. time_t &not_after) {
  17089. if (!cert) return false;
  17090. auto x509 = static_cast<X509 *>(cert);
  17091. auto nb = X509_get0_notBefore(x509);
  17092. auto na = X509_get0_notAfter(x509);
  17093. if (!nb || !na) return false;
  17094. ASN1_TIME *epoch = ASN1_TIME_new();
  17095. if (!epoch) return false;
  17096. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17097. if (!ASN1_TIME_set(epoch, 0)) return false;
  17098. int pday, psec;
  17099. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17100. not_before = 86400 * (time_t)pday + psec;
  17101. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17102. not_after = 86400 * (time_t)pday + psec;
  17103. return true;
  17104. }
  17105. inline std::string get_cert_serial(cert_t cert) {
  17106. if (!cert) return "";
  17107. auto x509 = static_cast<X509 *>(cert);
  17108. auto serial = X509_get_serialNumber(x509);
  17109. if (!serial) return "";
  17110. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17111. if (!bn) return "";
  17112. auto hex = BN_bn2hex(bn);
  17113. BN_free(bn);
  17114. if (!hex) return "";
  17115. std::string result(hex);
  17116. OPENSSL_free(hex);
  17117. return result;
  17118. }
  17119. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17120. if (!cert) return false;
  17121. auto x509 = static_cast<X509 *>(cert);
  17122. auto len = i2d_X509(x509, nullptr);
  17123. if (len < 0) return false;
  17124. der.resize(static_cast<size_t>(len));
  17125. auto p = der.data();
  17126. i2d_X509(x509, &p);
  17127. return true;
  17128. }
  17129. inline const char *get_sni(const_session_t session) {
  17130. if (!session) return nullptr;
  17131. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17132. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17133. }
  17134. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17135. inline uint64_t get_error() { return ERR_get_error(); }
  17136. inline std::string error_string(uint64_t code) {
  17137. char buf[256];
  17138. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  17139. return std::string(buf);
  17140. }
  17141. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17142. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17143. if (!mem) { return nullptr; }
  17144. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17145. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17146. if (!inf) { return nullptr; }
  17147. auto store = X509_STORE_new();
  17148. if (store) {
  17149. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  17150. auto itmp = sk_X509_INFO_value(inf, i);
  17151. if (!itmp) { continue; }
  17152. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17153. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17154. }
  17155. }
  17156. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17157. return static_cast<ca_store_t>(store);
  17158. }
  17159. inline void free_ca_store(ca_store_t store) {
  17160. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17161. }
  17162. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17163. if (!ctx || !store) { return false; }
  17164. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17165. auto x509_store = static_cast<X509_STORE *>(store);
  17166. // Check if same store is already set
  17167. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17168. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17169. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17170. return true;
  17171. }
  17172. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17173. certs.clear();
  17174. if (!ctx) { return 0; }
  17175. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17176. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17177. if (!store) { return 0; }
  17178. auto objs = impl::get_store_objects(store);
  17179. if (!objs) { return 0; }
  17180. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17181. auto count = sk_X509_OBJECT_num(objs);
  17182. for (decltype(count) i = 0; i < count; i++) {
  17183. auto obj = sk_X509_OBJECT_value(objs, i);
  17184. if (!obj) { continue; }
  17185. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17186. auto x509 = X509_OBJECT_get0_X509(obj);
  17187. if (x509) {
  17188. // Increment reference count so caller can free it
  17189. X509_up_ref(x509);
  17190. certs.push_back(static_cast<cert_t>(x509));
  17191. }
  17192. }
  17193. }
  17194. return certs.size();
  17195. }
  17196. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17197. std::vector<std::string> names;
  17198. if (!ctx) { return names; }
  17199. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17200. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17201. if (!store) { return names; }
  17202. auto objs = impl::get_store_objects(store);
  17203. if (!objs) { return names; }
  17204. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17205. auto count = sk_X509_OBJECT_num(objs);
  17206. for (decltype(count) i = 0; i < count; i++) {
  17207. auto obj = sk_X509_OBJECT_value(objs, i);
  17208. if (!obj) { continue; }
  17209. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17210. auto x509 = X509_OBJECT_get0_X509(obj);
  17211. if (x509) {
  17212. auto subject = X509_get_subject_name(x509);
  17213. if (subject) {
  17214. char buf[512];
  17215. X509_NAME_oneline(subject, buf, sizeof(buf));
  17216. names.push_back(buf);
  17217. }
  17218. }
  17219. }
  17220. }
  17221. return names;
  17222. }
  17223. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17224. const char *key_pem, const char *password) {
  17225. if (!ctx || !cert_pem || !key_pem) { return false; }
  17226. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17227. // Load certificate from PEM
  17228. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17229. if (!cert_bio) { return false; }
  17230. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17231. BIO_free(cert_bio);
  17232. if (!cert) { return false; }
  17233. // Load private key from PEM
  17234. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17235. if (!key_bio) {
  17236. X509_free(cert);
  17237. return false;
  17238. }
  17239. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17240. password ? const_cast<char *>(password)
  17241. : nullptr);
  17242. BIO_free(key_bio);
  17243. if (!key) {
  17244. X509_free(cert);
  17245. return false;
  17246. }
  17247. // Update certificate and key
  17248. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17249. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17250. X509_free(cert);
  17251. EVP_PKEY_free(key);
  17252. return ret;
  17253. }
  17254. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17255. if (!ctx || !ca_pem) { return false; }
  17256. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17257. // Create new X509_STORE from PEM
  17258. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17259. if (!store) { return false; }
  17260. // SSL_CTX_set_cert_store takes ownership
  17261. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17262. // Set client CA list for client certificate request
  17263. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17264. if (ca_list) {
  17265. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17266. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17267. }
  17268. return true;
  17269. }
  17270. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17271. if (!ctx) { return false; }
  17272. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17273. auto index = impl::verify_callback_index();
  17274. if (index < 0) { return false; }
  17275. auto stored = callback ? new VerifyCallback(std::move(callback)) : nullptr;
  17276. delete static_cast<VerifyCallback *>(SSL_CTX_get_ex_data(ssl_ctx, index));
  17277. SSL_CTX_set_ex_data(ssl_ctx, index, stored);
  17278. if (stored) {
  17279. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  17280. } else {
  17281. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  17282. }
  17283. return true;
  17284. }
  17285. inline long get_verify_error(const_session_t session) {
  17286. if (!session) { return -1; }
  17287. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17288. return SSL_get_verify_result(ssl);
  17289. }
  17290. inline std::string verify_error_string(long error_code) {
  17291. if (error_code == X509_V_OK) { return ""; }
  17292. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17293. return str ? str : "unknown error";
  17294. }
  17295. } // namespace tls
  17296. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17297. /*
  17298. * Group 9: TLS abstraction layer - Mbed TLS backend
  17299. */
  17300. /*
  17301. * Mbed TLS Backend Implementation
  17302. */
  17303. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17304. namespace tls {
  17305. namespace impl {
  17306. // Mbed TLS session wrapper
  17307. struct MbedTlsSession {
  17308. mbedtls_ssl_context ssl;
  17309. socket_t sock = INVALID_SOCKET;
  17310. std::string hostname; // For client: set via set_sni
  17311. std::string sni_hostname; // For server: received from client via SNI callback
  17312. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17313. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17314. // (e.g. a response that arrived while this side was still in its post-write
  17315. // check), the byte is pushed back here and served by the next read().
  17316. unsigned char peeked_byte = 0;
  17317. bool has_peeked_byte = false;
  17318. // Set by set_sni() when the caller disabled hostname verification, so the
  17319. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17320. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17321. // OpenSSL and wolfSSL keep them independent).
  17322. bool suppress_hostname_mismatch = false;
  17323. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17324. // ever runs the callback of its own context.
  17325. VerifyCallback verify_callback;
  17326. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17327. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17328. MbedTlsSession(const MbedTlsSession &) = delete;
  17329. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17330. };
  17331. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17332. // queue)
  17333. inline int &mbedtls_last_error() {
  17334. static thread_local int err = 0;
  17335. return err;
  17336. }
  17337. // Helper to map Mbed TLS error to ErrorCode
  17338. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17339. uint32_t verify_flags) {
  17340. if (ret == 0) { return ErrorCode::Success; }
  17341. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17342. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17343. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17344. return ErrorCode::PeerClosed;
  17345. }
  17346. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17347. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17348. out_errno = errno;
  17349. return ErrorCode::SyscallError;
  17350. }
  17351. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17352. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17353. // the handshake's chain verification (see set_sni()); a mismatch there
  17354. // is reported the same way as any other verify_flags bit. Report it as
  17355. // HostnameMismatch, matching the other backends and the post-handshake
  17356. // identity check below, but only when naming is the sole problem -
  17357. // if the chain itself is also untrusted/expired/etc., that takes
  17358. // priority over the naming detail.
  17359. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17360. return ErrorCode::HostnameMismatch;
  17361. }
  17362. return ErrorCode::CertVerifyFailed;
  17363. }
  17364. return ErrorCode::Fatal;
  17365. }
  17366. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17367. // return value, including the verify-flags-dependent HostnameMismatch
  17368. // mapping; shared by connect() and connect_nonblocking() so the
  17369. // backend_code policy for that mapping only lives in one place.
  17370. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17371. int ret) {
  17372. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17373. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17374. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17375. ? static_cast<uint64_t>(verify_flags)
  17376. : static_cast<uint64_t>(-ret);
  17377. }
  17378. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17379. // non-fatal notification delivered between records, not an error and not
  17380. // application data, so I/O calls that see it should just be retried. Kept in
  17381. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17382. // splitting the closing brace across an #if.
  17383. inline bool mbedtls_is_session_ticket(int ret) {
  17384. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17385. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17386. #else
  17387. (void)ret;
  17388. return false;
  17389. #endif
  17390. }
  17391. // BIO-like send callback for Mbed TLS
  17392. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17393. size_t len) {
  17394. auto sock = *static_cast<socket_t *>(ctx);
  17395. #ifdef _WIN32
  17396. auto ret =
  17397. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17398. if (ret == SOCKET_ERROR) {
  17399. int err = WSAGetLastError();
  17400. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17401. return MBEDTLS_ERR_NET_SEND_FAILED;
  17402. }
  17403. #else
  17404. auto ret = send(sock, buf, len, 0);
  17405. if (ret < 0) {
  17406. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17407. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17408. }
  17409. return MBEDTLS_ERR_NET_SEND_FAILED;
  17410. }
  17411. #endif
  17412. return static_cast<int>(ret);
  17413. }
  17414. // BIO-like recv callback for Mbed TLS
  17415. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17416. auto sock = *static_cast<socket_t *>(ctx);
  17417. #ifdef _WIN32
  17418. auto ret =
  17419. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17420. if (ret == SOCKET_ERROR) {
  17421. int err = WSAGetLastError();
  17422. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17423. return MBEDTLS_ERR_NET_RECV_FAILED;
  17424. }
  17425. #else
  17426. auto ret = recv(sock, buf, len, 0);
  17427. if (ret < 0) {
  17428. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17429. return MBEDTLS_ERR_SSL_WANT_READ;
  17430. }
  17431. return MBEDTLS_ERR_NET_RECV_FAILED;
  17432. }
  17433. #endif
  17434. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17435. return static_cast<int>(ret);
  17436. }
  17437. // MbedTlsContext constructor/destructor implementations
  17438. inline MbedTlsContext::MbedTlsContext() {
  17439. mbedtls_ssl_config_init(&conf);
  17440. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17441. mbedtls_entropy_init(&entropy);
  17442. mbedtls_ctr_drbg_init(&ctr_drbg);
  17443. #endif
  17444. mbedtls_x509_crt_init(&ca_chain);
  17445. mbedtls_x509_crt_init(&own_cert);
  17446. mbedtls_pk_init(&own_key);
  17447. }
  17448. inline MbedTlsContext::~MbedTlsContext() {
  17449. mbedtls_pk_free(&own_key);
  17450. mbedtls_x509_crt_free(&own_cert);
  17451. mbedtls_x509_crt_free(&ca_chain);
  17452. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17453. mbedtls_ctr_drbg_free(&ctr_drbg);
  17454. mbedtls_entropy_free(&entropy);
  17455. #endif
  17456. mbedtls_ssl_config_free(&conf);
  17457. }
  17458. // Thread-local storage for SNI captured during handshake
  17459. // This is needed because the SNI callback doesn't have a way to pass
  17460. // session-specific data before the session is fully set up
  17461. inline std::string &mbedpending_sni() {
  17462. static thread_local std::string sni;
  17463. return sni;
  17464. }
  17465. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17466. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17467. const unsigned char *name, size_t name_len) {
  17468. (void)p_ctx;
  17469. (void)ssl;
  17470. // Store SNI name in thread-local storage
  17471. // It will be retrieved and stored in the session after handshake
  17472. if (name && name_len > 0) {
  17473. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17474. } else {
  17475. mbedpending_sni().clear();
  17476. }
  17477. return 0; // Accept any SNI
  17478. }
  17479. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17480. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17481. }
  17482. // Verify callback used when hostname verification is disabled for a session
  17483. // that has no user-supplied verify callback of its own.
  17484. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17485. mbedtls_x509_crt *, int,
  17486. uint32_t *flags) {
  17487. (void)data;
  17488. mbedtls_clear_cn_mismatch(flags);
  17489. return 0;
  17490. }
  17491. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17492. int cert_depth, uint32_t *flags);
  17493. // MbedTLS verify callback wrapper
  17494. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17495. int cert_depth, uint32_t *flags) {
  17496. // data points to the MbedTlsSession
  17497. auto *session = static_cast<MbedTlsSession *>(data);
  17498. // set_sni() disabled hostname verification for this session: drop the
  17499. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17500. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17501. // SNI. The final pass/fail decision still comes from the remaining flags
  17502. // (or, below, from the user's own verify callback).
  17503. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17504. // Build context
  17505. VerifyContext verify_ctx;
  17506. verify_ctx.session = static_cast<session_t>(session);
  17507. verify_ctx.cert = static_cast<cert_t>(crt);
  17508. verify_ctx.depth = cert_depth;
  17509. verify_ctx.preverify_ok = (*flags == 0);
  17510. verify_ctx.error_code = static_cast<long>(*flags);
  17511. // Convert Mbed TLS flags to error string
  17512. static thread_local char error_buf[256];
  17513. if (*flags != 0) {
  17514. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17515. verify_ctx.error_string = error_buf;
  17516. } else {
  17517. verify_ctx.error_string = nullptr;
  17518. }
  17519. bool accepted = session->verify_callback(verify_ctx);
  17520. if (accepted) {
  17521. *flags = 0; // Clear all error flags
  17522. return 0;
  17523. }
  17524. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17525. }
  17526. } // namespace impl
  17527. inline ctx_t create_client_context() {
  17528. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17529. if (!ctx) { return nullptr; }
  17530. ctx->is_server = false;
  17531. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17532. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17533. if (!detail::ensure_mbedtls_psa_crypto()) {
  17534. delete ctx;
  17535. return nullptr;
  17536. }
  17537. int ret;
  17538. #else
  17539. // Seed the random number generator
  17540. const char *pers = "httplib_client";
  17541. int ret = mbedtls_ctr_drbg_seed(
  17542. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17543. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17544. if (ret != 0) {
  17545. impl::mbedtls_last_error() = ret;
  17546. delete ctx;
  17547. return nullptr;
  17548. }
  17549. #endif
  17550. // Set up SSL config for client
  17551. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17552. MBEDTLS_SSL_TRANSPORT_STREAM,
  17553. MBEDTLS_SSL_PRESET_DEFAULT);
  17554. if (ret != 0) {
  17555. impl::mbedtls_last_error() = ret;
  17556. delete ctx;
  17557. return nullptr;
  17558. }
  17559. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17560. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17561. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17562. #endif
  17563. // Default: verify peer certificate
  17564. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17565. // Set minimum TLS version to 1.2
  17566. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17567. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17568. #else
  17569. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17570. MBEDTLS_SSL_MINOR_VERSION_3);
  17571. #endif
  17572. return static_cast<ctx_t>(ctx);
  17573. }
  17574. inline ctx_t create_server_context() {
  17575. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17576. if (!ctx) { return nullptr; }
  17577. ctx->is_server = true;
  17578. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17579. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17580. if (!detail::ensure_mbedtls_psa_crypto()) {
  17581. delete ctx;
  17582. return nullptr;
  17583. }
  17584. int ret;
  17585. #else
  17586. // Seed the random number generator
  17587. const char *pers = "httplib_server";
  17588. int ret = mbedtls_ctr_drbg_seed(
  17589. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17590. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17591. if (ret != 0) {
  17592. impl::mbedtls_last_error() = ret;
  17593. delete ctx;
  17594. return nullptr;
  17595. }
  17596. #endif
  17597. // Set up SSL config for server
  17598. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17599. MBEDTLS_SSL_TRANSPORT_STREAM,
  17600. MBEDTLS_SSL_PRESET_DEFAULT);
  17601. if (ret != 0) {
  17602. impl::mbedtls_last_error() = ret;
  17603. delete ctx;
  17604. return nullptr;
  17605. }
  17606. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17607. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17608. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17609. #endif
  17610. // Default: don't verify client
  17611. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17612. // Set minimum TLS version to 1.2
  17613. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17614. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17615. #else
  17616. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17617. MBEDTLS_SSL_MINOR_VERSION_3);
  17618. #endif
  17619. // Set SNI callback to capture client's SNI hostname
  17620. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17621. return static_cast<ctx_t>(ctx);
  17622. }
  17623. inline void free_context(ctx_t ctx) {
  17624. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17625. }
  17626. inline bool set_min_version(ctx_t ctx, Version version) {
  17627. if (!ctx) { return false; }
  17628. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17629. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17630. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17631. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17632. if (version >= Version::TLS1_3) {
  17633. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17634. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17635. #endif
  17636. }
  17637. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17638. #else
  17639. // Mbed TLS 2.x uses major/minor version numbers
  17640. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17641. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17642. if (version >= Version::TLS1_3) {
  17643. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17644. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17645. #else
  17646. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17647. #endif
  17648. }
  17649. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17650. #endif
  17651. return true;
  17652. }
  17653. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17654. if (!ctx || !pem) { return false; }
  17655. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17656. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17657. // Add null terminator if not present
  17658. std::string pem_str(pem, len);
  17659. int ret = mbedtls_x509_crt_parse(
  17660. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17661. pem_str.size() + 1);
  17662. if (ret != 0) {
  17663. impl::mbedtls_last_error() = ret;
  17664. return false;
  17665. }
  17666. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17667. return true;
  17668. }
  17669. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17670. if (!ctx || !file_path) { return false; }
  17671. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17672. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17673. if (ret != 0) {
  17674. impl::mbedtls_last_error() = ret;
  17675. return false;
  17676. }
  17677. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17678. return true;
  17679. }
  17680. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17681. if (!ctx || !dir_path) { return false; }
  17682. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17683. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17684. if (ret < 0) { // Returns number of certs on success, negative on error
  17685. impl::mbedtls_last_error() = ret;
  17686. return false;
  17687. }
  17688. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17689. return true;
  17690. }
  17691. inline bool load_system_certs(ctx_t ctx) {
  17692. if (!ctx) { return false; }
  17693. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17694. bool loaded = false;
  17695. #ifdef _WIN32
  17696. loaded = impl::enumerate_windows_system_certs(
  17697. [&](const unsigned char *data, size_t len) {
  17698. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17699. });
  17700. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17701. loaded = impl::enumerate_macos_keychain_certs(
  17702. [&](const unsigned char *data, size_t len) {
  17703. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17704. });
  17705. #else
  17706. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17707. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17708. loaded = true;
  17709. break;
  17710. }
  17711. }
  17712. if (!loaded) {
  17713. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17714. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17715. loaded = true;
  17716. break;
  17717. }
  17718. }
  17719. }
  17720. #endif
  17721. if (loaded) {
  17722. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17723. }
  17724. return loaded;
  17725. }
  17726. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17727. const char *password) {
  17728. if (!ctx || !cert || !key) { return false; }
  17729. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17730. // Parse certificate
  17731. std::string cert_str(cert);
  17732. int ret = mbedtls_x509_crt_parse(
  17733. &mctx->own_cert,
  17734. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17735. cert_str.size() + 1);
  17736. if (ret != 0) {
  17737. impl::mbedtls_last_error() = ret;
  17738. return false;
  17739. }
  17740. // Parse private key
  17741. std::string key_str(key);
  17742. const unsigned char *pwd =
  17743. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17744. size_t pwd_len = password ? strlen(password) : 0;
  17745. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17746. ret = mbedtls_pk_parse_key(
  17747. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17748. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17749. &mctx->ctr_drbg);
  17750. #else
  17751. ret = mbedtls_pk_parse_key(
  17752. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17753. key_str.size() + 1, pwd, pwd_len);
  17754. #endif
  17755. if (ret != 0) {
  17756. impl::mbedtls_last_error() = ret;
  17757. return false;
  17758. }
  17759. // Verify that the certificate and private key match.
  17760. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17761. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17762. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17763. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17764. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17765. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17766. #else
  17767. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17768. #endif
  17769. if (ret != 0) {
  17770. impl::mbedtls_last_error() = ret;
  17771. return false;
  17772. }
  17773. #endif
  17774. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17775. if (ret != 0) {
  17776. impl::mbedtls_last_error() = ret;
  17777. return false;
  17778. }
  17779. return true;
  17780. }
  17781. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17782. const char *key_path, const char *password) {
  17783. if (!ctx || !cert_path || !key_path) { return false; }
  17784. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17785. // Parse certificate file
  17786. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17787. if (ret != 0) {
  17788. impl::mbedtls_last_error() = ret;
  17789. return false;
  17790. }
  17791. // Parse private key file
  17792. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17793. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17794. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17795. #else
  17796. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17797. #endif
  17798. if (ret != 0) {
  17799. impl::mbedtls_last_error() = ret;
  17800. return false;
  17801. }
  17802. // Verify that the certificate and private key match.
  17803. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17804. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17805. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17806. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17807. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17808. #else
  17809. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17810. #endif
  17811. if (ret != 0) {
  17812. impl::mbedtls_last_error() = ret;
  17813. return false;
  17814. }
  17815. #endif
  17816. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17817. if (ret != 0) {
  17818. impl::mbedtls_last_error() = ret;
  17819. return false;
  17820. }
  17821. return true;
  17822. }
  17823. inline void set_verify_client(ctx_t ctx, bool require) {
  17824. if (!ctx) { return; }
  17825. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17826. mctx->verify_client = require;
  17827. if (require) {
  17828. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17829. } else {
  17830. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17831. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17832. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->verify_callback
  17833. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17834. : MBEDTLS_SSL_VERIFY_NONE);
  17835. }
  17836. }
  17837. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17838. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17839. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17840. auto session = new (std::nothrow) impl::MbedTlsSession();
  17841. if (!session) { return nullptr; }
  17842. session->sock = sock;
  17843. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17844. if (ret != 0) {
  17845. impl::mbedtls_last_error() = ret;
  17846. delete session;
  17847. return nullptr;
  17848. }
  17849. // Explicitly opt out of in-handshake hostname verification by default;
  17850. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17851. // fails outright when no hostname was set. set_sni() installs the real
  17852. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17853. // caller verifies the certificate identity post-handshake via
  17854. // verify_hostname().
  17855. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17856. // Set BIO callbacks
  17857. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17858. impl::mbedtls_net_recv_cb, nullptr);
  17859. // Set per-session verify callback with session pointer if callback is
  17860. // registered
  17861. session->verify_callback = mctx->verify_callback;
  17862. if (session->verify_callback) {
  17863. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17864. session);
  17865. }
  17866. return static_cast<session_t>(session);
  17867. }
  17868. inline void free_session(session_t session) {
  17869. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17870. }
  17871. inline bool set_sni(session_t session, const char *hostname,
  17872. bool verify_hostname) {
  17873. if (!session || !hostname) { return false; }
  17874. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17875. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17876. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17877. // independently, so a disabled hostname check is handled below by masking
  17878. // the resulting mismatch flag instead of skipping this call.
  17879. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17880. if (ret != 0) {
  17881. impl::mbedtls_last_error() = ret;
  17882. return false;
  17883. }
  17884. msession->hostname = hostname;
  17885. if (!verify_hostname) {
  17886. msession->suppress_hostname_mismatch = true;
  17887. // If a user verify callback is already wired for this session,
  17888. // mbedtls_verify_callback() masks the mismatch flag itself before
  17889. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17890. // here would be redundant. Otherwise install the masking callback alone.
  17891. if (!msession->verify_callback) {
  17892. mbedtls_ssl_set_verify(&msession->ssl,
  17893. impl::mbedtls_mask_hostname_mismatch_callback,
  17894. msession);
  17895. }
  17896. }
  17897. return true;
  17898. }
  17899. inline TlsError connect(session_t session) {
  17900. TlsError err;
  17901. if (!session) {
  17902. err.code = ErrorCode::Fatal;
  17903. return err;
  17904. }
  17905. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17906. int ret;
  17907. do {
  17908. ret = mbedtls_ssl_handshake(&msession->ssl);
  17909. } while (impl::mbedtls_is_session_ticket(ret));
  17910. if (ret == 0) {
  17911. err.code = ErrorCode::Success;
  17912. } else {
  17913. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17914. impl::mbedtls_last_error() = ret;
  17915. }
  17916. return err;
  17917. }
  17918. inline TlsError accept(session_t session) {
  17919. // Same as connect for Mbed TLS - handshake works for both client and server
  17920. auto result = connect(session);
  17921. // After successful handshake, capture SNI from thread-local storage
  17922. if (result.code == ErrorCode::Success && session) {
  17923. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17924. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17925. impl::mbedpending_sni().clear();
  17926. }
  17927. return result;
  17928. }
  17929. inline bool connect_nonblocking(session_t session, socket_t sock,
  17930. time_t timeout_sec, time_t timeout_usec,
  17931. TlsError *err) {
  17932. if (!session) {
  17933. if (err) { err->code = ErrorCode::Fatal; }
  17934. return false;
  17935. }
  17936. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17937. // Set socket to non-blocking mode
  17938. detail::set_nonblocking(sock, true);
  17939. auto cleanup =
  17940. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17941. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17942. int ret;
  17943. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17944. // Non-fatal TLS 1.3 ticket; retry immediately.
  17945. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17946. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17947. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17948. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17949. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17950. }
  17951. // TlsError or timeout
  17952. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17953. impl::mbedtls_last_error() = ret;
  17954. return false;
  17955. }
  17956. if (err) { err->code = ErrorCode::Success; }
  17957. return true;
  17958. }
  17959. inline bool accept_nonblocking(session_t session, socket_t sock,
  17960. time_t timeout_sec, time_t timeout_usec,
  17961. TlsError *err) {
  17962. // Same implementation as connect for Mbed TLS
  17963. bool result =
  17964. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17965. // After successful handshake, capture SNI from thread-local storage
  17966. if (result && session) {
  17967. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17968. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17969. impl::mbedpending_sni().clear();
  17970. }
  17971. return result;
  17972. }
  17973. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17974. if (!session || !buf) {
  17975. err.code = ErrorCode::Fatal;
  17976. return -1;
  17977. }
  17978. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17979. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17980. if (msession->has_peeked_byte) {
  17981. if (len == 0) { return 0; }
  17982. auto p = static_cast<unsigned char *>(buf);
  17983. p[0] = msession->peeked_byte;
  17984. msession->has_peeked_byte = false;
  17985. size_t n = 1;
  17986. // Top up with any already-decrypted bytes without risking a block.
  17987. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17988. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17989. if (extra > 0) { n += static_cast<size_t>(extra); }
  17990. }
  17991. err.code = ErrorCode::Success;
  17992. return static_cast<ssize_t>(n);
  17993. }
  17994. int ret;
  17995. do {
  17996. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17997. len);
  17998. } while (impl::mbedtls_is_session_ticket(ret));
  17999. if (ret > 0) {
  18000. err.code = ErrorCode::Success;
  18001. return static_cast<ssize_t>(ret);
  18002. }
  18003. if (ret == 0) {
  18004. err.code = ErrorCode::PeerClosed;
  18005. return 0;
  18006. }
  18007. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18008. err.backend_code = static_cast<uint64_t>(-ret);
  18009. impl::mbedtls_last_error() = ret;
  18010. // mbedTLS signals a clean close_notify via a negative error code rather
  18011. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18012. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18013. return -1;
  18014. }
  18015. inline ssize_t write(session_t session, const void *buf, size_t len,
  18016. TlsError &err) {
  18017. if (!session || !buf) {
  18018. err.code = ErrorCode::Fatal;
  18019. return -1;
  18020. }
  18021. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18022. int ret;
  18023. do {
  18024. ret = mbedtls_ssl_write(&msession->ssl,
  18025. static_cast<const unsigned char *>(buf), len);
  18026. } while (impl::mbedtls_is_session_ticket(ret));
  18027. if (ret > 0) {
  18028. err.code = ErrorCode::Success;
  18029. return static_cast<ssize_t>(ret);
  18030. }
  18031. if (ret == 0) {
  18032. err.code = ErrorCode::PeerClosed;
  18033. return 0;
  18034. }
  18035. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18036. err.backend_code = static_cast<uint64_t>(-ret);
  18037. impl::mbedtls_last_error() = ret;
  18038. return -1;
  18039. }
  18040. inline int pending(const_session_t session) {
  18041. if (!session) { return 0; }
  18042. auto msession =
  18043. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18044. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18045. (msession->has_peeked_byte ? 1 : 0);
  18046. }
  18047. inline void shutdown(session_t session, bool graceful) {
  18048. if (!session) { return; }
  18049. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18050. if (graceful) {
  18051. // Try to send close_notify, but don't block forever
  18052. int ret;
  18053. int attempts = 0;
  18054. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18055. attempts < 3) {
  18056. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18057. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18058. break;
  18059. }
  18060. attempts++;
  18061. }
  18062. }
  18063. }
  18064. inline bool is_peer_closed(session_t session, socket_t sock) {
  18065. if (!session || sock == INVALID_SOCKET) { return true; }
  18066. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18067. // Check if there's already decrypted or pushed-back data available.
  18068. // If so, the connection is definitely alive.
  18069. if (msession->has_peeked_byte ||
  18070. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18071. return false;
  18072. }
  18073. // Set socket to non-blocking to avoid blocking on read
  18074. detail::set_nonblocking(sock, true);
  18075. auto cleanup =
  18076. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18077. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18078. // on application data — e.g. a response that already arrived — push the
  18079. // byte back so the next read() delivers it instead of losing it.
  18080. unsigned char buf;
  18081. int ret;
  18082. do {
  18083. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18084. } while (impl::mbedtls_is_session_ticket(ret));
  18085. // If we got data or WANT_READ (would block), connection is alive
  18086. if (ret > 0) {
  18087. msession->peeked_byte = buf;
  18088. msession->has_peeked_byte = true;
  18089. return false;
  18090. }
  18091. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18092. // If we get a peer close notify or a connection reset, the peer is closed
  18093. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18094. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18095. }
  18096. inline cert_t get_peer_cert(const_session_t session) {
  18097. if (!session) { return nullptr; }
  18098. auto msession =
  18099. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18100. // Mbed TLS returns a pointer to the internal peer cert chain.
  18101. // WARNING: This pointer is only valid while the session is active.
  18102. // Do not use the certificate after calling free_session().
  18103. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18104. return const_cast<mbedtls_x509_crt *>(cert);
  18105. }
  18106. inline size_t get_peer_certs(const_session_t session,
  18107. std::vector<cert_t> &certs) {
  18108. certs.clear();
  18109. // Mbed TLS parses the whole received chain into a list headed by the peer
  18110. // certificate, owned by the session like get_peer_cert()'s result
  18111. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18112. crt && crt->raw.len > 0; crt = crt->next) {
  18113. certs.push_back(static_cast<cert_t>(crt));
  18114. }
  18115. return certs.size();
  18116. }
  18117. inline void free_cert(cert_t cert) {
  18118. // Mbed TLS: peer certificate is owned by the SSL context.
  18119. // No-op here, but callers should still call this for cross-backend
  18120. // portability.
  18121. (void)cert;
  18122. }
  18123. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18124. if (!cert || !hostname) { return false; }
  18125. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18126. std::string host_str(hostname);
  18127. // Check if hostname is an IP address (IPv4 or IPv6)
  18128. unsigned char ip_bytes[16];
  18129. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18130. auto is_ip = ip_len > 0;
  18131. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18132. // in buf.tag and the raw value in buf.p / buf.len.
  18133. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  18134. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  18135. const unsigned char *p = san->buf.p;
  18136. size_t len = san->buf.len;
  18137. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18138. if (is_ip) {
  18139. // For an IP host, only a matching iPAddress SAN of the same family
  18140. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18141. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18142. memcmp(p, ip_bytes, ip_len) == 0) {
  18143. return true;
  18144. }
  18145. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18146. std::string san_name(reinterpret_cast<const char *>(p), len);
  18147. if (detail::match_hostname(san_name, host_str)) { return true; }
  18148. }
  18149. san = san->next;
  18150. }
  18151. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18152. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18153. // the OpenSSL backend's X509_check_ip behaves the same way).
  18154. if (!is_ip) {
  18155. char cn[256];
  18156. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  18157. if (ret > 0) {
  18158. std::string cn_str(cn);
  18159. // Look for "CN=" in the DN string
  18160. size_t cn_pos = cn_str.find("CN=");
  18161. if (cn_pos != std::string::npos) {
  18162. size_t start = cn_pos + 3;
  18163. size_t end = cn_str.find(',', start);
  18164. std::string cn_value =
  18165. cn_str.substr(start, end == std::string::npos ? end : end - start);
  18166. if (detail::match_hostname(cn_value, host_str)) { return true; }
  18167. }
  18168. }
  18169. }
  18170. return false;
  18171. }
  18172. inline uint64_t hostname_mismatch_code() {
  18173. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18174. }
  18175. inline long get_verify_result(const_session_t session) {
  18176. if (!session) { return -1; }
  18177. auto msession =
  18178. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18179. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18180. // Return 0 (X509_V_OK equivalent) if verification passed
  18181. return flags == 0 ? 0 : static_cast<long>(flags);
  18182. }
  18183. inline std::string get_cert_subject_cn(cert_t cert) {
  18184. if (!cert) return "";
  18185. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18186. // Find the CN in the subject
  18187. const mbedtls_x509_name *name = &x509->subject;
  18188. while (name != nullptr) {
  18189. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18190. return std::string(reinterpret_cast<const char *>(name->val.p),
  18191. name->val.len);
  18192. }
  18193. name = name->next;
  18194. }
  18195. return "";
  18196. }
  18197. inline std::string get_cert_issuer_name(cert_t cert) {
  18198. if (!cert) return "";
  18199. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18200. // Build a human-readable issuer name string
  18201. char buf[512];
  18202. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18203. if (ret < 0) return "";
  18204. return std::string(buf);
  18205. }
  18206. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18207. sans.clear();
  18208. if (!cert) return false;
  18209. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18210. // Parse the Subject Alternative Name extension
  18211. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18212. while (cur != nullptr) {
  18213. if (cur->buf.len > 0) {
  18214. const unsigned char *p = cur->buf.p;
  18215. size_t value_len = cur->buf.len;
  18216. SanEntry entry;
  18217. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18218. case MBEDTLS_X509_SAN_DNS_NAME:
  18219. entry.type = SanType::DNS;
  18220. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18221. break;
  18222. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18223. entry.type = SanType::IP;
  18224. if (value_len == 4) {
  18225. // IPv4
  18226. char buf[16];
  18227. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18228. entry.value = buf;
  18229. } else if (value_len == 16) {
  18230. // IPv6
  18231. char buf[64];
  18232. snprintf(buf, sizeof(buf),
  18233. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18234. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18235. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18236. p[10], p[11], p[12], p[13], p[14], p[15]);
  18237. entry.value = buf;
  18238. }
  18239. break;
  18240. case MBEDTLS_X509_SAN_RFC822_NAME:
  18241. entry.type = SanType::EMAIL;
  18242. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18243. break;
  18244. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18245. entry.type = SanType::URI;
  18246. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18247. break;
  18248. default: entry.type = SanType::OTHER; break;
  18249. }
  18250. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18251. }
  18252. cur = cur->next;
  18253. }
  18254. return true;
  18255. }
  18256. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18257. time_t &not_after) {
  18258. if (!cert) return false;
  18259. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18260. // Convert mbedtls_x509_time to time_t
  18261. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18262. struct tm tm_time = {};
  18263. tm_time.tm_year = t.year - 1900;
  18264. tm_time.tm_mon = t.mon - 1;
  18265. tm_time.tm_mday = t.day;
  18266. tm_time.tm_hour = t.hour;
  18267. tm_time.tm_min = t.min;
  18268. tm_time.tm_sec = t.sec;
  18269. #ifdef _WIN32
  18270. return _mkgmtime(&tm_time);
  18271. #else
  18272. return timegm(&tm_time);
  18273. #endif
  18274. };
  18275. not_before = to_time_t(x509->valid_from);
  18276. not_after = to_time_t(x509->valid_to);
  18277. return true;
  18278. }
  18279. inline std::string get_cert_serial(cert_t cert) {
  18280. if (!cert) return "";
  18281. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18282. // Convert serial number to hex string
  18283. std::string result;
  18284. result.reserve(x509->serial.len * 2);
  18285. for (size_t i = 0; i < x509->serial.len; i++) {
  18286. char hex[3];
  18287. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18288. result += hex;
  18289. }
  18290. return result;
  18291. }
  18292. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18293. if (!cert) return false;
  18294. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18295. if (!crt->raw.p || crt->raw.len == 0) return false;
  18296. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18297. return true;
  18298. }
  18299. inline const char *get_sni(const_session_t session) {
  18300. if (!session) return nullptr;
  18301. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18302. // For server: return SNI received from client during handshake
  18303. if (!msession->sni_hostname.empty()) {
  18304. return msession->sni_hostname.c_str();
  18305. }
  18306. // For client: return the hostname set via set_sni
  18307. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18308. return nullptr;
  18309. }
  18310. inline uint64_t peek_error() {
  18311. // Mbed TLS doesn't have an error queue, return the last error
  18312. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18313. }
  18314. inline uint64_t get_error() {
  18315. // Mbed TLS doesn't have an error queue, return and clear the last error
  18316. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18317. impl::mbedtls_last_error() = 0;
  18318. return err;
  18319. }
  18320. inline std::string error_string(uint64_t code) {
  18321. char buf[256];
  18322. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18323. return std::string(buf);
  18324. }
  18325. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18326. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18327. if (!ca_chain) { return nullptr; }
  18328. mbedtls_x509_crt_init(ca_chain);
  18329. // mbedtls_x509_crt_parse expects null-terminated PEM
  18330. int ret = mbedtls_x509_crt_parse(ca_chain,
  18331. reinterpret_cast<const unsigned char *>(pem),
  18332. len + 1); // +1 for null terminator
  18333. if (ret != 0) {
  18334. // Try without +1 in case PEM is already null-terminated
  18335. ret = mbedtls_x509_crt_parse(
  18336. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18337. if (ret != 0) {
  18338. mbedtls_x509_crt_free(ca_chain);
  18339. delete ca_chain;
  18340. return nullptr;
  18341. }
  18342. }
  18343. return static_cast<ca_store_t>(ca_chain);
  18344. }
  18345. inline void free_ca_store(ca_store_t store) {
  18346. if (store) {
  18347. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18348. mbedtls_x509_crt_free(ca_chain);
  18349. delete ca_chain;
  18350. }
  18351. }
  18352. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18353. if (!ctx || !store) { return false; }
  18354. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18355. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18356. // Free existing CA chain
  18357. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18358. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18359. // Copy the CA chain (deep copy)
  18360. // Parse from the raw data of the source cert
  18361. mbedtls_x509_crt *src = ca_chain;
  18362. while (src != nullptr) {
  18363. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18364. src->raw.len);
  18365. if (ret != 0) {
  18366. free_ca_store(store);
  18367. return false;
  18368. }
  18369. src = src->next;
  18370. }
  18371. // This function takes ownership of the store; the chain was deep-copied
  18372. // above, so release the source
  18373. free_ca_store(store);
  18374. // Update the SSL config to use the new CA chain
  18375. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18376. return true;
  18377. }
  18378. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18379. certs.clear();
  18380. if (!ctx) { return 0; }
  18381. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18382. // Iterate through the CA chain
  18383. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18384. while (cert != nullptr && cert->raw.len > 0) {
  18385. // Create a copy of the certificate for the caller
  18386. auto *copy = new mbedtls_x509_crt;
  18387. mbedtls_x509_crt_init(copy);
  18388. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18389. if (ret == 0) {
  18390. certs.push_back(static_cast<cert_t>(copy));
  18391. } else {
  18392. mbedtls_x509_crt_free(copy);
  18393. delete copy;
  18394. }
  18395. cert = cert->next;
  18396. }
  18397. return certs.size();
  18398. }
  18399. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18400. std::vector<std::string> names;
  18401. if (!ctx) { return names; }
  18402. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18403. // Iterate through the CA chain
  18404. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18405. while (cert != nullptr && cert->raw.len > 0) {
  18406. char buf[512];
  18407. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18408. if (ret > 0) { names.push_back(buf); }
  18409. cert = cert->next;
  18410. }
  18411. return names;
  18412. }
  18413. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18414. const char *key_pem, const char *password) {
  18415. if (!ctx || !cert_pem || !key_pem) { return false; }
  18416. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18417. // Free existing certificate and key
  18418. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18419. mbedtls_pk_free(&mbed_ctx->own_key);
  18420. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18421. mbedtls_pk_init(&mbed_ctx->own_key);
  18422. // Parse certificate PEM
  18423. int ret = mbedtls_x509_crt_parse(
  18424. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18425. strlen(cert_pem) + 1);
  18426. if (ret != 0) {
  18427. impl::mbedtls_last_error() = ret;
  18428. return false;
  18429. }
  18430. // Parse private key PEM
  18431. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18432. ret = mbedtls_pk_parse_key(
  18433. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18434. strlen(key_pem) + 1,
  18435. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18436. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18437. &mbed_ctx->ctr_drbg);
  18438. #else
  18439. ret = mbedtls_pk_parse_key(
  18440. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18441. strlen(key_pem) + 1,
  18442. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18443. password ? strlen(password) : 0);
  18444. #endif
  18445. if (ret != 0) {
  18446. impl::mbedtls_last_error() = ret;
  18447. return false;
  18448. }
  18449. // Configure SSL to use the new certificate and key
  18450. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18451. &mbed_ctx->own_key);
  18452. if (ret != 0) {
  18453. impl::mbedtls_last_error() = ret;
  18454. return false;
  18455. }
  18456. return true;
  18457. }
  18458. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18459. if (!ctx || !ca_pem) { return false; }
  18460. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18461. // Free existing CA chain
  18462. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18463. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18464. // Parse CA PEM
  18465. int ret = mbedtls_x509_crt_parse(
  18466. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18467. strlen(ca_pem) + 1);
  18468. if (ret != 0) {
  18469. impl::mbedtls_last_error() = ret;
  18470. return false;
  18471. }
  18472. // Update SSL config to use new CA chain
  18473. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18474. return true;
  18475. }
  18476. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18477. if (!ctx) { return false; }
  18478. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18479. // create_session() hands each session its own copy to run.
  18480. mbed_ctx->verify_callback = std::move(callback);
  18481. if (mbed_ctx->verify_callback) {
  18482. // Set OPTIONAL mode to ensure callback is called even when verification
  18483. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18484. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18485. }
  18486. return true;
  18487. }
  18488. inline long get_verify_error(const_session_t session) {
  18489. if (!session) { return -1; }
  18490. auto *msession =
  18491. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18492. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18493. }
  18494. inline std::string verify_error_string(long error_code) {
  18495. if (error_code == 0) { return ""; }
  18496. char buf[256];
  18497. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18498. static_cast<uint32_t>(error_code));
  18499. // Remove trailing newline if present
  18500. std::string result(buf);
  18501. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18502. result.pop_back();
  18503. }
  18504. return result;
  18505. }
  18506. } // namespace tls
  18507. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18508. /*
  18509. * Group 10: TLS abstraction layer - wolfSSL backend
  18510. */
  18511. /*
  18512. * wolfSSL Backend Implementation
  18513. */
  18514. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18515. namespace tls {
  18516. namespace impl {
  18517. // wolfSSL session wrapper
  18518. struct WolfSSLSession {
  18519. WOLFSSL *ssl = nullptr;
  18520. socket_t sock = INVALID_SOCKET;
  18521. std::string hostname; // For client: set via set_sni
  18522. std::string sni_hostname; // For server: received from client via SNI callback
  18523. WolfSSLSession() = default;
  18524. ~WolfSSLSession() {
  18525. if (ssl) { wolfSSL_free(ssl); }
  18526. }
  18527. WolfSSLSession(const WolfSSLSession &) = delete;
  18528. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18529. };
  18530. // Thread-local error code accessor for wolfSSL
  18531. inline uint64_t &wolfssl_last_error() {
  18532. static thread_local uint64_t err = 0;
  18533. return err;
  18534. }
  18535. // Helper to map wolfSSL error to ErrorCode.
  18536. // ssl_error is the value from wolfSSL_get_error().
  18537. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18538. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18539. int &out_errno) {
  18540. switch (ssl_error) {
  18541. case SSL_ERROR_NONE: return ErrorCode::Success;
  18542. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18543. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18544. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18545. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18546. default:
  18547. if (ssl) {
  18548. // wolfSSL stores the low-level error code as a negative value.
  18549. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18550. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18551. if (low_err == DOMAIN_NAME_MISMATCH) {
  18552. return ErrorCode::HostnameMismatch;
  18553. }
  18554. // Check verify result to distinguish cert verification from generic SSL
  18555. // errors.
  18556. long vr = wolfSSL_get_verify_result(ssl);
  18557. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18558. }
  18559. return ErrorCode::Fatal;
  18560. }
  18561. }
  18562. // WolfSSLContext constructor/destructor implementations
  18563. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18564. inline WolfSSLContext::~WolfSSLContext() {
  18565. if (ctx) { wolfSSL_CTX_free(ctx); }
  18566. }
  18567. // Thread-local storage for SNI captured during handshake
  18568. inline std::string &wolfssl_pending_sni() {
  18569. static thread_local std::string sni;
  18570. return sni;
  18571. }
  18572. // SNI callback for wolfSSL server to capture client's SNI hostname
  18573. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18574. (void)ret;
  18575. (void)exArg;
  18576. void *name_data = nullptr;
  18577. unsigned short name_len =
  18578. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18579. if (name_data && name_len > 0) {
  18580. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18581. name_len);
  18582. } else {
  18583. wolfssl_pending_sni().clear();
  18584. }
  18585. return 0; // Continue regardless
  18586. }
  18587. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18588. // runs the verify callback of its own context.
  18589. inline int context_ex_data_index() {
  18590. static const auto index =
  18591. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18592. return index;
  18593. }
  18594. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  18595. // other tls:: function takes.
  18596. inline int session_ex_data_index() {
  18597. static const auto index =
  18598. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18599. return index;
  18600. }
  18601. // wolfSSL verify callback wrapper
  18602. inline int wolfssl_verify_callback(int preverify_ok,
  18603. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18604. // Get the WOLFSSL object from the X509_STORE_CTX
  18605. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18606. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18607. if (!ssl) { return preverify_ok; }
  18608. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  18609. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  18610. if (!wctx || !wctx->verify_callback) { return preverify_ok; }
  18611. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18612. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18613. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18614. VerifyContext verify_ctx;
  18615. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  18616. verify_ctx.cert = static_cast<cert_t>(cert);
  18617. verify_ctx.depth = depth;
  18618. verify_ctx.preverify_ok = (preverify_ok != 0);
  18619. verify_ctx.error_code = static_cast<long>(err);
  18620. if (err != 0) {
  18621. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18622. } else {
  18623. verify_ctx.error_string = nullptr;
  18624. }
  18625. bool accepted = wctx->verify_callback(verify_ctx);
  18626. return accepted ? 1 : 0;
  18627. }
  18628. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18629. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18630. wolfSSL_CTX_set_default_passwd_cb(
  18631. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18632. auto *pwd = static_cast<const char *>(userdata);
  18633. if (!pwd) return 0;
  18634. auto len = static_cast<int>(strlen(pwd));
  18635. if (len > size) len = size;
  18636. memcpy(buf, pwd, static_cast<size_t>(len));
  18637. return len;
  18638. });
  18639. }
  18640. } // namespace impl
  18641. inline ctx_t create_client_context() {
  18642. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18643. if (!ctx) { return nullptr; }
  18644. ctx->is_server = false;
  18645. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18646. if (!method) {
  18647. delete ctx;
  18648. return nullptr;
  18649. }
  18650. ctx->ctx = wolfSSL_CTX_new(method);
  18651. if (!ctx->ctx ||
  18652. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18653. WOLFSSL_SUCCESS) {
  18654. delete ctx;
  18655. return nullptr;
  18656. }
  18657. // Default: verify peer certificate
  18658. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18659. return static_cast<ctx_t>(ctx);
  18660. }
  18661. inline ctx_t create_server_context() {
  18662. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18663. if (!ctx) { return nullptr; }
  18664. ctx->is_server = true;
  18665. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18666. if (!method) {
  18667. delete ctx;
  18668. return nullptr;
  18669. }
  18670. ctx->ctx = wolfSSL_CTX_new(method);
  18671. if (!ctx->ctx ||
  18672. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18673. WOLFSSL_SUCCESS) {
  18674. delete ctx;
  18675. return nullptr;
  18676. }
  18677. // Default: don't verify client
  18678. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18679. // Enable SNI on server
  18680. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18681. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18682. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18683. return static_cast<ctx_t>(ctx);
  18684. }
  18685. inline void free_context(ctx_t ctx) {
  18686. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18687. }
  18688. inline bool set_min_version(ctx_t ctx, Version version) {
  18689. if (!ctx) { return false; }
  18690. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18691. int min_ver = WOLFSSL_TLSV1_2;
  18692. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18693. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18694. }
  18695. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18696. if (!ctx || !pem) { return false; }
  18697. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18698. int ret = wolfSSL_CTX_load_verify_buffer(
  18699. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18700. static_cast<long>(len), SSL_FILETYPE_PEM);
  18701. if (ret != SSL_SUCCESS) {
  18702. impl::wolfssl_last_error() =
  18703. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18704. return false;
  18705. }
  18706. wctx->ca_pem_data_.append(pem, len);
  18707. return true;
  18708. }
  18709. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18710. if (!ctx || !file_path) { return false; }
  18711. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18712. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18713. if (ret != SSL_SUCCESS) {
  18714. impl::wolfssl_last_error() =
  18715. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18716. return false;
  18717. }
  18718. return true;
  18719. }
  18720. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18721. if (!ctx || !dir_path) { return false; }
  18722. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18723. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18724. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18725. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18726. // immediately. Return true even on failure since the CA file may have
  18727. // already been loaded, matching OpenSSL's lenient behavior.
  18728. (void)ret;
  18729. return true;
  18730. }
  18731. inline bool load_system_certs(ctx_t ctx) {
  18732. if (!ctx) { return false; }
  18733. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18734. bool loaded = false;
  18735. #ifdef _WIN32
  18736. loaded = impl::enumerate_windows_system_certs(
  18737. [&](const unsigned char *data, size_t len) {
  18738. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18739. static_cast<long>(len),
  18740. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18741. });
  18742. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18743. loaded = impl::enumerate_macos_keychain_certs(
  18744. [&](const unsigned char *data, size_t len) {
  18745. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18746. static_cast<long>(len),
  18747. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18748. });
  18749. #else
  18750. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18751. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18752. SSL_SUCCESS) {
  18753. loaded = true;
  18754. break;
  18755. }
  18756. }
  18757. if (!loaded) {
  18758. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18759. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18760. SSL_SUCCESS) {
  18761. loaded = true;
  18762. break;
  18763. }
  18764. }
  18765. }
  18766. #endif
  18767. return loaded;
  18768. }
  18769. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18770. const char *password) {
  18771. if (!ctx || !cert || !key) { return false; }
  18772. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18773. // Load certificate
  18774. int ret = wolfSSL_CTX_use_certificate_buffer(
  18775. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18776. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18777. if (ret != SSL_SUCCESS) {
  18778. impl::wolfssl_last_error() =
  18779. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18780. return false;
  18781. }
  18782. // Set password callback if password is provided
  18783. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18784. // Load private key
  18785. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18786. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18787. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18788. if (ret != SSL_SUCCESS) {
  18789. impl::wolfssl_last_error() =
  18790. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18791. return false;
  18792. }
  18793. // Verify that the certificate and private key match
  18794. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18795. }
  18796. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18797. const char *key_path, const char *password) {
  18798. if (!ctx || !cert_path || !key_path) { return false; }
  18799. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18800. // Load certificate file
  18801. int ret =
  18802. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18803. if (ret != SSL_SUCCESS) {
  18804. impl::wolfssl_last_error() =
  18805. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18806. return false;
  18807. }
  18808. // Set password callback if password is provided
  18809. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18810. // Load private key file
  18811. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18812. if (ret != SSL_SUCCESS) {
  18813. impl::wolfssl_last_error() =
  18814. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18815. return false;
  18816. }
  18817. // Verify that the certificate and private key match
  18818. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18819. }
  18820. inline void set_verify_client(ctx_t ctx, bool require) {
  18821. if (!ctx) { return; }
  18822. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18823. wctx->verify_client = require;
  18824. if (require) {
  18825. wolfSSL_CTX_set_verify(
  18826. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18827. wctx->verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18828. } else {
  18829. if (wctx->verify_callback) {
  18830. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18831. impl::wolfssl_verify_callback);
  18832. } else {
  18833. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18834. }
  18835. }
  18836. }
  18837. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18838. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18839. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18840. auto session = new (std::nothrow) impl::WolfSSLSession();
  18841. if (!session) { return nullptr; }
  18842. session->sock = sock;
  18843. session->ssl = wolfSSL_new(wctx->ctx);
  18844. if (!session->ssl) {
  18845. impl::wolfssl_last_error() =
  18846. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18847. delete session;
  18848. return nullptr;
  18849. }
  18850. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  18851. session) != WOLFSSL_SUCCESS) {
  18852. delete session;
  18853. return nullptr;
  18854. }
  18855. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18856. return static_cast<session_t>(session);
  18857. }
  18858. inline void free_session(session_t session) {
  18859. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18860. }
  18861. inline bool set_sni(session_t session, const char *hostname,
  18862. bool verify_hostname) {
  18863. if (!session || !hostname) { return false; }
  18864. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18865. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18866. static_cast<word16>(strlen(hostname)));
  18867. if (ret != WOLFSSL_SUCCESS) {
  18868. impl::wolfssl_last_error() =
  18869. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18870. return false;
  18871. }
  18872. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18873. // separately from the SNI extension sent above; skip it when hostname
  18874. // verification is disabled so only the chain is checked, matching OpenSSL.
  18875. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18876. wsession->hostname = hostname;
  18877. return true;
  18878. }
  18879. inline TlsError connect(session_t session) {
  18880. TlsError err;
  18881. if (!session) {
  18882. err.code = ErrorCode::Fatal;
  18883. return err;
  18884. }
  18885. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18886. int ret = wolfSSL_connect(wsession->ssl);
  18887. if (ret == SSL_SUCCESS) {
  18888. err.code = ErrorCode::Success;
  18889. } else {
  18890. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18891. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18892. err.backend_code = static_cast<uint64_t>(ssl_error);
  18893. impl::wolfssl_last_error() = err.backend_code;
  18894. }
  18895. return err;
  18896. }
  18897. inline TlsError accept(session_t session) {
  18898. TlsError err;
  18899. if (!session) {
  18900. err.code = ErrorCode::Fatal;
  18901. return err;
  18902. }
  18903. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18904. int ret = wolfSSL_accept(wsession->ssl);
  18905. if (ret == SSL_SUCCESS) {
  18906. err.code = ErrorCode::Success;
  18907. // Capture SNI from thread-local storage after successful handshake
  18908. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18909. impl::wolfssl_pending_sni().clear();
  18910. } else {
  18911. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18912. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18913. err.backend_code = static_cast<uint64_t>(ssl_error);
  18914. impl::wolfssl_last_error() = err.backend_code;
  18915. }
  18916. return err;
  18917. }
  18918. inline bool connect_nonblocking(session_t session, socket_t sock,
  18919. time_t timeout_sec, time_t timeout_usec,
  18920. TlsError *err) {
  18921. if (!session) {
  18922. if (err) { err->code = ErrorCode::Fatal; }
  18923. return false;
  18924. }
  18925. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18926. // Set socket to non-blocking mode
  18927. detail::set_nonblocking(sock, true);
  18928. auto cleanup =
  18929. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18930. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18931. int ret;
  18932. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18933. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18934. if (ssl_error == SSL_ERROR_WANT_READ) {
  18935. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18936. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18937. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18938. }
  18939. // Error or timeout
  18940. if (err) {
  18941. err->code =
  18942. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18943. err->backend_code = static_cast<uint64_t>(ssl_error);
  18944. }
  18945. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18946. return false;
  18947. }
  18948. if (err) { err->code = ErrorCode::Success; }
  18949. return true;
  18950. }
  18951. inline bool accept_nonblocking(session_t session, socket_t sock,
  18952. time_t timeout_sec, time_t timeout_usec,
  18953. TlsError *err) {
  18954. if (!session) {
  18955. if (err) { err->code = ErrorCode::Fatal; }
  18956. return false;
  18957. }
  18958. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18959. // Set socket to non-blocking mode
  18960. detail::set_nonblocking(sock, true);
  18961. auto cleanup =
  18962. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18963. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18964. int ret;
  18965. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18966. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18967. if (ssl_error == SSL_ERROR_WANT_READ) {
  18968. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18969. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18970. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18971. }
  18972. // Error or timeout
  18973. if (err) {
  18974. err->code =
  18975. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18976. err->backend_code = static_cast<uint64_t>(ssl_error);
  18977. }
  18978. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18979. return false;
  18980. }
  18981. if (err) { err->code = ErrorCode::Success; }
  18982. // Capture SNI from thread-local storage after successful handshake
  18983. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18984. impl::wolfssl_pending_sni().clear();
  18985. return true;
  18986. }
  18987. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18988. if (!session || !buf) {
  18989. err.code = ErrorCode::Fatal;
  18990. return -1;
  18991. }
  18992. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18993. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18994. if (ret > 0) {
  18995. err.code = ErrorCode::Success;
  18996. return static_cast<ssize_t>(ret);
  18997. }
  18998. if (ret == 0) {
  18999. err.code = ErrorCode::PeerClosed;
  19000. return 0;
  19001. }
  19002. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19003. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19004. err.backend_code = static_cast<uint64_t>(ssl_error);
  19005. impl::wolfssl_last_error() = err.backend_code;
  19006. return -1;
  19007. }
  19008. inline ssize_t write(session_t session, const void *buf, size_t len,
  19009. TlsError &err) {
  19010. if (!session || !buf) {
  19011. err.code = ErrorCode::Fatal;
  19012. return -1;
  19013. }
  19014. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19015. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19016. if (ret > 0) {
  19017. err.code = ErrorCode::Success;
  19018. return static_cast<ssize_t>(ret);
  19019. }
  19020. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19021. // Treat this as an error (return -1) so callers don't spin in a
  19022. // write loop adding zero to the offset.
  19023. if (ret == 0) {
  19024. err.code = ErrorCode::PeerClosed;
  19025. return -1;
  19026. }
  19027. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19028. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19029. err.backend_code = static_cast<uint64_t>(ssl_error);
  19030. impl::wolfssl_last_error() = err.backend_code;
  19031. return -1;
  19032. }
  19033. inline int pending(const_session_t session) {
  19034. if (!session) { return 0; }
  19035. auto wsession =
  19036. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19037. return wolfSSL_pending(wsession->ssl);
  19038. }
  19039. inline void shutdown(session_t session, bool graceful) {
  19040. if (!session) { return; }
  19041. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19042. if (graceful) {
  19043. int ret;
  19044. int attempts = 0;
  19045. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19046. attempts < 3) {
  19047. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19048. if (ssl_error != SSL_ERROR_WANT_READ &&
  19049. ssl_error != SSL_ERROR_WANT_WRITE) {
  19050. break;
  19051. }
  19052. attempts++;
  19053. }
  19054. } else {
  19055. wolfSSL_shutdown(wsession->ssl);
  19056. }
  19057. }
  19058. inline bool is_peer_closed(session_t session, socket_t sock) {
  19059. if (!session || sock == INVALID_SOCKET) { return true; }
  19060. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19061. // Check if there's already decrypted data available
  19062. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19063. // Set socket to non-blocking to avoid blocking on read
  19064. detail::set_nonblocking(sock, true);
  19065. auto cleanup =
  19066. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19067. // Peek 1 byte to check connection status without consuming data
  19068. unsigned char buf;
  19069. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19070. // If we got data or WANT_READ (would block), connection is alive
  19071. if (ret > 0) { return false; }
  19072. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19073. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19074. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19075. ret == 0;
  19076. }
  19077. inline cert_t get_peer_cert(const_session_t session) {
  19078. if (!session) { return nullptr; }
  19079. auto wsession =
  19080. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19081. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19082. return static_cast<cert_t>(cert);
  19083. }
  19084. inline size_t get_peer_certs(const_session_t session,
  19085. std::vector<cert_t> &certs) {
  19086. certs.clear();
  19087. if (!session) { return 0; }
  19088. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19089. #ifdef SESSION_CERTS
  19090. auto wsession =
  19091. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19092. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19093. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19094. for (int i = 0; i < count; i++) {
  19095. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19096. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19097. }
  19098. #endif
  19099. return certs.size();
  19100. }
  19101. inline void free_cert(cert_t cert) {
  19102. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19103. }
  19104. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19105. if (!cert || !hostname) { return false; }
  19106. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19107. std::string host_str(hostname);
  19108. // Check if hostname is an IP address (IPv4 or IPv6)
  19109. unsigned char ip_bytes[16];
  19110. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19111. auto is_ip = ip_len > 0;
  19112. // Check Subject Alternative Names
  19113. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19114. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19115. if (san_names) {
  19116. int san_count = wolfSSL_sk_num(san_names);
  19117. for (int i = 0; i < san_count; i++) {
  19118. auto *names =
  19119. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19120. if (!names) continue;
  19121. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19122. // DNS name
  19123. unsigned char *dns_name = nullptr;
  19124. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19125. if (dns_name && dns_len > 0) {
  19126. std::string san_name(reinterpret_cast<char *>(dns_name),
  19127. static_cast<size_t>(dns_len));
  19128. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19129. if (detail::match_hostname(san_name, host_str)) {
  19130. wolfSSL_sk_free(san_names);
  19131. return true;
  19132. }
  19133. }
  19134. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19135. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19136. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19137. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19138. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19139. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19140. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19141. wolfSSL_sk_free(san_names);
  19142. return true;
  19143. }
  19144. }
  19145. }
  19146. wolfSSL_sk_free(san_names);
  19147. }
  19148. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  19149. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  19150. // the OpenSSL backend's X509_check_ip behaves the same way).
  19151. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  19152. if (subject) {
  19153. char cn[256] = {};
  19154. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19155. sizeof(cn));
  19156. if (cn_len > 0) {
  19157. std::string cn_str(cn, static_cast<size_t>(cn_len));
  19158. if (detail::match_hostname(cn_str, host_str)) { return true; }
  19159. }
  19160. }
  19161. return false;
  19162. }
  19163. inline uint64_t hostname_mismatch_code() {
  19164. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19165. }
  19166. inline long get_verify_result(const_session_t session) {
  19167. if (!session) { return -1; }
  19168. auto wsession =
  19169. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19170. long result = wolfSSL_get_verify_result(wsession->ssl);
  19171. return result;
  19172. }
  19173. inline std::string get_cert_subject_cn(cert_t cert) {
  19174. if (!cert) return "";
  19175. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19176. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19177. if (!subject) return "";
  19178. char cn[256] = {};
  19179. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19180. sizeof(cn));
  19181. if (cn_len <= 0) return "";
  19182. return std::string(cn, static_cast<size_t>(cn_len));
  19183. }
  19184. inline std::string get_cert_issuer_name(cert_t cert) {
  19185. if (!cert) return "";
  19186. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19187. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19188. if (!issuer) return "";
  19189. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19190. if (!name_str) return "";
  19191. std::string result(name_str);
  19192. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19193. return result;
  19194. }
  19195. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19196. sans.clear();
  19197. if (!cert) return false;
  19198. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19199. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19200. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19201. if (!san_names) return true; // No SANs is not an error
  19202. int count = wolfSSL_sk_num(san_names);
  19203. for (int i = 0; i < count; i++) {
  19204. auto *name =
  19205. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19206. if (!name) continue;
  19207. SanEntry entry;
  19208. switch (name->type) {
  19209. case WOLFSSL_GEN_DNS: {
  19210. entry.type = SanType::DNS;
  19211. unsigned char *dns_name = nullptr;
  19212. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19213. if (dns_name && dns_len > 0) {
  19214. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19215. static_cast<size_t>(dns_len));
  19216. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19217. }
  19218. break;
  19219. }
  19220. case WOLFSSL_GEN_IPADD: {
  19221. entry.type = SanType::IP;
  19222. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19223. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19224. if (ip_data && ip_len == 4) {
  19225. char buf[16];
  19226. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19227. ip_data[2], ip_data[3]);
  19228. entry.value = buf;
  19229. } else if (ip_data && ip_len == 16) {
  19230. char buf[64];
  19231. snprintf(buf, sizeof(buf),
  19232. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19233. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19234. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19235. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19236. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19237. ip_data[14], ip_data[15]);
  19238. entry.value = buf;
  19239. }
  19240. break;
  19241. }
  19242. case WOLFSSL_GEN_EMAIL:
  19243. entry.type = SanType::EMAIL;
  19244. {
  19245. unsigned char *email = nullptr;
  19246. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19247. if (email && email_len > 0) {
  19248. entry.value = std::string(reinterpret_cast<char *>(email),
  19249. static_cast<size_t>(email_len));
  19250. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19251. }
  19252. }
  19253. break;
  19254. case WOLFSSL_GEN_URI:
  19255. entry.type = SanType::URI;
  19256. {
  19257. unsigned char *uri = nullptr;
  19258. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19259. &uri, name->d.uniformResourceIdentifier);
  19260. if (uri && uri_len > 0) {
  19261. entry.value = std::string(reinterpret_cast<char *>(uri),
  19262. static_cast<size_t>(uri_len));
  19263. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19264. }
  19265. }
  19266. break;
  19267. default: entry.type = SanType::OTHER; break;
  19268. }
  19269. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19270. }
  19271. wolfSSL_sk_free(san_names);
  19272. return true;
  19273. }
  19274. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19275. time_t &not_after) {
  19276. if (!cert) return false;
  19277. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19278. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19279. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19280. if (!nb || !na) return false;
  19281. // wolfSSL_ASN1_TIME_to_tm is available
  19282. struct tm tm_nb = {}, tm_na = {};
  19283. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19284. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19285. #ifdef _WIN32
  19286. not_before = _mkgmtime(&tm_nb);
  19287. not_after = _mkgmtime(&tm_na);
  19288. #else
  19289. not_before = timegm(&tm_nb);
  19290. not_after = timegm(&tm_na);
  19291. #endif
  19292. return true;
  19293. }
  19294. inline std::string get_cert_serial(cert_t cert) {
  19295. if (!cert) return "";
  19296. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19297. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19298. if (!serial_asn1) return "";
  19299. // Get the serial number data
  19300. int len = serial_asn1->length;
  19301. unsigned char *data = serial_asn1->data;
  19302. if (!data || len <= 0) return "";
  19303. std::string result;
  19304. result.reserve(static_cast<size_t>(len) * 2);
  19305. for (int i = 0; i < len; i++) {
  19306. char hex[3];
  19307. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19308. result += hex;
  19309. }
  19310. return result;
  19311. }
  19312. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19313. if (!cert) return false;
  19314. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19315. int der_len = 0;
  19316. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19317. if (!der_data || der_len <= 0) return false;
  19318. der.assign(der_data, der_data + der_len);
  19319. return true;
  19320. }
  19321. inline const char *get_sni(const_session_t session) {
  19322. if (!session) return nullptr;
  19323. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19324. // For server: return SNI received from client during handshake
  19325. if (!wsession->sni_hostname.empty()) {
  19326. return wsession->sni_hostname.c_str();
  19327. }
  19328. // For client: return the hostname set via set_sni
  19329. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19330. return nullptr;
  19331. }
  19332. inline uint64_t peek_error() {
  19333. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19334. }
  19335. inline uint64_t get_error() {
  19336. uint64_t err = impl::wolfssl_last_error();
  19337. impl::wolfssl_last_error() = 0;
  19338. return err;
  19339. }
  19340. inline std::string error_string(uint64_t code) {
  19341. char buf[256];
  19342. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19343. return std::string(buf);
  19344. }
  19345. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19346. if (!pem || len == 0) { return nullptr; }
  19347. // Validate by attempting to load into a temporary ctx
  19348. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19349. if (!tmp_ctx) { return nullptr; }
  19350. int ret = wolfSSL_CTX_load_verify_buffer(
  19351. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19352. static_cast<long>(len), SSL_FILETYPE_PEM);
  19353. wolfSSL_CTX_free(tmp_ctx);
  19354. if (ret != SSL_SUCCESS) { return nullptr; }
  19355. return static_cast<ca_store_t>(
  19356. new impl::WolfSSLCAStore{std::string(pem, len)});
  19357. }
  19358. inline void free_ca_store(ca_store_t store) {
  19359. delete static_cast<impl::WolfSSLCAStore *>(store);
  19360. }
  19361. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19362. if (!ctx || !store) { return false; }
  19363. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19364. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19365. int ret = wolfSSL_CTX_load_verify_buffer(
  19366. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19367. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19368. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19369. // This function takes ownership of the store; the PEM data was copied into
  19370. // the context, so release the source
  19371. free_ca_store(store);
  19372. return ret == SSL_SUCCESS;
  19373. }
  19374. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19375. certs.clear();
  19376. if (!ctx) { return 0; }
  19377. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19378. if (wctx->ca_pem_data_.empty()) { return 0; }
  19379. const std::string &pem = wctx->ca_pem_data_;
  19380. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19381. const std::string end_marker = "-----END CERTIFICATE-----";
  19382. size_t pos = 0;
  19383. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19384. size_t end_pos = pem.find(end_marker, pos);
  19385. if (end_pos == std::string::npos) { break; }
  19386. end_pos += end_marker.size();
  19387. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19388. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19389. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19390. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19391. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19392. pos = end_pos;
  19393. }
  19394. return certs.size();
  19395. }
  19396. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19397. std::vector<std::string> names;
  19398. if (!ctx) { return names; }
  19399. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19400. if (wctx->ca_pem_data_.empty()) { return names; }
  19401. const std::string &pem = wctx->ca_pem_data_;
  19402. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19403. const std::string end_marker = "-----END CERTIFICATE-----";
  19404. size_t pos = 0;
  19405. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19406. size_t end_pos = pem.find(end_marker, pos);
  19407. if (end_pos == std::string::npos) { break; }
  19408. end_pos += end_marker.size();
  19409. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19410. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19411. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19412. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19413. if (x509) {
  19414. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19415. if (subject) {
  19416. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19417. if (name_str) {
  19418. names.push_back(name_str);
  19419. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19420. }
  19421. }
  19422. wolfSSL_X509_free(x509);
  19423. }
  19424. pos = end_pos;
  19425. }
  19426. return names;
  19427. }
  19428. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19429. const char *key_pem, const char *password) {
  19430. if (!ctx || !cert_pem || !key_pem) { return false; }
  19431. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19432. // Load new certificate
  19433. int ret = wolfSSL_CTX_use_certificate_buffer(
  19434. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19435. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19436. if (ret != SSL_SUCCESS) {
  19437. impl::wolfssl_last_error() =
  19438. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19439. return false;
  19440. }
  19441. // Set password if provided
  19442. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19443. // Load new private key
  19444. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19445. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19446. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19447. if (ret != SSL_SUCCESS) {
  19448. impl::wolfssl_last_error() =
  19449. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19450. return false;
  19451. }
  19452. return true;
  19453. }
  19454. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19455. if (!ctx || !ca_pem) { return false; }
  19456. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19457. int ret = wolfSSL_CTX_load_verify_buffer(
  19458. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19459. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19460. if (ret != SSL_SUCCESS) {
  19461. impl::wolfssl_last_error() =
  19462. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19463. return false;
  19464. }
  19465. return true;
  19466. }
  19467. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19468. if (!ctx) { return false; }
  19469. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19470. wctx->verify_callback = std::move(callback);
  19471. if (wctx->verify_callback) {
  19472. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19473. impl::wolfssl_verify_callback);
  19474. } else {
  19475. wolfSSL_CTX_set_verify(
  19476. wctx->ctx,
  19477. wctx->verify_client
  19478. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19479. : SSL_VERIFY_NONE,
  19480. nullptr);
  19481. }
  19482. return true;
  19483. }
  19484. inline long get_verify_error(const_session_t session) {
  19485. if (!session) { return -1; }
  19486. auto *wsession =
  19487. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19488. return wolfSSL_get_verify_result(wsession->ssl);
  19489. }
  19490. inline std::string verify_error_string(long error_code) {
  19491. if (error_code == 0) { return ""; }
  19492. const char *str =
  19493. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19494. return str ? std::string(str) : std::string();
  19495. }
  19496. } // namespace tls
  19497. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19498. // WebSocket implementation
  19499. namespace ws {
  19500. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19501. bool fin) {
  19502. std::lock_guard<std::mutex> lock(write_mutex_);
  19503. if (closed_) { return false; }
  19504. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19505. }
  19506. inline ReadResult WebSocket::read(std::string &msg) {
  19507. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19508. while (!closed_) {
  19509. Opcode opcode;
  19510. std::string payload;
  19511. bool fin;
  19512. impl::FrameRead r =
  19513. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19514. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19515. // A timeout landed on a frame boundary: the connection is untouched and
  19516. // still usable, so hand control back without closing it. That is only
  19517. // useful to a caller who asked for the timeout; the compile-time default
  19518. // is a backstop against a peer gone quiet, and elapsing it closes the
  19519. // connection so a plain `while (ws.read(msg))` loop ends.
  19520. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19521. if (r != impl::FrameRead::Ok) {
  19522. closed_ = true;
  19523. return Fail;
  19524. }
  19525. switch (opcode) {
  19526. case Opcode::Ping: {
  19527. std::lock_guard<std::mutex> lock(write_mutex_);
  19528. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19529. payload.size(), true, !is_server_);
  19530. continue;
  19531. }
  19532. case Opcode::Pong: {
  19533. std::lock_guard<std::mutex> lock(ping_mutex_);
  19534. unacked_pings_ = 0;
  19535. continue;
  19536. }
  19537. case Opcode::Close: {
  19538. if (!closed_.exchange(true)) {
  19539. // Echo close frame back
  19540. std::lock_guard<std::mutex> lock(write_mutex_);
  19541. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19542. payload.size(), true, !is_server_);
  19543. }
  19544. return Fail;
  19545. }
  19546. case Opcode::Text:
  19547. case Opcode::Binary: {
  19548. auto result = opcode == Opcode::Text ? Text : Binary;
  19549. msg = std::move(payload);
  19550. // Handle fragmentation
  19551. if (!fin) {
  19552. while (true) {
  19553. Opcode cont_opcode;
  19554. std::string cont_payload;
  19555. bool cont_fin;
  19556. // A timeout is not reportable here: half of a fragmented message is
  19557. // already in `msg` and read() has no way to resume it, so it is a
  19558. // failure like any other. Timeouts are only ever seen on a message
  19559. // boundary.
  19560. if (impl::read_websocket_frame(
  19561. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  19562. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19563. impl::FrameRead::Ok) {
  19564. closed_ = true;
  19565. return Fail;
  19566. }
  19567. if (cont_opcode == Opcode::Ping) {
  19568. std::lock_guard<std::mutex> lock(write_mutex_);
  19569. detail::write_websocket_frame(
  19570. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19571. true, !is_server_);
  19572. continue;
  19573. }
  19574. if (cont_opcode == Opcode::Pong) {
  19575. std::lock_guard<std::mutex> lock(ping_mutex_);
  19576. unacked_pings_ = 0;
  19577. continue;
  19578. }
  19579. if (cont_opcode == Opcode::Close) {
  19580. if (!closed_.exchange(true)) {
  19581. std::lock_guard<std::mutex> lock(write_mutex_);
  19582. detail::write_websocket_frame(
  19583. strm_, Opcode::Close, cont_payload.data(),
  19584. cont_payload.size(), true, !is_server_);
  19585. }
  19586. return Fail;
  19587. }
  19588. // RFC 6455: continuation frames must use opcode 0x0
  19589. if (cont_opcode != Opcode::Continuation) {
  19590. closed_ = true;
  19591. return Fail;
  19592. }
  19593. msg += cont_payload;
  19594. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19595. closed_ = true;
  19596. return Fail;
  19597. }
  19598. if (cont_fin) { break; }
  19599. }
  19600. }
  19601. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19602. if (result == Text && !impl::is_valid_utf8(msg)) {
  19603. // close() takes the read lock to wait for the peer's Close reply, so
  19604. // it must not run while this thread still holds it.
  19605. read_lock.unlock();
  19606. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19607. return Fail;
  19608. }
  19609. return result;
  19610. }
  19611. default: closed_ = true; return Fail;
  19612. }
  19613. }
  19614. return Fail;
  19615. }
  19616. inline bool WebSocket::send(const std::string &data) {
  19617. return send_frame(Opcode::Text, data.data(), data.size());
  19618. }
  19619. inline bool WebSocket::send(const char *data, size_t len) {
  19620. return send_frame(Opcode::Binary, data, len);
  19621. }
  19622. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19623. if (closed_.exchange(true)) { return; }
  19624. ping_cv_.notify_all();
  19625. std::string payload;
  19626. auto code = static_cast<uint16_t>(status);
  19627. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19628. payload.push_back(static_cast<char>(code & 0xFF));
  19629. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19630. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19631. payload += reason.substr(0, 123);
  19632. {
  19633. std::lock_guard<std::mutex> lock(write_mutex_);
  19634. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19635. payload.size(), true, !is_server_);
  19636. }
  19637. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19638. // Close response before closing the TCP connection.
  19639. //
  19640. // Wait only when no other thread is parsing frames. When one is, it is the
  19641. // thread positioned to see the peer's reply, and reading here would take
  19642. // bytes out of the message it is assembling. Bailing out also leaves the
  19643. // stream, including its read timeout, entirely to that thread.
  19644. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19645. if (!read_lock.owns_lock()) { return; }
  19646. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19647. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19648. Opcode op;
  19649. std::string resp;
  19650. bool fin;
  19651. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19652. impl::FrameRead::Ok) {
  19653. if (op == Opcode::Close) { break; }
  19654. }
  19655. }
  19656. inline WebSocket::~WebSocket() {
  19657. {
  19658. std::lock_guard<std::mutex> lock(ping_mutex_);
  19659. closed_ = true;
  19660. }
  19661. ping_cv_.notify_all();
  19662. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19663. }
  19664. inline void WebSocket::start_heartbeat() {
  19665. if (ping_interval_sec_ == 0) { return; }
  19666. ping_thread_ = std::thread([this]() {
  19667. std::unique_lock<std::mutex> lock(ping_mutex_);
  19668. // The predicate keeps a spurious wakeup from sending a ping early
  19669. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  19670. [this]() { return closed_.load(); })) {
  19671. // If the peer has failed to respond to the previous pings, give up.
  19672. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19673. // opt-in liveness check controlled by max_missed_pongs_.
  19674. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19675. lock.unlock();
  19676. close(CloseStatus::GoingAway, "pong timeout");
  19677. // Wake a read() blocked on the unresponsive peer. Only the read side
  19678. // is shut down: a TLS backend answers the EOF with an alert, and
  19679. // writing it to a socket closed for writing raises SIGPIPE.
  19680. #ifdef _WIN32
  19681. shutdown(strm_.socket(), SD_RECEIVE);
  19682. #else
  19683. shutdown(strm_.socket(), SHUT_RD);
  19684. #endif
  19685. return;
  19686. }
  19687. lock.unlock();
  19688. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19689. lock.lock();
  19690. closed_ = true;
  19691. break;
  19692. }
  19693. lock.lock();
  19694. unacked_pings_++;
  19695. }
  19696. });
  19697. }
  19698. inline const Request &WebSocket::request() const { return req_; }
  19699. inline bool WebSocket::is_open() const { return !closed_; }
  19700. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19701. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19702. // poll(), where 0 would instead mean "return immediately", so hand it the
  19703. // negative poll uses for an unbounded wait.
  19704. if (sec == 0 && usec == 0) { sec = -1; }
  19705. strm_.set_read_timeout(sec, usec);
  19706. read_timeout_set_ = true;
  19707. }
  19708. // WebSocketClient implementation
  19709. inline WebSocketClient::WebSocketClient(
  19710. const std::string &scheme_host_port_path, const Headers &headers)
  19711. : headers_(headers) {
  19712. detail::UrlComponents uc;
  19713. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19714. !uc.host.empty() && !uc.path.empty()) {
  19715. auto &scheme = uc.scheme;
  19716. #ifdef CPPHTTPLIB_SSL_ENABLED
  19717. if (scheme != "ws" && scheme != "wss") {
  19718. #else
  19719. if (scheme != "ws") {
  19720. #endif
  19721. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19722. std::string msg = "'" + scheme + "' scheme is not supported.";
  19723. throw std::invalid_argument(msg);
  19724. #endif
  19725. return;
  19726. }
  19727. auto is_ssl = scheme == "wss";
  19728. host_ = std::move(uc.host);
  19729. port_ = is_ssl ? 443 : 80;
  19730. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19731. path_ = std::move(uc.path);
  19732. if (!uc.query.empty()) { path_ += uc.query; }
  19733. #ifdef CPPHTTPLIB_SSL_ENABLED
  19734. is_ssl_ = is_ssl;
  19735. if (is_ssl_) {
  19736. // The context lives as long as the client so that CA configuration
  19737. // survives reconnects; sessions are created per connection.
  19738. tls_ctx_ = tls::create_client_context();
  19739. if (!tls_ctx_) { return; }
  19740. }
  19741. #else
  19742. if (is_ssl) { return; }
  19743. #endif
  19744. is_valid_ = true;
  19745. }
  19746. }
  19747. #ifdef CPPHTTPLIB_SSL_ENABLED
  19748. inline WebSocketClient::WebSocketClient(
  19749. const std::string &scheme_host_port_path, const PemMemory &pem,
  19750. const Headers &headers)
  19751. : WebSocketClient(scheme_host_port_path, headers) {
  19752. // For ws:// URLs the client certificate is silently ignored, consistent
  19753. // with the TLS-only setters such as set_ca_cert_path().
  19754. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19755. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19756. pem.private_key_password)) {
  19757. tls::free_context(tls_ctx_);
  19758. tls_ctx_ = nullptr;
  19759. is_valid_ = false;
  19760. }
  19761. }
  19762. }
  19763. #endif
  19764. inline WebSocketClient::~WebSocketClient() {
  19765. shutdown_and_close();
  19766. #ifdef CPPHTTPLIB_SSL_ENABLED
  19767. if (tls_ctx_) {
  19768. tls::free_context(tls_ctx_);
  19769. tls_ctx_ = nullptr;
  19770. }
  19771. #endif
  19772. }
  19773. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19774. inline void WebSocketClient::shutdown_and_close() {
  19775. // Send the close frame while the TLS session is still alive: ws_ holds an
  19776. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19777. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19778. if (ws_ && ws_->is_open()) { ws_->close(); }
  19779. ws_.reset();
  19780. #ifdef CPPHTTPLIB_SSL_ENABLED
  19781. if (is_ssl_) {
  19782. if (tls_session_) {
  19783. tls::shutdown(tls_session_, true);
  19784. tls::free_session(tls_session_);
  19785. tls_session_ = nullptr;
  19786. }
  19787. }
  19788. #endif
  19789. if (sock_ != INVALID_SOCKET) {
  19790. detail::shutdown_socket(sock_);
  19791. detail::close_socket(sock_);
  19792. sock_ = INVALID_SOCKET;
  19793. }
  19794. }
  19795. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19796. Error &error, int &ssl_error,
  19797. uint64_t &ssl_backend_error) {
  19798. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19799. // The streams wait with poll(), where 0 instead means "return immediately",
  19800. // so they are given the negative poll uses for an unbounded wait.
  19801. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19802. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19803. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19804. // The handshake belongs to establishing the connection, so an unset read
  19805. // timeout leaves it bounded by the connection timeout instead of forever.
  19806. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19807. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19808. #ifdef CPPHTTPLIB_SSL_ENABLED
  19809. if (is_ssl_) {
  19810. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19811. // is not safe to call concurrently on one client to begin with, since
  19812. // nothing else here is guarded either.
  19813. if (server_certificate_verification_ && !certs_loaded_) {
  19814. uint64_t backend_error = 0;
  19815. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19816. ca_cert_dir_path_, custom_ca_loaded_,
  19817. system_ca_mode_, backend_error);
  19818. certs_loaded_ = true;
  19819. }
  19820. detail::ClientTlsSessionOptions options;
  19821. options.server_hostname_verification = server_hostname_verification_;
  19822. detail::ClientTlsSessionError tls_error;
  19823. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19824. server_certificate_verification_,
  19825. hs_sec, hs_usec, &tls_error,
  19826. options)) {
  19827. error = tls_error.error;
  19828. ssl_error = tls_error.ssl_error;
  19829. ssl_backend_error = tls_error.backend_error;
  19830. return false;
  19831. }
  19832. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19833. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19834. write_timeout_usec_));
  19835. return true;
  19836. }
  19837. #else
  19838. (void)error;
  19839. (void)ssl_error;
  19840. (void)ssl_backend_error;
  19841. (void)hs_sec;
  19842. (void)hs_usec;
  19843. #endif
  19844. strm = std::unique_ptr<Stream>(
  19845. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19846. write_timeout_sec_, write_timeout_usec_));
  19847. return true;
  19848. }
  19849. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19850. #ifdef CPPHTTPLIB_SSL_ENABLED
  19851. auto is_ssl = is_ssl_;
  19852. #else
  19853. auto is_ssl = false;
  19854. #endif
  19855. if (!req.has_header("Host")) {
  19856. req.headers.emplace("Host", detail::make_default_host_header_value(
  19857. host_, port_, is_ssl, address_family_));
  19858. }
  19859. detail::add_default_user_agent_header(req);
  19860. }
  19861. inline Result WebSocketClient::connect() {
  19862. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19863. shutdown_and_close();
  19864. // Check is custom IP or hostname specified for host_
  19865. std::string connect_host;
  19866. std::string ip;
  19867. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19868. auto error = Error::Success;
  19869. sock_ = detail::create_client_socket(
  19870. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19871. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19872. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19873. write_timeout_usec_, interface_, error);
  19874. if (sock_ == INVALID_SOCKET) {
  19875. if (error == Error::Success) { error = Error::Connection; }
  19876. return Result{error, -1, Headers{}};
  19877. }
  19878. std::unique_ptr<Stream> strm;
  19879. auto stream_error = Error::SSLConnection;
  19880. int ssl_error = 0;
  19881. uint64_t ssl_backend_error = 0;
  19882. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19883. shutdown_and_close();
  19884. #ifdef CPPHTTPLIB_SSL_ENABLED
  19885. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19886. #else
  19887. return Result{stream_error, -1, Headers{}};
  19888. #endif
  19889. }
  19890. Request req;
  19891. req.method = "GET";
  19892. req.path = path_;
  19893. req.headers = headers_;
  19894. prepare_default_headers(req);
  19895. detail::WebSocketUpgradeResponse upgrade;
  19896. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19897. shutdown_and_close();
  19898. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19899. }
  19900. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19901. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19902. websocket_ping_interval_sec_,
  19903. websocket_max_missed_pongs_));
  19904. // The stream was created with the timeout already; tell the WebSocket
  19905. // whether it came from the caller, so read() knows to report it as Timeout.
  19906. ws_->read_timeout_set_ = read_timeout_set_;
  19907. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19908. }
  19909. inline ReadResult WebSocketClient::read(std::string &msg) {
  19910. if (!ws_) { return Fail; }
  19911. return ws_->read(msg);
  19912. }
  19913. inline bool WebSocketClient::send(const std::string &data) {
  19914. if (!ws_) { return false; }
  19915. return ws_->send(data);
  19916. }
  19917. inline bool WebSocketClient::send(const char *data, size_t len) {
  19918. if (!ws_) { return false; }
  19919. return ws_->send(data, len);
  19920. }
  19921. inline void WebSocketClient::close(CloseStatus status,
  19922. const std::string &reason) {
  19923. if (ws_) { ws_->close(status, reason); }
  19924. }
  19925. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19926. inline const std::string &WebSocketClient::subprotocol() const {
  19927. return subprotocol_;
  19928. }
  19929. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19930. read_timeout_sec_ = sec;
  19931. read_timeout_usec_ = usec;
  19932. read_timeout_set_ = true;
  19933. // The members above only seed the next connect(); read() consults the
  19934. // stream, so an already-open connection has to be told directly.
  19935. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19936. }
  19937. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19938. write_timeout_sec_ = sec;
  19939. write_timeout_usec_ = usec;
  19940. }
  19941. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19942. websocket_ping_interval_sec_ = sec;
  19943. }
  19944. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19945. websocket_max_missed_pongs_ = count;
  19946. }
  19947. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19948. inline void WebSocketClient::set_address_family(int family) {
  19949. address_family_ = family;
  19950. }
  19951. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19952. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19953. socket_options_ = std::move(socket_options);
  19954. }
  19955. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19956. connection_timeout_sec_ = sec;
  19957. connection_timeout_usec_ = usec;
  19958. }
  19959. inline void WebSocketClient::set_interface(const std::string &intf) {
  19960. interface_ = intf;
  19961. }
  19962. inline void WebSocketClient::set_hostname_addr_map(
  19963. std::map<std::string, std::string> addr_map) {
  19964. addr_map_ = std::move(addr_map);
  19965. }
  19966. #ifdef CPPHTTPLIB_SSL_ENABLED
  19967. inline void
  19968. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19969. const std::string &ca_cert_dir_path) {
  19970. ca_cert_file_path_ = ca_cert_file_path;
  19971. ca_cert_dir_path_ = ca_cert_dir_path;
  19972. }
  19973. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19974. if (store && tls_ctx_) {
  19975. // set_ca_store takes ownership of store
  19976. tls::set_ca_store(tls_ctx_, store);
  19977. custom_ca_loaded_ = true;
  19978. } else if (store) {
  19979. tls::free_ca_store(store);
  19980. }
  19981. }
  19982. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19983. std::size_t size) {
  19984. if (tls_ctx_ && ca_cert && size > 0) {
  19985. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19986. custom_ca_loaded_ = true;
  19987. }
  19988. }
  19989. inline void
  19990. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19991. server_certificate_verification_ = enabled;
  19992. }
  19993. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19994. server_hostname_verification_ = enabled;
  19995. }
  19996. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19997. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19998. }
  19999. #endif // CPPHTTPLIB_SSL_ENABLED
  20000. } // namespace ws
  20001. // ----------------------------------------------------------------------------
  20002. } // namespace httplib
  20003. #endif // CPPHTTPLIB_HTTPLIB_H