httplib.h 835 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212
  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.63.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003f00"
  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_INTERIM_RESPONSE_MAX_COUNT
  104. #define CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT 100
  105. #endif
  106. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  107. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  108. #endif
  109. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  110. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  111. #endif
  112. // How much of an unread request body the server skips to reuse the connection,
  113. // 0 for no limit
  114. #ifndef CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH
  115. #define CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH (256 * 1024) // 256KB
  116. #endif
  117. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  118. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  119. #endif
  120. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  121. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  122. #endif
  123. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  124. // 1400 rather than a round number: a body that already fits in one 1500-byte
  125. // MTU gains nothing from being made smaller.
  126. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  127. #endif
  128. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  129. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  130. #endif
  131. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  132. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  133. #endif
  134. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  135. // recurses roughly once per matched character for quantified patterns such
  136. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  137. // a default ~8MB thread stack that has been observed to take on the order of
  138. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  139. // margin below that (well under the 8192-byte request URI limit) while still
  140. // fitting any realistic route segment; raise it if a route legitimately needs
  141. // longer paths. Regex routes are never applied to paths longer than this.
  142. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  143. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  144. #endif
  145. #ifndef CPPHTTPLIB_TCP_NODELAY
  146. #define CPPHTTPLIB_TCP_NODELAY false
  147. #endif
  148. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  149. #define CPPHTTPLIB_IPV6_V6ONLY false
  150. #endif
  151. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  152. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  153. #endif
  154. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  155. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  156. #endif
  157. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  158. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  159. #endif
  160. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  161. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  162. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  163. ? std::thread::hardware_concurrency() - 1 \
  164. : 0))
  165. #endif
  166. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  167. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  168. #endif
  169. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  170. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  171. #endif
  172. #ifndef CPPHTTPLIB_RECV_FLAGS
  173. #define CPPHTTPLIB_RECV_FLAGS 0
  174. #endif
  175. #ifndef CPPHTTPLIB_SEND_FLAGS
  176. #define CPPHTTPLIB_SEND_FLAGS 0
  177. #endif
  178. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  179. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  180. #endif
  181. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  182. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  183. #endif
  184. // These bound the parsing of every request, so 0 cannot lift them.
  185. static_assert(CPPHTTPLIB_REQUEST_URI_MAX_LENGTH > 0,
  186. "CPPHTTPLIB_REQUEST_URI_MAX_LENGTH must be positive");
  187. static_assert(CPPHTTPLIB_HEADER_MAX_LENGTH > 0,
  188. "CPPHTTPLIB_HEADER_MAX_LENGTH must be positive");
  189. static_assert(CPPHTTPLIB_HEADER_MAX_COUNT > 0,
  190. "CPPHTTPLIB_HEADER_MAX_COUNT must be positive");
  191. static_assert(CPPHTTPLIB_MAX_LINE_LENGTH > 0,
  192. "CPPHTTPLIB_MAX_LINE_LENGTH must be positive");
  193. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  194. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  195. #endif
  196. // One macro used to set the read timeout for both sides. They want different
  197. // defaults: a client's read timeout is the caller's own tool (it waits forever
  198. // until asked not to), while a server keeps a ceiling that reclaims a worker
  199. // from a peer that has gone quiet. The old name still works and sets both.
  200. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  201. #pragma message( \
  202. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  203. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  204. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  205. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  207. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  208. #endif
  209. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  210. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  211. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  212. #endif
  213. #endif
  214. // 0 waits forever. A read timeout is how a caller gets control back to send on
  215. // the same connection; it is not a liveness check (that is ping/pong). Only a
  216. // timeout set at runtime through set_read_timeout() is reported as
  217. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  218. // ws::Fail and closes the connection.
  219. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  220. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  221. #endif
  222. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  223. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  224. #endif
  225. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  226. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  227. #endif
  228. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  229. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  230. #endif
  231. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  232. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  233. #endif
  234. /*
  235. * Headers
  236. */
  237. #ifdef _WIN32
  238. #ifndef _CRT_SECURE_NO_WARNINGS
  239. #define _CRT_SECURE_NO_WARNINGS
  240. #endif //_CRT_SECURE_NO_WARNINGS
  241. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  242. #define _CRT_NONSTDC_NO_DEPRECATE
  243. #endif //_CRT_NONSTDC_NO_DEPRECATE
  244. #if defined(_MSC_VER)
  245. #if _MSC_VER < 1900
  246. #error Sorry, Visual Studio versions prior to 2015 are not supported
  247. #endif
  248. #pragma comment(lib, "ws2_32.lib")
  249. #ifndef _SSIZE_T_DEFINED
  250. using ssize_t = __int64;
  251. #define _SSIZE_T_DEFINED
  252. #endif
  253. #endif // _MSC_VER
  254. #ifndef S_ISREG
  255. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  256. #endif // S_ISREG
  257. #ifndef S_ISDIR
  258. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  259. #endif // S_ISDIR
  260. #ifndef NOMINMAX
  261. #define NOMINMAX
  262. #endif // NOMINMAX
  263. #include <io.h>
  264. #include <winsock2.h>
  265. #include <ws2tcpip.h>
  266. #if defined(__has_include)
  267. #if __has_include(<afunix.h>)
  268. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  269. #include <afunix.h>
  270. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  271. #endif
  272. #endif
  273. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  274. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  275. #endif
  276. using nfds_t = unsigned long;
  277. using socket_t = SOCKET;
  278. using socklen_t = int;
  279. #else // not _WIN32
  280. #include <arpa/inet.h>
  281. #if !defined(_AIX) && !defined(__MVS__)
  282. #include <ifaddrs.h>
  283. #endif
  284. #ifdef __MVS__
  285. #include <strings.h>
  286. #ifndef NI_MAXHOST
  287. #define NI_MAXHOST 1025
  288. #endif
  289. #endif
  290. #include <net/if.h>
  291. #include <netdb.h>
  292. #include <netinet/in.h>
  293. #ifdef __linux__
  294. #include <resolv.h>
  295. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  296. #endif
  297. #include <csignal>
  298. #include <netinet/tcp.h>
  299. #include <poll.h>
  300. #include <pthread.h>
  301. #include <sys/socket.h>
  302. #include <sys/un.h>
  303. #include <unistd.h>
  304. using socket_t = int;
  305. #ifndef INVALID_SOCKET
  306. #define INVALID_SOCKET (-1)
  307. #endif
  308. #endif //_WIN32
  309. #if defined(__APPLE__)
  310. #include <TargetConditionals.h>
  311. #endif
  312. #include <algorithm>
  313. #include <array>
  314. #include <atomic>
  315. #include <cassert>
  316. #include <chrono>
  317. #include <climits>
  318. #include <condition_variable>
  319. #include <cstdlib>
  320. #include <cstring>
  321. #include <errno.h>
  322. #include <exception>
  323. #include <fcntl.h>
  324. #include <fstream>
  325. #include <functional>
  326. #include <iomanip>
  327. #include <iostream>
  328. #include <iterator>
  329. #include <list>
  330. #include <map>
  331. #include <memory>
  332. #include <mutex>
  333. #include <random>
  334. #include <regex>
  335. #include <set>
  336. #include <sstream>
  337. #include <string>
  338. #include <sys/stat.h>
  339. #include <system_error>
  340. #include <thread>
  341. #include <type_traits>
  342. #include <unordered_map>
  343. #include <unordered_set>
  344. #include <utility>
  345. #include <vector>
  346. // On macOS with a TLS backend, enable Keychain root certificates by default
  347. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  348. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  349. // only; on those platforms the user must provide a CA bundle explicitly.
  350. #if defined(__APPLE__) && defined(__clang__) && \
  351. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  352. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  353. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  354. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  355. #if TARGET_OS_OSX
  356. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  357. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  358. #endif
  359. #endif
  360. #endif
  361. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  362. defined(__APPLE__) && !TARGET_OS_OSX
  363. #error \
  364. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  365. #endif
  366. // On Windows, enable Schannel certificate verification by default
  367. // unless the user explicitly opts out.
  368. #if defined(_WIN32) && \
  369. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  370. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  371. #endif
  372. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  373. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  374. #if TARGET_OS_MAC && defined(__clang__)
  375. #include <CFNetwork/CFHost.h>
  376. #include <CoreFoundation/CoreFoundation.h>
  377. #endif
  378. #endif
  379. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  380. #ifdef _WIN32
  381. #include <wincrypt.h>
  382. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  383. // used
  384. #undef X509_NAME
  385. #undef X509_CERT_PAIR
  386. #undef X509_EXTENSIONS
  387. #undef PKCS7_SIGNER_INFO
  388. #ifdef _MSC_VER
  389. #pragma comment(lib, "crypt32.lib")
  390. #endif
  391. #endif // _WIN32
  392. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  393. #if TARGET_OS_OSX
  394. #include <Security/Security.h>
  395. #endif
  396. #endif
  397. #include <openssl/err.h>
  398. #include <openssl/evp.h>
  399. #include <openssl/rand.h>
  400. #include <openssl/ssl.h>
  401. #include <openssl/x509v3.h>
  402. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  403. #include <openssl/applink.c>
  404. #endif
  405. #include <iostream>
  406. #include <sstream>
  407. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  408. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  409. #error Please use OpenSSL or a current version of BoringSSL
  410. #endif
  411. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  412. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  413. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  414. #endif
  415. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  416. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  417. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  418. // in with this first include group so the version gating below can use it.
  419. #include <mbedtls/error.h>
  420. #include <mbedtls/net_sockets.h>
  421. #include <mbedtls/oid.h>
  422. #include <mbedtls/pk.h>
  423. #include <mbedtls/ssl.h>
  424. #include <mbedtls/version.h>
  425. #include <mbedtls/x509_crt.h>
  426. #if MBEDTLS_VERSION_MAJOR >= 4
  427. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  428. #include <psa/crypto.h>
  429. #else
  430. #include <mbedtls/ctr_drbg.h>
  431. #include <mbedtls/entropy.h>
  432. #include <mbedtls/md5.h>
  433. #include <mbedtls/sha1.h>
  434. #include <mbedtls/sha256.h>
  435. #include <mbedtls/sha512.h>
  436. #endif
  437. #ifdef _WIN32
  438. #include <wincrypt.h>
  439. #ifdef _MSC_VER
  440. #pragma comment(lib, "crypt32.lib")
  441. #endif
  442. #endif // _WIN32
  443. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  444. #if TARGET_OS_OSX
  445. #include <Security/Security.h>
  446. #endif
  447. #endif
  448. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  449. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  450. #if MBEDTLS_VERSION_MAJOR >= 4
  451. #define CPPHTTPLIB_MBEDTLS_V4
  452. #endif
  453. #if MBEDTLS_VERSION_MAJOR >= 3
  454. #define CPPHTTPLIB_MBEDTLS_V3
  455. #endif
  456. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  457. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  458. #include <wolfssl/options.h>
  459. #include <wolfssl/openssl/x509v3.h>
  460. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  461. #ifndef WOLFSSL_GEN_EMAIL
  462. #define WOLFSSL_GEN_EMAIL 1
  463. #endif
  464. #ifndef WOLFSSL_GEN_DNS
  465. #define WOLFSSL_GEN_DNS 2
  466. #endif
  467. #ifndef WOLFSSL_GEN_URI
  468. #define WOLFSSL_GEN_URI 6
  469. #endif
  470. #ifndef WOLFSSL_GEN_IPADD
  471. #define WOLFSSL_GEN_IPADD 7
  472. #endif
  473. #include <wolfssl/ssl.h>
  474. #include <wolfssl/wolfcrypt/hash.h>
  475. #include <wolfssl/wolfcrypt/md5.h>
  476. #include <wolfssl/wolfcrypt/sha256.h>
  477. #include <wolfssl/wolfcrypt/sha512.h>
  478. #ifdef _WIN32
  479. #include <wincrypt.h>
  480. #ifdef _MSC_VER
  481. #pragma comment(lib, "crypt32.lib")
  482. #endif
  483. #endif // _WIN32
  484. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  485. #if TARGET_OS_OSX
  486. #include <Security/Security.h>
  487. #endif
  488. #endif
  489. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  490. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  491. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  492. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  493. #define CPPHTTPLIB_SSL_ENABLED
  494. #endif
  495. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  496. #include <zlib.h>
  497. #endif
  498. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  499. #include <brotli/decode.h>
  500. #include <brotli/encode.h>
  501. #endif
  502. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  503. #include <zstd.h>
  504. #endif
  505. /*
  506. * Declaration
  507. */
  508. namespace httplib {
  509. namespace ws {
  510. class WebSocket;
  511. } // namespace ws
  512. namespace sse {
  513. class SSEClient;
  514. } // namespace sse
  515. namespace detail {
  516. /*
  517. * Backport std::make_unique from C++14.
  518. *
  519. * NOTE: This code came up with the following stackoverflow post:
  520. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  521. *
  522. */
  523. template <class T, class... Args>
  524. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  525. make_unique(Args &&...args) {
  526. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  527. }
  528. template <class T>
  529. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  530. make_unique(std::size_t n) {
  531. typedef typename std::remove_extent<T>::type RT;
  532. return std::unique_ptr<T>(new RT[n]);
  533. }
  534. // Locale-independent ASCII character classification. The <cctype>
  535. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  536. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  537. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  538. // classified without regard to the locale.
  539. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  540. inline bool is_ascii_alpha(char c) {
  541. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  542. }
  543. inline bool is_ascii_alnum(char c) {
  544. return is_ascii_digit(c) || is_ascii_alpha(c);
  545. }
  546. namespace case_ignore {
  547. inline unsigned char to_lower(int c) {
  548. const static unsigned char table[256] = {
  549. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  550. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  551. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  552. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  553. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  554. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  555. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  556. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  557. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  558. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  559. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  560. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  561. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  562. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  563. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  564. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  565. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  566. 255,
  567. };
  568. return table[(unsigned char)(char)c];
  569. }
  570. inline std::string to_lower(const std::string &s) {
  571. std::string result = s;
  572. std::transform(
  573. result.begin(), result.end(), result.begin(),
  574. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  575. return result;
  576. }
  577. inline bool equal(const std::string &a, const std::string &b) {
  578. return a.size() == b.size() &&
  579. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  580. return to_lower(ca) == to_lower(cb);
  581. });
  582. }
  583. // For a literal, without building a std::string from it.
  584. template <size_t N>
  585. inline bool equal(const std::string &a, const char (&b)[N]) {
  586. return a.size() == N - 1 &&
  587. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  588. return to_lower(ca) == to_lower(cb);
  589. });
  590. }
  591. struct equal_to {
  592. bool operator()(const std::string &a, const std::string &b) const {
  593. return equal(a, b);
  594. }
  595. };
  596. struct hash {
  597. size_t operator()(const std::string &key) const {
  598. size_t h = 0;
  599. for (auto c : key) {
  600. // Unsets the 6 high bits of h, therefore no overflow happens
  601. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  602. static_cast<unsigned char>(to_lower(c));
  603. }
  604. return h;
  605. }
  606. };
  607. template <typename T>
  608. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  609. detail::case_ignore::equal_to>;
  610. } // namespace case_ignore
  611. // This is based on
  612. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  613. struct scope_exit {
  614. explicit scope_exit(std::function<void(void)> &&f)
  615. : exit_function(std::move(f)), execute_on_destruction{true} {}
  616. scope_exit(scope_exit &&rhs) noexcept
  617. : exit_function(std::move(rhs.exit_function)),
  618. execute_on_destruction{rhs.execute_on_destruction} {
  619. rhs.release();
  620. }
  621. ~scope_exit() {
  622. if (execute_on_destruction) { this->exit_function(); }
  623. }
  624. void release() { this->execute_on_destruction = false; }
  625. private:
  626. scope_exit(const scope_exit &) = delete;
  627. void operator=(const scope_exit &) = delete;
  628. scope_exit &operator=(scope_exit &&) = delete;
  629. std::function<void(void)> exit_function;
  630. bool execute_on_destruction;
  631. };
  632. // Simple from_chars implementation for integer and double types (C++17
  633. // substitute)
  634. template <typename T> struct from_chars_result {
  635. const char *ptr;
  636. std::errc ec;
  637. };
  638. template <typename T>
  639. inline from_chars_result<T> from_chars(const char *first, const char *last,
  640. T &value, int base = 10) {
  641. value = 0;
  642. const char *p = first;
  643. bool negative = false;
  644. if (p != last && *p == '-') {
  645. negative = true;
  646. ++p;
  647. }
  648. if (p == last) { return {first, std::errc::invalid_argument}; }
  649. auto radix = static_cast<T>(base);
  650. T result = 0;
  651. for (; p != last; ++p) {
  652. char c = *p;
  653. int digit = -1;
  654. if (is_ascii_digit(c)) {
  655. digit = c - '0';
  656. } else if ('a' <= c && c <= 'z') {
  657. digit = c - 'a' + 10;
  658. } else if ('A' <= c && c <= 'Z') {
  659. digit = c - 'A' + 10;
  660. } else {
  661. break;
  662. }
  663. if (digit < 0 || digit >= base) { break; }
  664. auto d = static_cast<T>(digit);
  665. if (result > ((std::numeric_limits<T>::max)() - d) / radix) {
  666. return {p, std::errc::result_out_of_range};
  667. }
  668. result = result * radix + d;
  669. }
  670. if (p == first || (negative && p == first + 1)) {
  671. return {first, std::errc::invalid_argument};
  672. }
  673. value = negative ? T(0) - result : result;
  674. return {p, std::errc{}};
  675. }
  676. // from_chars for double (hand-written, locale-independent)
  677. //
  678. // The only double consumed by this library is the HTTP quality value, whose
  679. // grammar is (RFC 9110 12.4.2):
  680. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  681. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  682. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  683. // '.' always the decimal separator (std::strtod would instead read it from the
  684. // global C locale, mis-parsing q-values once an embedder calls
  685. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  686. // the result to [0, 1], so inputs outside that range need not be distinguished
  687. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  688. // cases that exponent and wide-range handling would introduce.
  689. inline from_chars_result<double> from_chars(const char *first, const char *last,
  690. double &value) {
  691. value = 0.0;
  692. const char *p = first;
  693. // Each 1eN is exactly representable, so a single final division by the
  694. // matching entry yields a correctly-rounded result.
  695. static const double powers_of_ten[] = {
  696. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  697. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  698. const int max_frac_digits =
  699. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  700. // Accumulate digits into a 64-bit integer and remember how many were
  701. // fractional. Two independent caps keep this bounded and safe:
  702. // * accumulation saturates before mantissa could overflow uint64_t, and
  703. // * frac_digits is capped at max_frac_digits so it is always a valid index
  704. // into powers_of_ten (without this an input like "0.000...0" would never
  705. // grow mantissa, so the saturation cap alone would not bound it).
  706. // Both caps only drop digits far beyond the precision a q-value needs; any
  707. // value they would change is well outside [0, 1] and rejected by the caller.
  708. uint64_t mantissa = 0;
  709. int frac_digits = 0;
  710. bool seen_digit = false;
  711. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  712. auto accumulate = [&](char c) {
  713. if (mantissa <= limit) {
  714. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  715. return true;
  716. }
  717. return false;
  718. };
  719. for (; p != last && is_ascii_digit(*p); ++p) {
  720. seen_digit = true;
  721. accumulate(*p);
  722. }
  723. if (p != last && *p == '.') {
  724. ++p;
  725. for (; p != last && is_ascii_digit(*p); ++p) {
  726. seen_digit = true;
  727. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  728. }
  729. }
  730. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  731. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  732. return {p, std::errc{}};
  733. }
  734. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  735. int &out) {
  736. int val = 0;
  737. auto r = from_chars(s, s + len, val);
  738. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  739. return false;
  740. }
  741. out = val;
  742. return true;
  743. }
  744. inline bool parse_port(const char *s, size_t len, int &port) {
  745. return parse_int_in_range(s, len, 1, 65535, port);
  746. }
  747. inline bool parse_port(const std::string &s, int &port) {
  748. return parse_port(s.data(), s.size(), port);
  749. }
  750. struct UrlComponents {
  751. std::string scheme;
  752. std::string host;
  753. std::string port;
  754. std::string path;
  755. std::string query;
  756. };
  757. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  758. uc = {};
  759. size_t pos = 0;
  760. auto sep = url.find("://");
  761. if (sep != std::string::npos) {
  762. uc.scheme = url.substr(0, sep);
  763. // Scheme must be [a-z]+ only
  764. if (uc.scheme.empty()) { return false; }
  765. for (auto c : uc.scheme) {
  766. if (c < 'a' || c > 'z') { return false; }
  767. }
  768. pos = sep + 3;
  769. } else if (url.compare(0, 2, "//") == 0) {
  770. pos = 2;
  771. }
  772. auto has_authority_prefix = pos > 0;
  773. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  774. url[0] != '?' && url[0] != '#');
  775. if (has_authority) {
  776. // userinfo is not supported, and a backslash that some parsers take for
  777. // '/' would leave them seeing another host than this one.
  778. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  779. return false;
  780. }
  781. if (pos < url.size() && url[pos] == '[') {
  782. auto close = url.find(']', pos);
  783. if (close == std::string::npos) { return false; }
  784. uc.host = url.substr(pos + 1, close - pos - 1);
  785. // IPv6 host must be [a-fA-F0-9:]+ only
  786. if (uc.host.empty()) { return false; }
  787. for (auto c : uc.host) {
  788. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  789. (c >= 'A' && c <= 'F') || c == ':')) {
  790. return false;
  791. }
  792. }
  793. pos = close + 1;
  794. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  795. // path, query or fragment delimiter (or the end of input). Otherwise the
  796. // trailing bytes would be folded into the path while the connection
  797. // still targets the bracketed address.
  798. if (pos < url.size()) {
  799. auto c = url[pos];
  800. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  801. }
  802. } else {
  803. auto end = url.find_first_of(":/?#", pos);
  804. if (end == std::string::npos) { end = url.size(); }
  805. uc.host = url.substr(pos, end - pos);
  806. pos = end;
  807. }
  808. if (pos < url.size() && url[pos] == ':') {
  809. ++pos;
  810. auto end = url.find_first_of("/?#", pos);
  811. if (end == std::string::npos) { end = url.size(); }
  812. uc.port = url.substr(pos, end - pos);
  813. pos = end;
  814. }
  815. // Without :// or //, the entire input must be consumed as host[:port].
  816. // If there is leftover (path, query, etc.), this is not a valid
  817. // host[:port] string — clear and reparse as a plain path.
  818. if (!has_authority_prefix && pos < url.size()) {
  819. uc.host.clear();
  820. uc.port.clear();
  821. pos = 0;
  822. }
  823. }
  824. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  825. auto end = url.find_first_of("?#", pos);
  826. if (end == std::string::npos) { end = url.size(); }
  827. uc.path = url.substr(pos, end - pos);
  828. pos = end;
  829. }
  830. if (pos < url.size() && url[pos] == '?') {
  831. auto end = url.find('#', pos);
  832. if (end == std::string::npos) { end = url.size(); }
  833. uc.query = url.substr(pos, end - pos);
  834. }
  835. return true;
  836. }
  837. // Resolves a relative-path or query-only Location value against the path of
  838. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  839. // references starting with '/' are returned unchanged.
  840. inline std::string resolve_relative_location(const std::string &location,
  841. const std::string &base) {
  842. if (location.empty() || location[0] == '/') { return location; }
  843. // A ':' in the first segment means the value has a scheme.
  844. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  845. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  846. auto base_path = base.substr(0, base.find_first_of("?#"));
  847. if (location[0] == '?') { return base_path + location; }
  848. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  849. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  850. // Remove "." and ".." segments from the merged path.
  851. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  852. std::string path;
  853. size_t i = 0;
  854. while (i < path_end) {
  855. auto next = (std::min)(merged.find('/', i + 1), path_end);
  856. auto segment = merged.substr(i + 1, next - i - 1);
  857. auto is_last = next == path_end;
  858. if (segment == "." || segment == "..") {
  859. if (segment == "..") {
  860. path.erase((std::min)(path.rfind('/'), path.size()));
  861. }
  862. if (is_last) { path += '/'; }
  863. } else {
  864. path += '/';
  865. path += segment;
  866. }
  867. i = next;
  868. }
  869. if (path.empty()) { path = "/"; }
  870. return path + merged.substr(path_end);
  871. }
  872. } // namespace detail
  873. enum class SSLVerifierResponse {
  874. // no decision has been made, use the built-in certificate verifier
  875. NoDecisionMade,
  876. // connection certificate is verified and accepted
  877. CertificateAccepted,
  878. // connection certificate was processed but is rejected
  879. CertificateRejected
  880. };
  881. // System CA loading policy for SSL clients. Auto (the default) loads system
  882. // CA certs only when no custom CA is configured; enable_system_ca() switches
  883. // to an explicit policy.
  884. enum class SystemCAMode { Auto, Enabled, Disabled };
  885. enum StatusCode {
  886. // Information responses
  887. Continue_100 = 100,
  888. SwitchingProtocol_101 = 101,
  889. Processing_102 = 102,
  890. EarlyHints_103 = 103,
  891. // Successful responses
  892. OK_200 = 200,
  893. Created_201 = 201,
  894. Accepted_202 = 202,
  895. NonAuthoritativeInformation_203 = 203,
  896. NoContent_204 = 204,
  897. ResetContent_205 = 205,
  898. PartialContent_206 = 206,
  899. MultiStatus_207 = 207,
  900. AlreadyReported_208 = 208,
  901. IMUsed_226 = 226,
  902. // Redirection messages
  903. MultipleChoices_300 = 300,
  904. MovedPermanently_301 = 301,
  905. Found_302 = 302,
  906. SeeOther_303 = 303,
  907. NotModified_304 = 304,
  908. UseProxy_305 = 305,
  909. unused_306 = 306,
  910. TemporaryRedirect_307 = 307,
  911. PermanentRedirect_308 = 308,
  912. // Client error responses
  913. BadRequest_400 = 400,
  914. Unauthorized_401 = 401,
  915. PaymentRequired_402 = 402,
  916. Forbidden_403 = 403,
  917. NotFound_404 = 404,
  918. MethodNotAllowed_405 = 405,
  919. NotAcceptable_406 = 406,
  920. ProxyAuthenticationRequired_407 = 407,
  921. RequestTimeout_408 = 408,
  922. Conflict_409 = 409,
  923. Gone_410 = 410,
  924. LengthRequired_411 = 411,
  925. PreconditionFailed_412 = 412,
  926. PayloadTooLarge_413 = 413,
  927. UriTooLong_414 = 414,
  928. UnsupportedMediaType_415 = 415,
  929. RangeNotSatisfiable_416 = 416,
  930. ExpectationFailed_417 = 417,
  931. ImATeapot_418 = 418,
  932. MisdirectedRequest_421 = 421,
  933. UnprocessableContent_422 = 422,
  934. Locked_423 = 423,
  935. FailedDependency_424 = 424,
  936. TooEarly_425 = 425,
  937. UpgradeRequired_426 = 426,
  938. PreconditionRequired_428 = 428,
  939. TooManyRequests_429 = 429,
  940. RequestHeaderFieldsTooLarge_431 = 431,
  941. UnavailableForLegalReasons_451 = 451,
  942. // Server error responses
  943. InternalServerError_500 = 500,
  944. NotImplemented_501 = 501,
  945. BadGateway_502 = 502,
  946. ServiceUnavailable_503 = 503,
  947. GatewayTimeout_504 = 504,
  948. HttpVersionNotSupported_505 = 505,
  949. VariantAlsoNegotiates_506 = 506,
  950. InsufficientStorage_507 = 507,
  951. LoopDetected_508 = 508,
  952. NotExtended_510 = 510,
  953. NetworkAuthenticationRequired_511 = 511,
  954. };
  955. namespace detail {
  956. // A multimap that keeps its entries in the order they were inserted.
  957. //
  958. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  959. // fields sharing a field name significant and forbids a proxy from reordering
  960. // them, and a query string's parameters are meaningful in the order the caller
  961. // wrote them. Neither standard container expresses it: std::unordered_multimap
  962. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  963. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  964. // key, which would drop control data such as Host behind whatever else the
  965. // message carries and alphabetise a query string.
  966. //
  967. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  968. // scan, which beats hashing for the handful of entries a message carries
  969. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  970. //
  971. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  972. // Params, whose parameter names are case-sensitive, not.
  973. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  974. public:
  975. using key_type = std::string;
  976. using mapped_type = Mapped;
  977. using value_type = std::pair<std::string, Mapped>;
  978. using size_type = std::size_t;
  979. using difference_type = std::ptrdiff_t;
  980. using reference = value_type &;
  981. using const_reference = const value_type &;
  982. private:
  983. static size_type npos() { return static_cast<size_type>(-1); }
  984. static bool keys_equal(const std::string &a, const std::string &b) {
  985. return KeyEqual()(a, b);
  986. }
  987. // Iterating yields every entry in insertion order, but equal_range() and
  988. // find() have to walk only the entries sharing one key, which are not
  989. // adjacent. Both are the same iterator type: key_idx_ selects between the
  990. // two traversals, and since equality compares only the position, an iterator
  991. // restricted to one key still compares equal to end().
  992. template <typename V> class iterator_t {
  993. public:
  994. using iterator_category = std::bidirectional_iterator_tag;
  995. using value_type = insertion_ordered_multimap::value_type;
  996. using difference_type = insertion_ordered_multimap::difference_type;
  997. using pointer = V *;
  998. using reference = V &;
  999. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  1000. template <typename U,
  1001. typename std::enable_if<std::is_convertible<U *, V *>::value,
  1002. int>::type = 0>
  1003. iterator_t(const iterator_t<U> &rhs)
  1004. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  1005. key_idx_(rhs.key_idx_) {}
  1006. reference operator*() const { return data_[idx_]; }
  1007. pointer operator->() const { return data_ + idx_; }
  1008. iterator_t &operator++() {
  1009. // Saturating, so that advancing past the last entry of a key stays at
  1010. // end() instead of running off the container.
  1011. if (idx_ >= size_) { return *this; }
  1012. ++idx_;
  1013. if (key_idx_ != npos()) {
  1014. while (idx_ < size_ && !matches(idx_)) {
  1015. ++idx_;
  1016. }
  1017. }
  1018. return *this;
  1019. }
  1020. iterator_t operator++(int) {
  1021. auto tmp = *this;
  1022. ++*this;
  1023. return tmp;
  1024. }
  1025. iterator_t &operator--() {
  1026. if (idx_ == 0) { return *this; }
  1027. --idx_;
  1028. if (key_idx_ != npos()) {
  1029. while (idx_ > 0 && !matches(idx_)) {
  1030. --idx_;
  1031. }
  1032. }
  1033. return *this;
  1034. }
  1035. iterator_t operator--(int) {
  1036. auto tmp = *this;
  1037. --*this;
  1038. return tmp;
  1039. }
  1040. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1041. return idx_ == rhs.idx_;
  1042. }
  1043. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1044. return idx_ != rhs.idx_;
  1045. }
  1046. private:
  1047. friend class insertion_ordered_multimap;
  1048. template <typename> friend class iterator_t;
  1049. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1050. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1051. bool matches(size_type i) const {
  1052. return keys_equal(data_[i].first, data_[key_idx_].first);
  1053. }
  1054. V *data_;
  1055. size_type idx_;
  1056. size_type size_;
  1057. size_type key_idx_;
  1058. };
  1059. public:
  1060. using iterator = iterator_t<value_type>;
  1061. using const_iterator = iterator_t<const value_type>;
  1062. insertion_ordered_multimap() = default;
  1063. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1064. : entries_(il) {}
  1065. template <typename InputIt>
  1066. insertion_ordered_multimap(InputIt first, InputIt last)
  1067. : entries_(first, last) {}
  1068. iterator begin() { return make_iter(0, npos()); }
  1069. iterator end() { return make_iter(entries_.size(), npos()); }
  1070. const_iterator begin() const { return make_citer(0, npos()); }
  1071. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1072. const_iterator cbegin() const { return begin(); }
  1073. const_iterator cend() const { return end(); }
  1074. bool empty() const { return entries_.empty(); }
  1075. size_type size() const { return entries_.size(); }
  1076. void clear() { entries_.clear(); }
  1077. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1078. iterator insert(const value_type &val) {
  1079. entries_.push_back(val);
  1080. return make_iter(entries_.size() - 1, npos());
  1081. }
  1082. iterator insert(value_type &&val) {
  1083. entries_.push_back(std::move(val));
  1084. return make_iter(entries_.size() - 1, npos());
  1085. }
  1086. template <typename... Args> iterator emplace(Args &&...args) {
  1087. entries_.emplace_back(std::forward<Args>(args)...);
  1088. return make_iter(entries_.size() - 1, npos());
  1089. }
  1090. // For entries that have to lead the message, such as the Host header field
  1091. // (RFC 9110 5.3 recommends sending control data first).
  1092. template <typename... Args> iterator emplace_front(Args &&...args) {
  1093. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1094. return make_iter(0, npos());
  1095. }
  1096. iterator find(const std::string &key) {
  1097. auto i = index_of(key);
  1098. return i == npos() ? end() : make_iter(i, i);
  1099. }
  1100. const_iterator find(const std::string &key) const {
  1101. auto i = index_of(key);
  1102. return i == npos() ? end() : make_citer(i, i);
  1103. }
  1104. size_type count(const std::string &key) const {
  1105. size_type n = 0;
  1106. for (const auto &entry : entries_) {
  1107. if (keys_equal(entry.first, key)) { n++; }
  1108. }
  1109. return n;
  1110. }
  1111. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1112. auto i = index_of(key);
  1113. return i == npos() ? std::make_pair(end(), end())
  1114. : std::make_pair(make_iter(i, i), end());
  1115. }
  1116. std::pair<const_iterator, const_iterator>
  1117. equal_range(const std::string &key) const {
  1118. auto i = index_of(key);
  1119. return i == npos() ? std::make_pair(end(), end())
  1120. : std::make_pair(make_citer(i, i), end());
  1121. }
  1122. size_type erase(const std::string &key) {
  1123. auto before = entries_.size();
  1124. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1125. [&](const value_type &entry) {
  1126. return keys_equal(entry.first, key);
  1127. }),
  1128. entries_.end());
  1129. return before - entries_.size();
  1130. }
  1131. iterator erase(const_iterator pos) {
  1132. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1133. return make_iter(pos.idx_, npos());
  1134. }
  1135. // Erases what iterating [first, last) would actually visit, so erasing an
  1136. // equal_range() removes only the entries with that key, not everything
  1137. // positioned between them.
  1138. iterator erase(const_iterator first, const_iterator last) {
  1139. auto from = first.idx_;
  1140. auto to = last.idx_;
  1141. if (from >= to) { return make_iter(from, npos()); }
  1142. auto begin_it = entries_.begin();
  1143. auto from_it = begin_it + static_cast<difference_type>(from);
  1144. auto to_it = begin_it + static_cast<difference_type>(to);
  1145. if (first.key_idx_ == npos()) {
  1146. entries_.erase(from_it, to_it);
  1147. } else {
  1148. auto key = entries_[first.key_idx_].first;
  1149. auto keep = from_it;
  1150. for (auto it = from_it; it != to_it; ++it) {
  1151. if (!keys_equal(it->first, key)) {
  1152. if (keep != it) { *keep = std::move(*it); }
  1153. ++keep;
  1154. }
  1155. }
  1156. if (keep != to_it) {
  1157. keep = std::move(to_it, entries_.end(), keep);
  1158. } else {
  1159. keep = entries_.end();
  1160. }
  1161. entries_.erase(keep, entries_.end());
  1162. }
  1163. return make_iter(from, npos());
  1164. }
  1165. friend bool operator==(const insertion_ordered_multimap &lhs,
  1166. const insertion_ordered_multimap &rhs) {
  1167. return lhs.entries_ == rhs.entries_;
  1168. }
  1169. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1170. const insertion_ordered_multimap &rhs) {
  1171. return !(lhs == rhs);
  1172. }
  1173. private:
  1174. size_type index_of(const std::string &key) const {
  1175. for (size_type i = 0; i < entries_.size(); i++) {
  1176. if (keys_equal(entries_[i].first, key)) { return i; }
  1177. }
  1178. return npos();
  1179. }
  1180. iterator make_iter(size_type idx, size_type key_idx) {
  1181. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1182. }
  1183. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1184. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1185. }
  1186. std::vector<value_type> entries_;
  1187. };
  1188. } // namespace detail
  1189. using Headers =
  1190. detail::insertion_ordered_multimap<std::string,
  1191. detail::case_ignore::equal_to>;
  1192. // Query parameter names are case-sensitive, unlike header field names.
  1193. using Params =
  1194. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1195. using Match = std::smatch;
  1196. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1197. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1198. /*
  1199. * detail: type-erased storage used by UserData.
  1200. * ABI-stable regardless of C++ standard — always uses this custom
  1201. * implementation instead of std::any.
  1202. */
  1203. namespace detail {
  1204. using any_type_id = const void *;
  1205. template <typename T> any_type_id any_typeid() noexcept {
  1206. static const char id = 0;
  1207. return &id;
  1208. }
  1209. struct any_storage {
  1210. virtual ~any_storage() = default;
  1211. virtual std::unique_ptr<any_storage> clone() const = 0;
  1212. virtual any_type_id type_id() const noexcept = 0;
  1213. };
  1214. template <typename T> struct any_value final : any_storage {
  1215. T value;
  1216. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1217. std::unique_ptr<any_storage> clone() const override {
  1218. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1219. }
  1220. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1221. };
  1222. } // namespace detail
  1223. class UserData {
  1224. public:
  1225. UserData() = default;
  1226. UserData(UserData &&) noexcept = default;
  1227. UserData &operator=(UserData &&) noexcept = default;
  1228. UserData(const UserData &o) {
  1229. for (const auto &e : o.entries_) {
  1230. if (e.second) { entries_[e.first] = e.second->clone(); }
  1231. }
  1232. }
  1233. UserData &operator=(const UserData &o) {
  1234. if (this != &o) {
  1235. entries_.clear();
  1236. for (const auto &e : o.entries_) {
  1237. if (e.second) { entries_[e.first] = e.second->clone(); }
  1238. }
  1239. }
  1240. return *this;
  1241. }
  1242. template <typename T> void set(const std::string &key, T &&value) {
  1243. using D = typename std::decay<T>::type;
  1244. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1245. }
  1246. template <typename T> T *get(const std::string &key) noexcept {
  1247. auto it = entries_.find(key);
  1248. if (it == entries_.end() || !it->second) { return nullptr; }
  1249. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1250. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1251. }
  1252. template <typename T> const T *get(const std::string &key) const noexcept {
  1253. auto it = entries_.find(key);
  1254. if (it == entries_.end() || !it->second) { return nullptr; }
  1255. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1256. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1257. }
  1258. bool has(const std::string &key) const noexcept {
  1259. return entries_.find(key) != entries_.end();
  1260. }
  1261. void erase(const std::string &key) { entries_.erase(key); }
  1262. void clear() noexcept { entries_.clear(); }
  1263. private:
  1264. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1265. entries_;
  1266. };
  1267. struct Response;
  1268. using ResponseHandler = std::function<bool(const Response &response)>;
  1269. struct FormData {
  1270. std::string name;
  1271. std::string content;
  1272. std::string filename;
  1273. std::string content_type;
  1274. Headers headers;
  1275. };
  1276. struct FormField {
  1277. std::string name;
  1278. std::string content;
  1279. Headers headers;
  1280. };
  1281. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1282. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1283. // should see the parts as they were sent. A std::multimap sorts by field name
  1284. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1285. // than the case-insensitive predicate Headers uses.
  1286. using FormFields =
  1287. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1288. using FormFiles =
  1289. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1290. struct MultipartFormData {
  1291. FormFields fields; // Text fields from multipart
  1292. FormFiles files; // Files from multipart
  1293. // Text field access
  1294. std::string get_field(const std::string &key, size_t id = 0) const;
  1295. std::vector<std::string> get_fields(const std::string &key) const;
  1296. bool has_field(const std::string &key) const;
  1297. size_t get_field_count(const std::string &key) const;
  1298. // File access
  1299. FormData get_file(const std::string &key, size_t id = 0) const;
  1300. std::vector<FormData> get_files(const std::string &key) const;
  1301. bool has_file(const std::string &key) const;
  1302. size_t get_file_count(const std::string &key) const;
  1303. };
  1304. struct UploadFormData {
  1305. std::string name;
  1306. std::string content;
  1307. std::string filename;
  1308. std::string content_type;
  1309. };
  1310. using UploadFormDataItems = std::vector<UploadFormData>;
  1311. class DataSink {
  1312. public:
  1313. DataSink() : os(&sb_), sb_(*this) {}
  1314. DataSink(const DataSink &) = delete;
  1315. DataSink &operator=(const DataSink &) = delete;
  1316. DataSink(DataSink &&) = delete;
  1317. DataSink &operator=(DataSink &&) = delete;
  1318. std::function<bool(const char *data, size_t data_len)> write;
  1319. // Only `write` is mandatory. The rest are defaulted so that a provider
  1320. // calling one on a writer that does not set it gets sensible behaviour
  1321. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1322. // `this` is safe: DataSink is neither copyable nor movable.
  1323. std::function<bool()> is_writable = []() { return true; };
  1324. std::function<void()> done = []() {};
  1325. std::function<void(const Headers &trailer)> done_with_trailer =
  1326. [this](const Headers & /*trailer*/) { done(); };
  1327. std::ostream os;
  1328. private:
  1329. class data_sink_streambuf final : public std::streambuf {
  1330. public:
  1331. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1332. protected:
  1333. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1334. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1335. return 0;
  1336. }
  1337. private:
  1338. DataSink &sink_;
  1339. };
  1340. data_sink_streambuf sb_;
  1341. };
  1342. using ContentProvider =
  1343. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1344. using ContentProviderWithoutLength =
  1345. std::function<bool(size_t offset, DataSink &sink)>;
  1346. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1347. struct FormDataProvider {
  1348. std::string name;
  1349. ContentProviderWithoutLength provider;
  1350. std::string filename;
  1351. std::string content_type;
  1352. };
  1353. using FormDataProviderItems = std::vector<FormDataProvider>;
  1354. inline FormDataProvider
  1355. make_file_provider(const std::string &name, const std::string &filepath,
  1356. const std::string &filename = std::string(),
  1357. const std::string &content_type = std::string()) {
  1358. FormDataProvider fdp;
  1359. fdp.name = name;
  1360. fdp.filename = filename.empty() ? filepath : filename;
  1361. fdp.content_type = content_type;
  1362. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1363. std::ifstream f(filepath, std::ios::binary);
  1364. if (!f) { return false; }
  1365. if (offset > 0) {
  1366. f.seekg(static_cast<std::streamoff>(offset));
  1367. if (!f.good()) {
  1368. sink.done();
  1369. return true;
  1370. }
  1371. }
  1372. char buf[8192];
  1373. f.read(buf, sizeof(buf));
  1374. auto n = static_cast<size_t>(f.gcount());
  1375. if (n > 0) { return sink.write(buf, n); }
  1376. sink.done(); // EOF
  1377. return true;
  1378. };
  1379. return fdp;
  1380. }
  1381. inline std::pair<size_t, ContentProvider>
  1382. make_file_body(const std::string &filepath) {
  1383. size_t size = 0;
  1384. {
  1385. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1386. if (!f) { return {0, ContentProvider{}}; }
  1387. size = static_cast<size_t>(f.tellg());
  1388. }
  1389. ContentProvider provider = [filepath](size_t offset, size_t length,
  1390. DataSink &sink) -> bool {
  1391. std::ifstream f(filepath, std::ios::binary);
  1392. if (!f) { return false; }
  1393. f.seekg(static_cast<std::streamoff>(offset));
  1394. if (!f.good()) { return false; }
  1395. char buf[8192];
  1396. while (length > 0) {
  1397. auto to_read = (std::min)(sizeof(buf), length);
  1398. f.read(buf, static_cast<std::streamsize>(to_read));
  1399. auto n = static_cast<size_t>(f.gcount());
  1400. // The file is shorter than the size make_file_body() measured, which the
  1401. // caller has already committed to as Content-Length. The body cannot be
  1402. // completed, so fail as every other error here does.
  1403. if (n == 0) { return false; }
  1404. if (!sink.write(buf, n)) { return false; }
  1405. length -= n;
  1406. }
  1407. return true;
  1408. };
  1409. return {size, std::move(provider)};
  1410. }
  1411. using ContentReceiverWithProgress = std::function<bool(
  1412. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1413. using ContentReceiver =
  1414. std::function<bool(const char *data, size_t data_length)>;
  1415. using FormDataHeader = std::function<bool(const FormData &file)>;
  1416. class ContentReader {
  1417. public:
  1418. using Reader = std::function<bool(ContentReceiver receiver)>;
  1419. using FormDataReader =
  1420. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1421. ContentReader(Reader reader, FormDataReader multipart_reader)
  1422. : reader_(std::move(reader)),
  1423. formdata_reader_(std::move(multipart_reader)) {}
  1424. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1425. return formdata_reader_(std::move(header), std::move(receiver));
  1426. }
  1427. bool operator()(ContentReceiver receiver) const {
  1428. return reader_(std::move(receiver));
  1429. }
  1430. Reader reader_;
  1431. FormDataReader formdata_reader_;
  1432. };
  1433. using Range = std::pair<ssize_t, ssize_t>;
  1434. using Ranges = std::vector<Range>;
  1435. #ifdef CPPHTTPLIB_SSL_ENABLED
  1436. // TLS abstraction layer - public type definitions and API
  1437. namespace tls {
  1438. // Opaque handles (defined as void* for abstraction)
  1439. using ctx_t = void *;
  1440. using session_t = void *;
  1441. using const_session_t = const void *; // For read-only session access
  1442. using cert_t = void *;
  1443. using ca_store_t = void *;
  1444. // TLS versions
  1445. enum class Version {
  1446. TLS1_2 = 0x0303,
  1447. TLS1_3 = 0x0304,
  1448. };
  1449. // Subject Alternative Names (SAN) entry types
  1450. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1451. // SAN entry structure
  1452. struct SanEntry {
  1453. SanType type;
  1454. std::string value;
  1455. };
  1456. // Verification context for certificate verification callback
  1457. struct VerifyContext {
  1458. session_t session; // TLS session handle
  1459. cert_t cert; // Current certificate being verified
  1460. int depth; // Certificate chain depth (0 = leaf)
  1461. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1462. long error_code; // Backend-specific error code (0 = no error)
  1463. const char *error_string; // Human-readable error description
  1464. // Certificate introspection methods
  1465. std::string subject_cn() const;
  1466. std::string issuer_name() const;
  1467. bool check_hostname(const char *hostname) const;
  1468. std::vector<SanEntry> sans() const;
  1469. bool validity(time_t &not_before, time_t &not_after) const;
  1470. std::string serial() const;
  1471. };
  1472. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1473. // TlsError codes for TLS operations (backend-independent)
  1474. enum class ErrorCode : int {
  1475. Success = 0,
  1476. WantRead, // Non-blocking: need to wait for read
  1477. WantWrite, // Non-blocking: need to wait for write
  1478. PeerClosed, // Peer closed the connection
  1479. Fatal, // Unrecoverable error
  1480. SyscallError, // System call error (check sys_errno)
  1481. CertVerifyFailed, // Certificate verification failed
  1482. HostnameMismatch, // Hostname verification failed
  1483. };
  1484. // TLS error information
  1485. struct TlsError {
  1486. ErrorCode code = ErrorCode::Fatal;
  1487. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1488. int sys_errno = 0; // errno when SyscallError
  1489. // Convert verification error code to human-readable string
  1490. static std::string verify_error_to_string(long error_code);
  1491. };
  1492. // RAII wrapper for peer certificate
  1493. class PeerCert {
  1494. public:
  1495. PeerCert();
  1496. PeerCert(PeerCert &&other) noexcept;
  1497. PeerCert &operator=(PeerCert &&other) noexcept;
  1498. ~PeerCert();
  1499. PeerCert(const PeerCert &) = delete;
  1500. PeerCert &operator=(const PeerCert &) = delete;
  1501. explicit operator bool() const;
  1502. std::string subject_cn() const;
  1503. std::string issuer_name() const;
  1504. bool check_hostname(const char *hostname) const;
  1505. std::vector<SanEntry> sans() const;
  1506. bool validity(time_t &not_before, time_t &not_after) const;
  1507. std::string serial() const;
  1508. private:
  1509. explicit PeerCert(cert_t cert);
  1510. cert_t cert_ = nullptr;
  1511. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1512. };
  1513. // Callback for TLS context setup (used by SSLServer constructor)
  1514. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1515. } // namespace tls
  1516. #endif
  1517. struct Request {
  1518. std::string method;
  1519. std::string path;
  1520. std::string matched_route;
  1521. Params params;
  1522. Headers headers;
  1523. Headers trailers;
  1524. std::string body;
  1525. std::string remote_addr;
  1526. int remote_port = -1;
  1527. std::string local_addr;
  1528. int local_port = -1;
  1529. // for server
  1530. std::string version;
  1531. std::string target;
  1532. MultipartFormData form;
  1533. Ranges ranges;
  1534. Match matches;
  1535. std::unordered_map<std::string, std::string> path_params;
  1536. std::function<bool()> is_connection_closed = []() { return true; };
  1537. // for client
  1538. std::vector<std::string> accept_content_types;
  1539. ResponseHandler response_handler;
  1540. ContentReceiverWithProgress content_receiver;
  1541. DownloadProgress download_progress;
  1542. UploadProgress upload_progress;
  1543. bool has_header(const std::string &key) const;
  1544. std::string get_header_value(const std::string &key, const char *def = "",
  1545. size_t id = 0) const;
  1546. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1547. size_t id = 0) const;
  1548. size_t get_header_value_count(const std::string &key) const;
  1549. void set_header(const std::string &key, const std::string &val);
  1550. bool has_trailer(const std::string &key) const;
  1551. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1552. size_t get_trailer_value_count(const std::string &key) const;
  1553. bool has_param(const std::string &key) const;
  1554. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1555. std::vector<std::string> get_param_values(const std::string &key) const;
  1556. size_t get_param_value_count(const std::string &key) const;
  1557. bool is_multipart_form_data() const;
  1558. // private members...
  1559. bool body_read_started_ = false;
  1560. bool body_consumed_ = false;
  1561. bool expect_100_continue_pending_ = false;
  1562. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1563. size_t content_length_ = 0;
  1564. ContentProvider content_provider_;
  1565. bool is_chunked_content_provider_ = false;
  1566. size_t authorization_count_ = 0;
  1567. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1568. (std::chrono::steady_clock::time_point::min)();
  1569. #ifdef CPPHTTPLIB_SSL_ENABLED
  1570. tls::const_session_t ssl = nullptr;
  1571. tls::PeerCert peer_cert() const;
  1572. std::string sni() const;
  1573. #endif
  1574. };
  1575. namespace detail {
  1576. // Declared up here, away from the rest of the compression helpers, because
  1577. // `Response` stores one.
  1578. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1579. } // namespace detail
  1580. struct Response {
  1581. std::string version;
  1582. int status = -1;
  1583. std::string reason;
  1584. Headers headers;
  1585. Headers trailers;
  1586. std::string body;
  1587. std::string location; // Redirect location
  1588. // User-defined context — set by pre-routing/pre-request handlers and read
  1589. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1590. UserData user_data;
  1591. bool has_header(const std::string &key) const;
  1592. std::string get_header_value(const std::string &key, const char *def = "",
  1593. size_t id = 0) const;
  1594. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1595. size_t id = 0) const;
  1596. size_t get_header_value_count(const std::string &key) const;
  1597. void set_header(const std::string &key, const std::string &val);
  1598. bool has_trailer(const std::string &key) const;
  1599. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1600. size_t get_trailer_value_count(const std::string &key) const;
  1601. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1602. void set_content(const char *s, size_t n, const std::string &content_type);
  1603. void set_content(const std::string &s, const std::string &content_type);
  1604. void set_content(std::string &&s, const std::string &content_type);
  1605. void set_content_provider(
  1606. size_t length, const std::string &content_type, ContentProvider provider,
  1607. ContentProviderResourceReleaser resource_releaser = nullptr);
  1608. void set_content_provider(
  1609. const std::string &content_type, ContentProviderWithoutLength provider,
  1610. ContentProviderResourceReleaser resource_releaser = nullptr);
  1611. void set_chunked_content_provider(
  1612. const std::string &content_type, ContentProviderWithoutLength provider,
  1613. ContentProviderResourceReleaser resource_releaser = nullptr);
  1614. void set_file_content(const std::string &path,
  1615. const std::string &content_type);
  1616. void set_file_content(const std::string &path);
  1617. Response() = default;
  1618. Response(const Response &) = default;
  1619. Response &operator=(const Response &) = default;
  1620. Response(Response &&) = default;
  1621. Response &operator=(Response &&) = default;
  1622. ~Response() {
  1623. if (content_provider_resource_releaser_) {
  1624. content_provider_resource_releaser_(content_provider_success_);
  1625. }
  1626. }
  1627. // private members...
  1628. size_t content_length_ = 0;
  1629. ContentProvider content_provider_;
  1630. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1631. bool is_chunked_content_provider_ = false;
  1632. bool is_file_content_provider_ = false;
  1633. bool content_provider_success_ = false;
  1634. std::string file_content_path_;
  1635. std::string file_content_content_type_;
  1636. // Content coding chosen for the response body, decided once so that the
  1637. // headers and the body cannot disagree: where the file is opened for a
  1638. // file-backed content provider (keeping the ETag honest), and in
  1639. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1640. // for every other kind of response.
  1641. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1642. };
  1643. enum class Error {
  1644. Success = 0,
  1645. Unknown,
  1646. Connection,
  1647. BindIPAddress,
  1648. Read,
  1649. Write,
  1650. ExceedRedirectCount,
  1651. Canceled,
  1652. SSLConnection,
  1653. SSLLoadingCerts,
  1654. SSLServerVerification,
  1655. SSLServerHostnameVerification,
  1656. UnsupportedMultipartBoundaryChars,
  1657. Compression,
  1658. ConnectionTimeout,
  1659. ProxyConnection,
  1660. ConnectionClosed,
  1661. Timeout,
  1662. ResourceExhaustion,
  1663. TooManyFormDataFiles,
  1664. ExceedMaxPayloadSize,
  1665. ExceedUriMaxLength,
  1666. ExceedMaxSocketDescriptorCount,
  1667. InvalidRequestLine,
  1668. InvalidHTTPMethod,
  1669. InvalidHTTPVersion,
  1670. InvalidHeaders,
  1671. MultipartParsing,
  1672. OpenFile,
  1673. Listen,
  1674. GetSockName,
  1675. UnsupportedAddressFamily,
  1676. HTTPParsing,
  1677. InvalidRangeHeader,
  1678. UnsupportedContentEncoding,
  1679. WebSocketHandshake,
  1680. UserCallbackException,
  1681. // For internal use only
  1682. SSLPeerCouldBeClosed_,
  1683. };
  1684. std::string to_string(Error error);
  1685. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1686. class Stream {
  1687. public:
  1688. virtual ~Stream() = default;
  1689. virtual bool is_readable() const = 0;
  1690. virtual bool wait_readable() const = 0;
  1691. virtual bool wait_writable() const = 0;
  1692. virtual bool is_peer_alive() const { return wait_writable(); }
  1693. virtual ssize_t read(char *ptr, size_t size) = 0;
  1694. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1695. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1696. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1697. virtual socket_t socket() const = 0;
  1698. virtual time_t duration() const = 0;
  1699. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1700. (void)sec;
  1701. (void)usec;
  1702. }
  1703. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1704. // each one. 0 lifts the bound.
  1705. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1706. // Lets a wait for data end early once `interrupted` returns true, so that
  1707. // another thread can stop a blocked read on every platform.
  1708. virtual void set_read_interrupt(std::function<bool()> interrupted) {
  1709. (void)interrupted;
  1710. }
  1711. // Bytes already pulled off the socket and sitting in this stream's own
  1712. // buffer. Exposing them lets a line reader scan for a terminator in one
  1713. // pass instead of asking for a byte at a time. A stream that does no
  1714. // buffering of its own reports none, and readers fall back to read().
  1715. virtual const char *buffered_data(size_t &size) const {
  1716. size = 0;
  1717. return nullptr;
  1718. }
  1719. // Discards `size` bytes previously returned by buffered_data().
  1720. virtual void consume_buffered(size_t size) { (void)size; }
  1721. ssize_t write(const char *ptr);
  1722. ssize_t write(const std::string &s);
  1723. Error get_error() const { return error_; }
  1724. protected:
  1725. Error error_ = Error::Success;
  1726. };
  1727. class TaskQueue {
  1728. public:
  1729. TaskQueue() = default;
  1730. virtual ~TaskQueue() = default;
  1731. virtual bool enqueue(std::function<void()> fn) = 0;
  1732. virtual void shutdown() = 0;
  1733. virtual void on_idle() {}
  1734. };
  1735. class ThreadPool final : public TaskQueue {
  1736. public:
  1737. explicit ThreadPool(
  1738. size_t n, size_t max_n = 0, size_t mqr = 0,
  1739. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1740. ThreadPool(const ThreadPool &) = delete;
  1741. ~ThreadPool() override = default;
  1742. bool enqueue(std::function<void()> fn) override;
  1743. void shutdown() override;
  1744. private:
  1745. void worker(bool is_dynamic);
  1746. void move_to_finished(std::thread::id id);
  1747. void cleanup_finished_threads();
  1748. size_t base_thread_count_;
  1749. size_t max_thread_count_;
  1750. size_t max_queued_requests_;
  1751. time_t idle_timeout_sec_;
  1752. size_t idle_thread_count_;
  1753. bool shutdown_;
  1754. std::list<std::function<void()>> jobs_;
  1755. std::vector<std::thread> threads_; // base threads
  1756. std::list<std::thread> dynamic_threads_; // dynamic threads
  1757. std::vector<std::thread>
  1758. finished_threads_; // exited dynamic threads awaiting join
  1759. std::condition_variable cond_;
  1760. std::mutex mutex_;
  1761. };
  1762. using Logger = std::function<void(const Request &, const Response &)>;
  1763. // Forward declaration for Error type
  1764. enum class Error;
  1765. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1766. using SocketOptions = std::function<void(socket_t sock)>;
  1767. void default_socket_options(socket_t sock);
  1768. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1769. const char *status_message(int status);
  1770. std::string to_string(Error error);
  1771. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1772. std::string get_bearer_token_auth(const Request &req);
  1773. namespace detail {
  1774. class MatcherBase {
  1775. public:
  1776. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1777. virtual ~MatcherBase() = default;
  1778. const std::string &pattern() const { return pattern_; }
  1779. // Match request path and populate its matches and
  1780. virtual bool match(Request &request) const = 0;
  1781. private:
  1782. std::string pattern_;
  1783. };
  1784. /**
  1785. * Captures parameters in request path and stores them in Request::path_params
  1786. *
  1787. * Capture name is a substring of a pattern from : to /.
  1788. * The rest of the pattern is matched against the request path directly
  1789. * Parameters are captured starting from the next character after
  1790. * the end of the last matched static pattern fragment until the next /.
  1791. *
  1792. * Example pattern:
  1793. * "/path/fragments/:capture/more/fragments/:second_capture"
  1794. * Static fragments:
  1795. * "/path/fragments/", "more/fragments/"
  1796. *
  1797. * Given the following request path:
  1798. * "/path/fragments/:1/more/fragments/:2"
  1799. * the resulting capture will be
  1800. * {{"capture", "1"}, {"second_capture", "2"}}
  1801. */
  1802. class PathParamsMatcher final : public MatcherBase {
  1803. public:
  1804. PathParamsMatcher(const std::string &pattern);
  1805. bool match(Request &request) const override;
  1806. private:
  1807. // Treat segment separators as the end of path parameter capture
  1808. // Does not need to handle query parameters as they are parsed before path
  1809. // matching
  1810. static constexpr char separator = '/';
  1811. // Contains static path fragments to match against, excluding the '/' after
  1812. // path params
  1813. // Fragments are separated by path params
  1814. std::vector<std::string> static_fragments_;
  1815. // Stores the names of the path parameters to be used as keys in the
  1816. // Request::path_params map
  1817. std::vector<std::string> param_names_;
  1818. };
  1819. /**
  1820. * Performs std::regex_match on request path
  1821. * and stores the result in Request::matches
  1822. *
  1823. * Note that regex match is performed directly on the whole request.
  1824. * This means that wildcard patterns may match multiple path segments with /:
  1825. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1826. */
  1827. class RegexMatcher final : public MatcherBase {
  1828. public:
  1829. RegexMatcher(const std::string &pattern)
  1830. : MatcherBase(pattern), regex_(pattern) {}
  1831. bool match(Request &request) const override;
  1832. private:
  1833. std::regex regex_;
  1834. };
  1835. int close_socket(socket_t sock) noexcept;
  1836. bool is_accept_resource_error();
  1837. bool is_accept_transient_error();
  1838. ssize_t write_headers(Stream &strm, const Headers &headers);
  1839. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1840. time_t usec);
  1841. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1842. const std::string &boundary);
  1843. ContentProvider
  1844. make_multipart_content_provider(const UploadFormDataItems &items,
  1845. const std::string &boundary);
  1846. } // namespace detail
  1847. bool is_valid_multipart_boundary(const std::string &boundary);
  1848. // Serializer for multipart/form-data request bodies. The boundary is owned
  1849. // by the writer so that per-part framing and the final terminator always
  1850. // agree. Field names and filenames are escaped following the WHATWG HTML
  1851. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1852. // in content types.
  1853. class MultipartFormDataWriter {
  1854. public:
  1855. MultipartFormDataWriter();
  1856. // precondition: is_valid_multipart_boundary(boundary)
  1857. explicit MultipartFormDataWriter(std::string boundary);
  1858. const std::string &boundary() const;
  1859. std::string content_type() const;
  1860. // In-memory items -> whole body (known length)
  1861. std::string serialize(const UploadFormDataItems &items) const;
  1862. size_t content_length(const UploadFormDataItems &items) const;
  1863. // Per-part framing for streaming via a content provider
  1864. std::string item_begin(const UploadFormData &item) const;
  1865. static std::string item_end();
  1866. std::string finish() const;
  1867. private:
  1868. std::string boundary_;
  1869. };
  1870. class Server {
  1871. public:
  1872. using Handler = std::function<void(const Request &, Response &)>;
  1873. using ExceptionHandler =
  1874. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1875. enum class HandlerResponse {
  1876. Handled,
  1877. Unhandled,
  1878. };
  1879. using HandlerWithResponse =
  1880. std::function<HandlerResponse(const Request &, Response &)>;
  1881. using HandlerWithContentReader = std::function<void(
  1882. const Request &, Response &, const ContentReader &content_reader)>;
  1883. using Expect100ContinueHandler =
  1884. std::function<int(const Request &, Response &)>;
  1885. using StartHandler = std::function<void()>;
  1886. using WebSocketHandler =
  1887. std::function<void(const Request &, ws::WebSocket &)>;
  1888. using SubProtocolSelector =
  1889. std::function<std::string(const std::vector<std::string> &protocols)>;
  1890. Server();
  1891. virtual ~Server();
  1892. virtual bool is_valid() const;
  1893. Server &Get(const std::string &pattern, Handler handler);
  1894. Server &Post(const std::string &pattern, Handler handler);
  1895. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1896. Server &Put(const std::string &pattern, Handler handler);
  1897. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1898. Server &Patch(const std::string &pattern, Handler handler);
  1899. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1900. Server &Delete(const std::string &pattern, Handler handler);
  1901. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1902. Server &Options(const std::string &pattern, Handler handler);
  1903. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1904. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1905. // server accept it; an unregistered method is still rejected with 400.
  1906. // `method` must be a valid HTTP method token and must not be one of the
  1907. // built-in methods, which have their own registration functions above. A
  1908. // rejected registration makes is_valid() return false, so listen() fails.
  1909. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1910. Handler handler);
  1911. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1912. HandlerWithContentReader handler);
  1913. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1914. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1915. SubProtocolSelector sub_protocol_selector);
  1916. bool set_base_dir(const std::string &dir,
  1917. const std::string &mount_point = std::string());
  1918. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1919. Headers headers = Headers());
  1920. bool remove_mount_point(const std::string &mount_point);
  1921. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1922. const std::string &mime);
  1923. Server &set_default_file_mimetype(const std::string &mime);
  1924. Server &set_file_request_handler(Handler handler);
  1925. template <class ErrorHandlerFunc>
  1926. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1927. return set_error_handler_core(
  1928. std::forward<ErrorHandlerFunc>(handler),
  1929. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1930. }
  1931. Server &set_exception_handler(ExceptionHandler handler);
  1932. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1933. Server &set_post_routing_handler(Handler handler);
  1934. Server &set_pre_request_handler(HandlerWithResponse handler);
  1935. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1936. Server &set_start_handler(StartHandler handler);
  1937. Server &set_logger(Logger logger);
  1938. Server &set_pre_compression_logger(Logger logger);
  1939. Server &set_error_logger(ErrorLogger error_logger);
  1940. Server &set_address_family(int family);
  1941. Server &set_tcp_nodelay(bool on);
  1942. Server &set_ipv6_v6only(bool on);
  1943. Server &set_socket_options(SocketOptions socket_options);
  1944. Server &set_default_headers(Headers headers);
  1945. Server &
  1946. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1947. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1948. Server &set_keep_alive_max_count(size_t count);
  1949. Server &set_keep_alive_timeout(time_t sec);
  1950. template <class Rep, class Period>
  1951. Server &
  1952. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1953. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1954. template <class Rep, class Period>
  1955. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1956. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1957. template <class Rep, class Period>
  1958. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1959. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1960. template <class Rep, class Period>
  1961. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1962. Server &set_payload_max_length(size_t length);
  1963. Server &set_compress(bool on);
  1964. Server &set_static_file_compression(bool on);
  1965. Server &set_static_file_compression_min_length(size_t length);
  1966. Server &set_static_file_compression_max_length(size_t length);
  1967. Server &set_websocket_ping_interval(time_t sec);
  1968. template <class Rep, class Period>
  1969. Server &set_websocket_ping_interval(
  1970. const std::chrono::duration<Rep, Period> &duration);
  1971. Server &set_websocket_max_missed_pongs(int count);
  1972. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1973. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1974. bool listen_after_bind();
  1975. bool listen(const std::string &host, int port, int socket_flags = 0);
  1976. bool is_running() const;
  1977. void wait_until_ready() const;
  1978. void stop() noexcept;
  1979. void decommission();
  1980. std::function<TaskQueue *(void)> new_task_queue;
  1981. protected:
  1982. bool process_request(Stream &strm, const std::string &remote_addr,
  1983. int remote_port, const std::string &local_addr,
  1984. int local_port, bool close_connection,
  1985. bool &connection_closed,
  1986. const std::function<void(Request &)> &setup_request,
  1987. bool *websocket_upgraded = nullptr);
  1988. // Runs the per-connection serving loop and stops an exception thrown by a
  1989. // user callback from escaping the worker thread.
  1990. //
  1991. // process_request() wraps only routing() and the hooks before a WebSocket
  1992. // upgrade in a try/catch. Content providers, the post-routing, error,
  1993. // logging and expect-100 handlers and WebSocket handlers all run outside
  1994. // it, and the task queue calls the job without a catch, so an exception
  1995. // from any of those would terminate the process.
  1996. //
  1997. // No 500 is possible here: by the time a content provider runs, the status
  1998. // line and headers are already on the wire. Report it through the error
  1999. // logger and drop the connection, which is what the peer observes either
  2000. // way. Other connections are unaffected.
  2001. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  2002. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  2003. return serve();
  2004. #else
  2005. try {
  2006. return serve();
  2007. } catch (...) {
  2008. // The error logger is a user callback too, so it must not be able to
  2009. // throw the guard back open.
  2010. try {
  2011. output_error_log(Error::UserCallbackException, nullptr);
  2012. } catch (...) {}
  2013. return false;
  2014. }
  2015. #endif
  2016. }
  2017. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2018. std::vector<std::string> trusted_proxies_;
  2019. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2020. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2021. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2022. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2023. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2024. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2025. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2026. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2027. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2028. bool compress_ = true;
  2029. bool static_file_compression_ = false;
  2030. size_t static_file_compression_min_length_ =
  2031. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2032. size_t static_file_compression_max_length_ =
  2033. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2034. time_t websocket_ping_interval_sec_ =
  2035. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2036. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2037. private:
  2038. using Handlers =
  2039. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2040. using HandlersForContentReader =
  2041. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2042. HandlerWithContentReader>>;
  2043. // Both handler tables for one custom method live in a single entry, so that
  2044. // routing() needs only one map lookup per request to reach either of them.
  2045. struct CustomHandlerEntry {
  2046. Handlers handlers;
  2047. HandlersForContentReader handlers_for_content_reader;
  2048. };
  2049. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2050. static std::unique_ptr<detail::MatcherBase>
  2051. make_matcher(const std::string &pattern);
  2052. static const std::set<std::string> &builtin_methods();
  2053. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2054. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2055. template <typename H>
  2056. Server &add_handler(
  2057. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2058. const std::string &pattern, H handler) {
  2059. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2060. return *this;
  2061. }
  2062. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2063. Server &set_error_handler_core(Handler handler, std::false_type);
  2064. socket_t create_server_socket(const std::string &host, int port,
  2065. int socket_flags,
  2066. SocketOptions socket_options) const;
  2067. int bind_internal(const std::string &host, int port, int socket_flags);
  2068. bool listen_internal();
  2069. bool routing(Request &req, Response &res, Stream &strm,
  2070. bool skip_pre_routing);
  2071. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  2072. bool handle_exception(Request &req, Response &res);
  2073. #endif
  2074. bool handle_file_request(Request &req, Response &res);
  2075. bool check_if_not_modified(const Request &req, Response &res,
  2076. const std::string &etag, time_t mtime) const;
  2077. bool check_if_range(Request &req, const std::string &etag,
  2078. time_t mtime) const;
  2079. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2080. Stream &strm);
  2081. bool dispatch_request_for_content_reader(
  2082. Request &req, Response &res, ContentReader content_reader,
  2083. const HandlersForContentReader &handlers) const;
  2084. bool parse_request_line(const char *s, Request &req) const;
  2085. detail::EncodingType static_file_encoding(const Request &req,
  2086. const Response &res,
  2087. const std::string &content_type,
  2088. size_t length) const;
  2089. bool apply_static_file_compression(const Request &req, Response &res) const;
  2090. void apply_ranges(const Request &req, Response &res,
  2091. std::string &content_type, std::string &boundary) const;
  2092. bool write_response(Stream &strm, bool close_connection, Request &req,
  2093. Response &res);
  2094. bool write_response_with_content(Stream &strm, bool close_connection,
  2095. const Request &req, Response &res);
  2096. bool write_response_core(Stream &strm, bool close_connection,
  2097. const Request &req, Response &res,
  2098. bool need_apply_ranges);
  2099. bool write_content_with_provider(Stream &strm, const Request &req,
  2100. Response &res, const std::string &boundary,
  2101. const std::string &content_type);
  2102. bool read_content(Stream &strm, Request &req, Response &res);
  2103. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2104. Response &res,
  2105. ContentReceiver receiver,
  2106. FormDataHeader multipart_header,
  2107. ContentReceiver multipart_receiver);
  2108. bool read_content_core(Stream &strm, Request &req, Response &res,
  2109. ContentReceiver receiver,
  2110. FormDataHeader multipart_header,
  2111. ContentReceiver multipart_receiver) const;
  2112. virtual bool process_and_close_socket(socket_t sock);
  2113. void output_log(const Request &req, const Response &res) const;
  2114. void output_pre_compression_log(const Request &req,
  2115. const Response &res) const;
  2116. void output_error_log(const Error &err, const Request *req) const;
  2117. std::atomic<bool> is_running_{false};
  2118. std::atomic<bool> is_decommissioned{false};
  2119. // Set when CustomRoute() refuses a registration. Written before listen(),
  2120. // read by is_valid() on the same thread, so it needs no synchronization.
  2121. bool has_invalid_registration_ = false;
  2122. struct MountPointEntry {
  2123. std::string mount_point;
  2124. std::string base_dir;
  2125. std::string resolved_base_dir;
  2126. Headers headers;
  2127. };
  2128. std::vector<MountPointEntry> base_dirs_;
  2129. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2130. std::string default_file_mimetype_ = "application/octet-stream";
  2131. Handler file_request_handler_;
  2132. Handlers get_handlers_;
  2133. Handlers post_handlers_;
  2134. HandlersForContentReader post_handlers_for_content_reader_;
  2135. Handlers put_handlers_;
  2136. HandlersForContentReader put_handlers_for_content_reader_;
  2137. Handlers patch_handlers_;
  2138. HandlersForContentReader patch_handlers_for_content_reader_;
  2139. Handlers delete_handlers_;
  2140. HandlersForContentReader delete_handlers_for_content_reader_;
  2141. Handlers options_handlers_;
  2142. CustomHandlers custom_handlers_;
  2143. struct WebSocketHandlerEntry {
  2144. std::unique_ptr<detail::MatcherBase> matcher;
  2145. WebSocketHandler handler;
  2146. SubProtocolSelector sub_protocol_selector;
  2147. };
  2148. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2149. WebSocketHandlers websocket_handlers_;
  2150. HandlerWithResponse error_handler_;
  2151. ExceptionHandler exception_handler_;
  2152. HandlerWithResponse pre_routing_handler_;
  2153. Handler post_routing_handler_;
  2154. HandlerWithResponse pre_request_handler_;
  2155. Expect100ContinueHandler expect_100_continue_handler_;
  2156. StartHandler start_handler_;
  2157. mutable std::mutex logger_mutex_;
  2158. Logger logger_;
  2159. Logger pre_compression_logger_;
  2160. ErrorLogger error_logger_;
  2161. int address_family_ = AF_UNSPEC;
  2162. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2163. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2164. SocketOptions socket_options_ = default_socket_options;
  2165. Headers default_headers_;
  2166. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2167. detail::write_headers;
  2168. };
  2169. class Result {
  2170. public:
  2171. Result() = default;
  2172. Result(std::unique_ptr<Response> &&res, Error err,
  2173. Headers &&request_headers = Headers{})
  2174. : res_(std::move(res)), err_(err),
  2175. request_headers_(std::move(request_headers)) {}
  2176. // Response
  2177. operator bool() const { return res_ != nullptr; }
  2178. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2179. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2180. const Response &value() const { return *res_; }
  2181. Response &value() { return *res_; }
  2182. const Response &operator*() const { return *res_; }
  2183. Response &operator*() { return *res_; }
  2184. const Response *operator->() const { return res_.get(); }
  2185. Response *operator->() { return res_.get(); }
  2186. // Error
  2187. Error error() const { return err_; }
  2188. // Request Headers
  2189. bool has_request_header(const std::string &key) const;
  2190. std::string get_request_header_value(const std::string &key,
  2191. const char *def = "",
  2192. size_t id = 0) const;
  2193. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2194. size_t id = 0) const;
  2195. size_t get_request_header_value_count(const std::string &key) const;
  2196. private:
  2197. std::unique_ptr<Response> res_;
  2198. Error err_ = Error::Unknown;
  2199. Headers request_headers_;
  2200. #ifdef CPPHTTPLIB_SSL_ENABLED
  2201. public:
  2202. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2203. int ssl_error)
  2204. : res_(std::move(res)), err_(err),
  2205. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2206. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2207. int ssl_error, uint64_t ssl_backend_error)
  2208. : res_(std::move(res)), err_(err),
  2209. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2210. ssl_backend_error_(ssl_backend_error) {}
  2211. int ssl_error() const { return ssl_error_; }
  2212. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2213. private:
  2214. int ssl_error_ = 0;
  2215. uint64_t ssl_backend_error_ = 0;
  2216. #endif
  2217. };
  2218. struct ClientConnection {
  2219. socket_t sock = INVALID_SOCKET;
  2220. bool is_open() const { return sock != INVALID_SOCKET; }
  2221. ClientConnection() = default;
  2222. ~ClientConnection();
  2223. ClientConnection(const ClientConnection &) = delete;
  2224. ClientConnection &operator=(const ClientConnection &) = delete;
  2225. ClientConnection(ClientConnection &&other) noexcept
  2226. : sock(other.sock)
  2227. #ifdef CPPHTTPLIB_SSL_ENABLED
  2228. ,
  2229. session(other.session)
  2230. #endif
  2231. {
  2232. other.sock = INVALID_SOCKET;
  2233. #ifdef CPPHTTPLIB_SSL_ENABLED
  2234. other.session = nullptr;
  2235. #endif
  2236. }
  2237. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2238. if (this != &other) {
  2239. sock = other.sock;
  2240. other.sock = INVALID_SOCKET;
  2241. #ifdef CPPHTTPLIB_SSL_ENABLED
  2242. session = other.session;
  2243. other.session = nullptr;
  2244. #endif
  2245. }
  2246. return *this;
  2247. }
  2248. #ifdef CPPHTTPLIB_SSL_ENABLED
  2249. tls::session_t session = nullptr;
  2250. #endif
  2251. };
  2252. namespace detail {
  2253. struct ChunkedDecoder;
  2254. struct BodyReader {
  2255. Stream *stream = nullptr;
  2256. bool has_content_length = false;
  2257. size_t content_length = 0;
  2258. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2259. size_t bytes_read = 0;
  2260. bool chunked = false;
  2261. bool eof = false;
  2262. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2263. Error last_error = Error::Success;
  2264. ssize_t read(char *buf, size_t len);
  2265. bool has_error() const { return last_error != Error::Success; }
  2266. };
  2267. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2268. size_t len) {
  2269. (void)stream;
  2270. return br.read(buf, len);
  2271. }
  2272. class decompressor;
  2273. enum class NoProxyKind {
  2274. Wildcard, // "*"
  2275. HostnameSuffix, // "example.com" or ".example.com"
  2276. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2277. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2278. };
  2279. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2280. // Lets one CIDR matcher cover both families.
  2281. using IPBytes = std::array<uint8_t, 16>;
  2282. struct NoProxyEntry {
  2283. NoProxyKind kind = NoProxyKind::Wildcard;
  2284. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2285. IPBytes net{};
  2286. int prefix_bits = 0;
  2287. };
  2288. struct NormalizedTarget {
  2289. std::string hostname; // lowercase; brackets and trailing dot removed
  2290. bool is_ipv4 = false;
  2291. bool is_ipv6 = false;
  2292. IPBytes ip{};
  2293. };
  2294. } // namespace detail
  2295. class ClientImpl {
  2296. public:
  2297. explicit ClientImpl(const std::string &host);
  2298. explicit ClientImpl(const std::string &host, int port);
  2299. explicit ClientImpl(const std::string &host, int port,
  2300. const std::string &client_cert_path,
  2301. const std::string &client_key_path);
  2302. virtual ~ClientImpl();
  2303. virtual bool is_valid() const;
  2304. struct StreamHandle {
  2305. std::unique_ptr<Response> response;
  2306. Error error = Error::Success;
  2307. StreamHandle() = default;
  2308. StreamHandle(const StreamHandle &) = delete;
  2309. StreamHandle &operator=(const StreamHandle &) = delete;
  2310. StreamHandle(StreamHandle &&) = default;
  2311. StreamHandle &operator=(StreamHandle &&) = default;
  2312. ~StreamHandle() = default;
  2313. bool is_valid() const {
  2314. return response != nullptr && error == Error::Success;
  2315. }
  2316. ssize_t read(char *buf, size_t len);
  2317. void parse_trailers_if_needed();
  2318. Error get_read_error() const { return body_reader_.last_error; }
  2319. bool has_read_error() const { return body_reader_.has_error(); }
  2320. bool trailers_parsed_ = false;
  2321. private:
  2322. friend class ClientImpl;
  2323. friend class sse::SSEClient;
  2324. ssize_t read_with_decompression(char *buf, size_t len);
  2325. std::unique_ptr<ClientConnection> connection_;
  2326. std::unique_ptr<Stream> socket_stream_;
  2327. Stream *stream_ = nullptr;
  2328. detail::BodyReader body_reader_;
  2329. std::unique_ptr<detail::decompressor> decompressor_;
  2330. std::string decompress_buffer_;
  2331. size_t decompress_offset_ = 0;
  2332. size_t decompressed_bytes_read_ = 0;
  2333. };
  2334. // clang-format off
  2335. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2336. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2337. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2338. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2339. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2340. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2341. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2342. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2343. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2344. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2345. Result Head(const std::string &path);
  2346. Result Head(const std::string &path, const Headers &headers);
  2347. Result Post(const std::string &path);
  2348. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2349. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2350. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2351. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2352. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2353. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2354. Result Post(const std::string &path, const Params &params);
  2355. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2356. Result Post(const std::string &path, const Headers &headers);
  2357. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2358. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2359. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2360. 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);
  2361. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2362. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2363. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2364. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2365. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2366. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2367. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2368. Result Put(const std::string &path);
  2369. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2370. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2371. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2372. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2373. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2374. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2375. Result Put(const std::string &path, const Params &params);
  2376. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2377. Result Put(const std::string &path, const Headers &headers);
  2378. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2379. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2380. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2381. 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);
  2382. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2383. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2384. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2385. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2386. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2387. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2388. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2389. Result Patch(const std::string &path);
  2390. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2391. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2392. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2393. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2394. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2395. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2396. Result Patch(const std::string &path, const Params &params);
  2397. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2398. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2399. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2400. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2401. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2402. 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);
  2403. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2404. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2405. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2406. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2407. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2408. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2409. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2410. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2411. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2412. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2413. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2414. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2415. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2416. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2417. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2418. Result Options(const std::string &path);
  2419. Result Options(const std::string &path, const Headers &headers);
  2420. // clang-format on
  2421. // Streaming API: Open a stream for reading response body incrementally
  2422. // Socket ownership is transferred to StreamHandle for true streaming
  2423. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2424. StreamHandle open_stream(const std::string &method, const std::string &path,
  2425. const Params &params = {},
  2426. const Headers &headers = {},
  2427. const std::string &body = {},
  2428. const std::string &content_type = {});
  2429. bool send(Request &req, Response &res, Error &error);
  2430. Result send(const Request &req);
  2431. void stop();
  2432. std::string host() const;
  2433. int port() const;
  2434. size_t is_socket_open() const;
  2435. socket_t socket() const;
  2436. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2437. void set_default_headers(Headers headers);
  2438. void
  2439. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2440. void set_address_family(int family);
  2441. void set_tcp_nodelay(bool on);
  2442. void set_ipv6_v6only(bool on);
  2443. void set_socket_options(SocketOptions socket_options);
  2444. void set_connection_timeout(time_t sec, time_t usec = 0);
  2445. template <class Rep, class Period>
  2446. void
  2447. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2448. void set_read_timeout(time_t sec, time_t usec = 0);
  2449. template <class Rep, class Period>
  2450. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2451. void set_write_timeout(time_t sec, time_t usec = 0);
  2452. template <class Rep, class Period>
  2453. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2454. void set_max_timeout(time_t msec);
  2455. template <class Rep, class Period>
  2456. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2457. void set_basic_auth(const std::string &username, const std::string &password);
  2458. void set_bearer_token_auth(const std::string &token);
  2459. void set_keep_alive(bool on);
  2460. void set_follow_location(bool on);
  2461. void set_path_encode(bool on);
  2462. void set_compress(bool on);
  2463. void set_decompress(bool on);
  2464. void set_payload_max_length(size_t length);
  2465. void set_interface(const std::string &intf);
  2466. void set_proxy(const std::string &host, int port);
  2467. void set_proxy_basic_auth(const std::string &username,
  2468. const std::string &password);
  2469. void set_proxy_bearer_token_auth(const std::string &token);
  2470. void set_no_proxy(const std::vector<std::string> &patterns);
  2471. void set_logger(Logger logger);
  2472. void set_error_logger(ErrorLogger error_logger);
  2473. protected:
  2474. struct Socket {
  2475. socket_t sock = INVALID_SOCKET;
  2476. // For Mbed TLS compatibility: start_time for request timeout tracking
  2477. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2478. bool is_open() const { return sock != INVALID_SOCKET; }
  2479. #ifdef CPPHTTPLIB_SSL_ENABLED
  2480. tls::session_t ssl = nullptr;
  2481. #endif
  2482. };
  2483. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2484. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2485. virtual bool setup_proxy_connection(
  2486. Socket &socket,
  2487. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2488. Response &res, bool &success, Error &error);
  2489. bool is_proxy_enabled_for_host(const std::string &host) const;
  2490. // All of:
  2491. // shutdown_ssl
  2492. // shutdown_socket
  2493. // close_socket
  2494. // disconnect
  2495. // should ONLY be called when socket_mutex_ is locked, and only when
  2496. // no other thread is using the socket.
  2497. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2498. void shutdown_socket(Socket &socket) const;
  2499. void close_socket(Socket &socket);
  2500. void disconnect(bool gracefully);
  2501. // Under socket_mutex_: whether the connection kept alive can take another
  2502. // request. One the peer has closed, or one set up under TLS settings changed
  2503. // since, is closed instead.
  2504. bool socket_reusable();
  2505. // TLS settings apply as a connection is set up, so a change makes the
  2506. // connection kept alive unfit for the next request.
  2507. void tls_settings_changed() { tls_settings_version_++; }
  2508. std::string make_request_target(const Request &req) const;
  2509. bool process_request(Stream &strm, Request &req, Response &res,
  2510. bool close_connection, Error &error);
  2511. bool write_content_with_provider(Stream &strm, const Request &req,
  2512. Error &error) const;
  2513. void output_log(const Request &req, const Response &res) const;
  2514. void output_error_log(const Error &err, const Request *req) const;
  2515. // Socket endpoint information
  2516. const std::string host_;
  2517. const int port_;
  2518. // Current open socket
  2519. Socket socket_;
  2520. mutable std::mutex socket_mutex_;
  2521. std::recursive_mutex request_mutex_;
  2522. // How many send() calls are running on this client, guarded by
  2523. // request_mutex_
  2524. size_t send_depth_ = 0;
  2525. // These are all protected under socket_mutex
  2526. size_t socket_requests_in_flight_ = 0;
  2527. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2528. bool socket_should_be_closed_when_request_is_done_ = false;
  2529. size_t socket_tls_settings_version_ = 0;
  2530. std::atomic<size_t> tls_settings_version_{0};
  2531. // Hostname to connection target map. The value is an IP literal or another
  2532. // hostname; only the connection target changes, never the identity.
  2533. std::map<std::string, std::string> addr_map_;
  2534. // Default headers
  2535. Headers default_headers_;
  2536. // Header writer
  2537. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2538. detail::write_headers;
  2539. // Settings
  2540. std::string client_cert_path_;
  2541. std::string client_key_path_;
  2542. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2543. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2544. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2545. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2546. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2547. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2548. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2549. std::string basic_auth_username_;
  2550. std::string basic_auth_password_;
  2551. std::string bearer_token_auth_token_;
  2552. bool keep_alive_ = false;
  2553. bool follow_location_ = false;
  2554. bool path_encode_ = true;
  2555. int address_family_ = AF_UNSPEC;
  2556. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2557. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2558. SocketOptions socket_options_ = nullptr;
  2559. bool compress_ = false;
  2560. bool decompress_ = true;
  2561. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2562. bool has_payload_max_length_ = false;
  2563. std::string interface_;
  2564. std::string proxy_host_;
  2565. int proxy_port_ = -1;
  2566. std::string proxy_basic_auth_username_;
  2567. std::string proxy_basic_auth_password_;
  2568. std::string proxy_bearer_token_auth_token_;
  2569. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2570. mutable detail::NormalizedTarget host_normalized_;
  2571. mutable bool host_normalized_valid_ = false;
  2572. mutable std::mutex logger_mutex_;
  2573. Logger logger_;
  2574. ErrorLogger error_logger_;
  2575. private:
  2576. bool send_(Request &req, Response &res, Error &error);
  2577. Result send_(Request &&req);
  2578. socket_t create_client_socket(Error &error) const;
  2579. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2580. bool skip_100_continue = true) const;
  2581. bool write_request(Stream &strm, Request &req, bool close_connection,
  2582. Error &error, bool skip_body, bool &rejected_locally);
  2583. bool write_request_body(Stream &strm, Request &req, Error &error);
  2584. void prepare_default_headers(Request &r, bool for_stream,
  2585. const std::string &ct);
  2586. bool redirect(Request &req, Response &res, Error &error);
  2587. bool create_redirect_client(const std::string &scheme,
  2588. const std::string &host, int port, Request &req,
  2589. Response &res, const std::string &path,
  2590. const std::string &location, Error &error);
  2591. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2592. bool handle_request(Stream &strm, Request &req, Response &res,
  2593. bool close_connection, Error &error);
  2594. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2595. Request &req, const char *body, size_t content_length,
  2596. ContentProvider content_provider,
  2597. ContentProviderWithoutLength content_provider_without_length,
  2598. const std::string &content_type, ContentReceiver content_receiver,
  2599. Error &error);
  2600. Result send_with_content_provider_and_receiver(
  2601. const std::string &method, const std::string &path,
  2602. const Headers &headers, const char *body, size_t content_length,
  2603. ContentProvider content_provider,
  2604. ContentProviderWithoutLength content_provider_without_length,
  2605. const std::string &content_type, ContentReceiver content_receiver,
  2606. UploadProgress progress);
  2607. ContentProviderWithoutLength get_multipart_content_provider(
  2608. const std::string &boundary, const UploadFormDataItems &items,
  2609. const FormDataProviderItems &provider_items) const;
  2610. virtual bool
  2611. process_socket(const Socket &socket,
  2612. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2613. std::function<bool(Stream &strm)> callback);
  2614. virtual bool is_ssl() const;
  2615. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2616. StreamHandle open_stream_(Request &req);
  2617. void add_credential_headers(Request &req);
  2618. std::string proxy_target_prefix() const;
  2619. #ifdef CPPHTTPLIB_SSL_ENABLED
  2620. public:
  2621. void set_digest_auth(const std::string &username,
  2622. const std::string &password);
  2623. void set_proxy_digest_auth(const std::string &username,
  2624. const std::string &password);
  2625. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2626. const std::string &ca_cert_dir_path = std::string());
  2627. void enable_server_certificate_verification(bool enabled);
  2628. void enable_server_hostname_verification(bool enabled);
  2629. void enable_system_ca(bool enabled);
  2630. protected:
  2631. std::string digest_auth_username_;
  2632. std::string digest_auth_password_;
  2633. std::string proxy_digest_auth_username_;
  2634. std::string proxy_digest_auth_password_;
  2635. std::string ca_cert_file_path_;
  2636. std::string ca_cert_dir_path_;
  2637. bool server_certificate_verification_ = true;
  2638. bool server_hostname_verification_ = true;
  2639. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2640. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2641. int last_ssl_error_ = 0;
  2642. uint64_t last_backend_error_ = 0;
  2643. #endif
  2644. };
  2645. namespace detail {
  2646. // Stands in for a client that Client could not make from its arguments, so a
  2647. // request fails rather than going through a null pointer.
  2648. class InvalidClientImpl final : public ClientImpl {
  2649. public:
  2650. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2651. bool is_valid() const override { return false; }
  2652. private:
  2653. bool create_and_connect_socket(Socket &, Error &error) override {
  2654. error = Error::Connection;
  2655. return false;
  2656. }
  2657. };
  2658. } // namespace detail
  2659. class Client {
  2660. public:
  2661. // Universal interface
  2662. explicit Client(const std::string &scheme_host_port);
  2663. explicit Client(const std::string &scheme_host_port,
  2664. const std::string &client_cert_path,
  2665. const std::string &client_key_path);
  2666. // HTTP only interface
  2667. explicit Client(const std::string &host, int port);
  2668. explicit Client(const std::string &host, int port,
  2669. const std::string &client_cert_path,
  2670. const std::string &client_key_path);
  2671. Client(Client &&) = default;
  2672. Client &operator=(Client &&) = default;
  2673. ~Client();
  2674. bool is_valid() const;
  2675. // clang-format off
  2676. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2677. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2678. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2679. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2680. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2681. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2682. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2683. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2684. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2685. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2686. Result Head(const std::string &path);
  2687. Result Head(const std::string &path, const Headers &headers);
  2688. Result Post(const std::string &path);
  2689. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2690. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2691. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2692. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2693. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2694. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2695. Result Post(const std::string &path, const Params &params);
  2696. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2697. Result Post(const std::string &path, const Headers &headers);
  2698. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2699. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2700. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2701. 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);
  2702. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2703. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2704. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2705. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2706. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2707. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2708. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2709. Result Put(const std::string &path);
  2710. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2711. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2712. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2713. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2714. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2715. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2716. Result Put(const std::string &path, const Params &params);
  2717. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2718. Result Put(const std::string &path, const Headers &headers);
  2719. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2720. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2721. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2722. 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);
  2723. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2724. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2725. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2726. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2727. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2728. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2729. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2730. Result Patch(const std::string &path);
  2731. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2732. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2733. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2734. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2735. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2736. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2737. Result Patch(const std::string &path, const Params &params);
  2738. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2739. Result Patch(const std::string &path, const Headers &headers);
  2740. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2741. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2742. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2743. 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);
  2744. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2745. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2746. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2747. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2748. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2749. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2750. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2751. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2752. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2753. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2754. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2755. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2756. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2757. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2758. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2759. Result Options(const std::string &path);
  2760. Result Options(const std::string &path, const Headers &headers);
  2761. // clang-format on
  2762. // Streaming API: Open a stream for reading response body incrementally
  2763. // Socket ownership is transferred to StreamHandle for true streaming
  2764. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2765. ClientImpl::StreamHandle open_stream(const std::string &method,
  2766. const std::string &path,
  2767. const Params &params = {},
  2768. const Headers &headers = {},
  2769. const std::string &body = {},
  2770. const std::string &content_type = {});
  2771. bool send(Request &req, Response &res, Error &error);
  2772. Result send(const Request &req);
  2773. void stop();
  2774. std::string host() const;
  2775. int port() const;
  2776. size_t is_socket_open() const;
  2777. socket_t socket() const;
  2778. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2779. void set_default_headers(Headers headers);
  2780. void
  2781. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2782. void set_address_family(int family);
  2783. void set_tcp_nodelay(bool on);
  2784. void set_socket_options(SocketOptions socket_options);
  2785. void set_connection_timeout(time_t sec, time_t usec = 0);
  2786. template <class Rep, class Period>
  2787. void
  2788. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2789. void set_read_timeout(time_t sec, time_t usec = 0);
  2790. template <class Rep, class Period>
  2791. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2792. void set_write_timeout(time_t sec, time_t usec = 0);
  2793. template <class Rep, class Period>
  2794. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2795. void set_max_timeout(time_t msec);
  2796. template <class Rep, class Period>
  2797. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2798. void set_basic_auth(const std::string &username, const std::string &password);
  2799. void set_bearer_token_auth(const std::string &token);
  2800. void set_keep_alive(bool on);
  2801. void set_follow_location(bool on);
  2802. void set_path_encode(bool on);
  2803. void set_compress(bool on);
  2804. void set_decompress(bool on);
  2805. void set_payload_max_length(size_t length);
  2806. void set_interface(const std::string &intf);
  2807. void set_proxy(const std::string &host, int port);
  2808. void set_proxy_basic_auth(const std::string &username,
  2809. const std::string &password);
  2810. void set_proxy_bearer_token_auth(const std::string &token);
  2811. void set_no_proxy(const std::vector<std::string> &patterns);
  2812. void set_logger(Logger logger);
  2813. void set_error_logger(ErrorLogger error_logger);
  2814. private:
  2815. std::unique_ptr<ClientImpl> cli_;
  2816. #ifdef CPPHTTPLIB_SSL_ENABLED
  2817. public:
  2818. void set_digest_auth(const std::string &username,
  2819. const std::string &password);
  2820. void set_proxy_digest_auth(const std::string &username,
  2821. const std::string &password);
  2822. void enable_server_certificate_verification(bool enabled);
  2823. void enable_server_hostname_verification(bool enabled);
  2824. void enable_system_ca(bool enabled);
  2825. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2826. const std::string &ca_cert_dir_path = std::string());
  2827. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2828. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2829. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2830. void set_session_verifier(
  2831. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2832. tls::ctx_t tls_context() const;
  2833. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2834. void enable_windows_certificate_verification(bool enabled);
  2835. #endif
  2836. private:
  2837. bool is_ssl_ = false;
  2838. #endif
  2839. };
  2840. #ifdef CPPHTTPLIB_SSL_ENABLED
  2841. class SSLServer : public Server {
  2842. public:
  2843. SSLServer(const char *cert_path, const char *private_key_path,
  2844. const char *client_ca_cert_file_path = nullptr,
  2845. const char *client_ca_cert_dir_path = nullptr,
  2846. const char *private_key_password = nullptr);
  2847. struct PemMemory {
  2848. const char *cert_pem;
  2849. size_t cert_pem_len;
  2850. const char *key_pem;
  2851. size_t key_pem_len;
  2852. const char *client_ca_pem;
  2853. size_t client_ca_pem_len;
  2854. const char *private_key_password;
  2855. };
  2856. explicit SSLServer(const PemMemory &pem);
  2857. // The callback receives the ctx_t handle which can be cast to the
  2858. // appropriate backend type (SSL_CTX* for OpenSSL,
  2859. // tls::impl::MbedTlsContext* for Mbed TLS)
  2860. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2861. ~SSLServer() override;
  2862. bool is_valid() const override;
  2863. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2864. const char *client_ca_pem = nullptr,
  2865. const char *password = nullptr);
  2866. tls::ctx_t tls_context() const { return ctx_; }
  2867. int ssl_last_error() const { return last_ssl_error_; }
  2868. private:
  2869. bool process_and_close_socket(socket_t sock) override;
  2870. tls::ctx_t ctx_ = nullptr;
  2871. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2872. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2873. // bounds, and new ones wait while it is pending so that they cannot keep it
  2874. // waiting.
  2875. std::mutex ctx_mutex_;
  2876. std::condition_variable ctx_cv_;
  2877. size_t handshakes_in_progress_ = 0;
  2878. size_t updates_pending_ = 0;
  2879. int last_ssl_error_ = 0;
  2880. };
  2881. class SSLClient final : public ClientImpl {
  2882. public:
  2883. explicit SSLClient(const std::string &host);
  2884. explicit SSLClient(const std::string &host, int port);
  2885. explicit SSLClient(const std::string &host, int port,
  2886. const std::string &client_cert_path,
  2887. const std::string &client_key_path,
  2888. const std::string &private_key_password = std::string());
  2889. struct PemMemory {
  2890. const char *cert_pem;
  2891. size_t cert_pem_len;
  2892. const char *key_pem;
  2893. size_t key_pem_len;
  2894. const char *private_key_password;
  2895. };
  2896. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2897. ~SSLClient() override;
  2898. bool is_valid() const override;
  2899. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2900. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2901. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2902. // Post-handshake session verifier (backend-independent)
  2903. void set_session_verifier(
  2904. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2905. tls::ctx_t tls_context() const { return ctx_; }
  2906. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2907. void enable_windows_certificate_verification(bool enabled);
  2908. #endif
  2909. private:
  2910. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2911. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2912. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2913. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2914. bool
  2915. process_socket(const Socket &socket,
  2916. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2917. std::function<bool(Stream &strm)> callback) override;
  2918. bool is_ssl() const override;
  2919. bool setup_proxy_connection(
  2920. Socket &socket,
  2921. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2922. Response &res, bool &success, Error &error) override;
  2923. bool connect_with_proxy(
  2924. Socket &sock,
  2925. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2926. Response &res, bool &success, Error &error);
  2927. bool initialize_ssl(Socket &socket, Error &error);
  2928. void init_ctx();
  2929. void reset_ctx_on_error();
  2930. bool load_certs();
  2931. tls::ctx_t ctx_ = nullptr;
  2932. std::mutex ctx_mutex_;
  2933. std::once_flag initialize_cert_;
  2934. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2935. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2936. bool ca_cert_store_set_ = false;
  2937. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  2938. // no certificate, so that a CA that failed to come through fails
  2939. // verification instead of letting the system CAs in.
  2940. bool custom_ca_loaded_ = false;
  2941. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2942. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2943. // set_server_certificate_verifier() installed there.
  2944. tls::VerifyCallback server_certificate_verifier_;
  2945. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2946. bool enable_windows_cert_verification_ = true;
  2947. #endif
  2948. friend class ClientImpl;
  2949. };
  2950. #endif // CPPHTTPLIB_SSL_ENABLED
  2951. namespace detail {
  2952. template <typename T, typename U>
  2953. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2954. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2955. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2956. duration - std::chrono::seconds(sec))
  2957. .count();
  2958. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2959. }
  2960. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2961. return N - 1;
  2962. }
  2963. inline bool is_numeric(const std::string &str) {
  2964. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2965. }
  2966. // std::ranges::next(first, n, last) for C++11
  2967. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2968. for (; n > 0 && first != last; --n) {
  2969. ++first;
  2970. }
  2971. return first;
  2972. }
  2973. inline size_t get_header_value_u64(const Headers &headers,
  2974. const std::string &key, size_t def,
  2975. size_t id, bool &is_invalid_value) {
  2976. is_invalid_value = false;
  2977. auto rng = headers.equal_range(key);
  2978. auto it = bounded_next(rng.first, id, rng.second);
  2979. if (it != rng.second) {
  2980. if (is_numeric(it->second)) {
  2981. // Parse at size_t width so an out-of-range Content-Length is reported
  2982. // rather than silently saturated/truncated (a value above 2^32 would
  2983. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2984. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2985. size_t val = 0;
  2986. const auto &s = it->second;
  2987. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2988. if (r.ec == std::errc::result_out_of_range) {
  2989. is_invalid_value = true;
  2990. return (std::numeric_limits<size_t>::max)();
  2991. }
  2992. return val;
  2993. } else {
  2994. is_invalid_value = true;
  2995. }
  2996. }
  2997. return def;
  2998. }
  2999. inline size_t get_header_value_u64(const Headers &headers,
  3000. const std::string &key, size_t def,
  3001. size_t id) {
  3002. auto dummy = false;
  3003. return get_header_value_u64(headers, key, def, id, dummy);
  3004. }
  3005. } // namespace detail
  3006. template <class Rep, class Period>
  3007. inline Server &
  3008. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3009. detail::duration_to_sec_and_usec(
  3010. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3011. return *this;
  3012. }
  3013. template <class Rep, class Period>
  3014. inline Server &
  3015. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3016. detail::duration_to_sec_and_usec(
  3017. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3018. return *this;
  3019. }
  3020. template <class Rep, class Period>
  3021. inline Server &
  3022. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  3023. detail::duration_to_sec_and_usec(
  3024. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  3025. return *this;
  3026. }
  3027. template <class Rep, class Period>
  3028. inline void ClientImpl::set_connection_timeout(
  3029. const std::chrono::duration<Rep, Period> &duration) {
  3030. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3031. set_connection_timeout(sec, usec);
  3032. });
  3033. }
  3034. template <class Rep, class Period>
  3035. inline void ClientImpl::set_read_timeout(
  3036. const std::chrono::duration<Rep, Period> &duration) {
  3037. detail::duration_to_sec_and_usec(
  3038. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3039. }
  3040. template <class Rep, class Period>
  3041. inline void ClientImpl::set_write_timeout(
  3042. const std::chrono::duration<Rep, Period> &duration) {
  3043. detail::duration_to_sec_and_usec(
  3044. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3045. }
  3046. template <class Rep, class Period>
  3047. inline void ClientImpl::set_max_timeout(
  3048. const std::chrono::duration<Rep, Period> &duration) {
  3049. auto msec =
  3050. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3051. set_max_timeout(static_cast<time_t>(msec));
  3052. }
  3053. template <class Rep, class Period>
  3054. inline void Client::set_connection_timeout(
  3055. const std::chrono::duration<Rep, Period> &duration) {
  3056. cli_->set_connection_timeout(duration);
  3057. }
  3058. template <class Rep, class Period>
  3059. inline void
  3060. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3061. cli_->set_read_timeout(duration);
  3062. }
  3063. template <class Rep, class Period>
  3064. inline void
  3065. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3066. cli_->set_write_timeout(duration);
  3067. }
  3068. inline void Client::set_max_timeout(time_t msec) {
  3069. cli_->set_max_timeout(msec);
  3070. }
  3071. template <class Rep, class Period>
  3072. inline void
  3073. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3074. cli_->set_max_timeout(duration);
  3075. }
  3076. /*
  3077. * Forward declarations and types that will be part of the .h file if split into
  3078. * .h + .cc.
  3079. */
  3080. std::string hosted_at(const std::string &hostname);
  3081. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3082. // JavaScript-style URL encoding/decoding functions
  3083. std::string encode_uri_component(const std::string &value);
  3084. std::string encode_uri(const std::string &value);
  3085. std::string decode_uri_component(const std::string &value);
  3086. std::string decode_uri(const std::string &value);
  3087. // RFC 3986 compliant URL component encoding/decoding functions
  3088. std::string encode_path_component(const std::string &component);
  3089. std::string decode_path_component(const std::string &component);
  3090. std::string encode_query_component(const std::string &component,
  3091. bool space_as_plus = true);
  3092. std::string decode_query_component(const std::string &component,
  3093. bool plus_as_space = true);
  3094. std::string sanitize_filename(const std::string &filename);
  3095. std::string append_query_params(const std::string &path, const Params &params);
  3096. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3097. std::pair<std::string, std::string>
  3098. make_basic_authentication_header(const std::string &username,
  3099. const std::string &password,
  3100. bool is_proxy = false);
  3101. namespace detail {
  3102. #if defined(_WIN32)
  3103. inline std::wstring u8string_to_wstring(const char *s) {
  3104. if (!s) { return std::wstring(); }
  3105. auto len = static_cast<int>(strlen(s));
  3106. if (!len) { return std::wstring(); }
  3107. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3108. if (!wlen) { return std::wstring(); }
  3109. std::wstring ws;
  3110. ws.resize(wlen);
  3111. wlen = ::MultiByteToWideChar(
  3112. CP_UTF8, 0, s, len,
  3113. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3114. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3115. return ws;
  3116. }
  3117. #endif
  3118. struct FileStat {
  3119. FileStat(const std::string &path);
  3120. bool is_file() const;
  3121. bool is_dir() const;
  3122. time_t mtime() const;
  3123. size_t size() const;
  3124. private:
  3125. #if defined(_WIN32)
  3126. struct _stat st_;
  3127. #else
  3128. struct stat st_;
  3129. #endif
  3130. int ret_ = -1;
  3131. };
  3132. std::string make_host_and_port_string(const std::string &host, int port,
  3133. bool is_ssl);
  3134. template <typename T>
  3135. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3136. Error &error);
  3137. bool write_data(Stream &strm, const char *d, size_t l);
  3138. std::string trim_copy(const std::string &s);
  3139. void divide(
  3140. const char *data, std::size_t size, char d,
  3141. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3142. fn);
  3143. void divide(
  3144. const std::string &str, char d,
  3145. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3146. fn);
  3147. void split(const char *b, const char *e, char d,
  3148. std::function<void(const char *, const char *)> fn);
  3149. void split(const char *b, const char *e, char d, size_t m,
  3150. std::function<void(const char *, const char *)> fn);
  3151. bool split_find(const char *b, const char *e, char d,
  3152. std::function<bool(const char *, const char *)> fn);
  3153. bool has_header_token(const Headers &headers, const std::string &key,
  3154. const std::string &token);
  3155. std::string websocket_accept_key(const std::string &client_key);
  3156. bool is_websocket_upgrade(const Request &req);
  3157. bool process_client_socket(
  3158. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3159. time_t write_timeout_sec, time_t write_timeout_usec,
  3160. time_t max_timeout_msec,
  3161. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3162. std::function<bool(Stream &)> callback);
  3163. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3164. int port, int address_family, bool tcp_nodelay,
  3165. bool ipv6_v6only, SocketOptions socket_options,
  3166. time_t connection_timeout_sec,
  3167. time_t connection_timeout_usec,
  3168. time_t read_timeout_sec, time_t read_timeout_usec,
  3169. time_t write_timeout_sec,
  3170. time_t write_timeout_usec,
  3171. const std::string &intf, Error &error);
  3172. const char *get_header_value(const Headers &headers, const std::string &key,
  3173. const char *def, size_t id);
  3174. std::string get_combined_header_value(const Headers &headers,
  3175. const std::string &key);
  3176. std::string params_to_query_str(const Params &params);
  3177. void parse_query_text(const char *data, std::size_t size, Params &params);
  3178. void parse_query_text(const std::string &s, Params &params);
  3179. bool parse_multipart_boundary(const std::string &content_type,
  3180. std::string &boundary);
  3181. bool parse_range_header(const std::string &s, Ranges &ranges);
  3182. bool parse_accept_header(const std::string &s,
  3183. std::vector<std::string> &content_types);
  3184. void parse_disposition_params(const std::string &s, Params &params);
  3185. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3186. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3187. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3188. EncodingType encoding_type(const Request &req, const Response &res,
  3189. const std::string &content_type);
  3190. EncodingType encoding_type(const Request &req, const Response &res);
  3191. class BufferStream final : public Stream {
  3192. public:
  3193. BufferStream() = default;
  3194. ~BufferStream() override = default;
  3195. bool is_readable() const override;
  3196. bool wait_readable() const override;
  3197. bool wait_writable() const override;
  3198. ssize_t read(char *ptr, size_t size) override;
  3199. ssize_t write(const char *ptr, size_t size) override;
  3200. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3201. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3202. socket_t socket() const override;
  3203. time_t duration() const override;
  3204. const std::string &get_buffer() const;
  3205. private:
  3206. std::string buffer;
  3207. size_t position = 0;
  3208. };
  3209. class compressor {
  3210. public:
  3211. virtual ~compressor() = default;
  3212. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3213. virtual bool compress(const char *data, size_t data_length, bool last,
  3214. Callback callback) = 0;
  3215. };
  3216. class decompressor {
  3217. public:
  3218. virtual ~decompressor() = default;
  3219. virtual bool is_valid() const = 0;
  3220. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3221. virtual bool decompress(const char *data, size_t data_length,
  3222. Callback callback) = 0;
  3223. };
  3224. class nocompressor final : public compressor {
  3225. public:
  3226. ~nocompressor() override = default;
  3227. bool compress(const char *data, size_t data_length, bool /*last*/,
  3228. Callback callback) override;
  3229. };
  3230. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3231. class gzip_compressor final : public compressor {
  3232. public:
  3233. gzip_compressor();
  3234. ~gzip_compressor() override;
  3235. bool compress(const char *data, size_t data_length, bool last,
  3236. Callback callback) override;
  3237. private:
  3238. bool is_valid_ = false;
  3239. z_stream strm_;
  3240. };
  3241. class gzip_decompressor final : public decompressor {
  3242. public:
  3243. gzip_decompressor();
  3244. ~gzip_decompressor() override;
  3245. bool is_valid() const override;
  3246. bool decompress(const char *data, size_t data_length,
  3247. Callback callback) override;
  3248. private:
  3249. bool is_valid_ = false;
  3250. z_stream strm_;
  3251. };
  3252. #endif
  3253. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3254. class brotli_compressor final : public compressor {
  3255. public:
  3256. brotli_compressor();
  3257. ~brotli_compressor();
  3258. bool compress(const char *data, size_t data_length, bool last,
  3259. Callback callback) override;
  3260. private:
  3261. BrotliEncoderState *state_ = nullptr;
  3262. };
  3263. class brotli_decompressor final : public decompressor {
  3264. public:
  3265. brotli_decompressor();
  3266. ~brotli_decompressor();
  3267. bool is_valid() const override;
  3268. bool decompress(const char *data, size_t data_length,
  3269. Callback callback) override;
  3270. private:
  3271. BrotliDecoderResult decoder_r;
  3272. BrotliDecoderState *decoder_s = nullptr;
  3273. };
  3274. #endif
  3275. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3276. class zstd_compressor : public compressor {
  3277. public:
  3278. zstd_compressor();
  3279. ~zstd_compressor();
  3280. bool compress(const char *data, size_t data_length, bool last,
  3281. Callback callback) override;
  3282. private:
  3283. ZSTD_CCtx *ctx_ = nullptr;
  3284. };
  3285. class zstd_decompressor : public decompressor {
  3286. public:
  3287. zstd_decompressor();
  3288. ~zstd_decompressor();
  3289. bool is_valid() const override;
  3290. bool decompress(const char *data, size_t data_length,
  3291. Callback callback) override;
  3292. private:
  3293. ZSTD_DCtx *ctx_ = nullptr;
  3294. };
  3295. #endif
  3296. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3297. // to store data. The call can set memory on stack for performance.
  3298. class stream_line_reader {
  3299. public:
  3300. stream_line_reader(Stream &strm, char *fixed_buffer,
  3301. size_t fixed_buffer_size);
  3302. const char *ptr() const;
  3303. size_t size() const;
  3304. bool end_with_crlf() const;
  3305. bool getline();
  3306. private:
  3307. void append(char c);
  3308. void append(const char *data, size_t size);
  3309. Stream &strm_;
  3310. char *fixed_buffer_;
  3311. const size_t fixed_buffer_size_;
  3312. size_t fixed_buffer_used_size_ = 0;
  3313. std::string growable_buffer_;
  3314. };
  3315. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3316. const Headers &src_headers);
  3317. struct ChunkedDecoder {
  3318. Stream &strm;
  3319. size_t chunk_remaining = 0;
  3320. bool finished = false;
  3321. char line_buf[64];
  3322. size_t last_chunk_total = 0;
  3323. size_t last_chunk_offset = 0;
  3324. size_t overhead = 0;
  3325. explicit ChunkedDecoder(Stream &s);
  3326. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3327. size_t &out_chunk_total);
  3328. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3329. };
  3330. // A regular file opened to be served: mapped on Windows, read with pread()
  3331. // elsewhere.
  3332. class mmap {
  3333. public:
  3334. mmap(const char *path);
  3335. ~mmap();
  3336. bool open(const char *path);
  3337. void close();
  3338. bool is_open() const;
  3339. size_t size() const;
  3340. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3341. // down to 0, if the file has shrunk since it was opened.
  3342. size_t read(size_t offset, char *buf, size_t len) const;
  3343. private:
  3344. #if defined(_WIN32)
  3345. HANDLE hFile_ = NULL;
  3346. HANDLE hMapping_ = NULL;
  3347. void *addr_ = nullptr;
  3348. bool is_open_empty_file = false;
  3349. #else
  3350. int fd_ = -1;
  3351. #endif
  3352. size_t size_ = 0;
  3353. };
  3354. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3355. namespace fields {
  3356. bool is_token_char(char c);
  3357. bool is_token(const std::string &s);
  3358. bool is_field_name(const std::string &s);
  3359. bool is_vchar(char c);
  3360. bool is_obs_text(char c);
  3361. bool is_field_vchar(char c);
  3362. bool is_field_content(const std::string &s);
  3363. bool is_field_value(const std::string &s);
  3364. bool is_field_valid(const std::string &name, const std::string &value);
  3365. bool is_request_target(const std::string &s);
  3366. bool is_host(const std::string &s);
  3367. } // namespace fields
  3368. } // namespace detail
  3369. /*
  3370. * TLS Abstraction Layer Declarations
  3371. */
  3372. #ifdef CPPHTTPLIB_SSL_ENABLED
  3373. // TLS abstraction layer - backend-specific type declarations
  3374. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3375. namespace tls {
  3376. namespace impl {
  3377. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3378. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3379. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3380. struct MbedTlsContext {
  3381. mbedtls_ssl_config conf;
  3382. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3383. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3384. mbedtls_entropy_context entropy;
  3385. mbedtls_ctr_drbg_context ctr_drbg;
  3386. #endif
  3387. mbedtls_x509_crt ca_chain;
  3388. mbedtls_x509_crt own_cert;
  3389. mbedtls_pk_context own_key;
  3390. bool is_server = false;
  3391. // Peer certificate required (set_verify_client()); a client defaults to true
  3392. bool verify_client = false;
  3393. // Set by tls::set_verify_callback().
  3394. VerifyCallback verify_callback;
  3395. MbedTlsContext();
  3396. ~MbedTlsContext();
  3397. MbedTlsContext(const MbedTlsContext &) = delete;
  3398. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3399. };
  3400. } // namespace impl
  3401. } // namespace tls
  3402. #endif
  3403. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3404. namespace tls {
  3405. namespace impl {
  3406. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3407. // This struct is accessible via tls::impl for use in SSL context
  3408. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3409. struct WolfSSLContext {
  3410. WOLFSSL_CTX *ctx = nullptr;
  3411. bool is_server = false;
  3412. // Peer certificate required (set_verify_client()); a client defaults to true
  3413. bool verify_client = false;
  3414. // Replaced under verify_callback_mutex()
  3415. std::shared_ptr<VerifyCallback> verify_callback;
  3416. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3417. WolfSSLContext();
  3418. ~WolfSSLContext();
  3419. WolfSSLContext(const WolfSSLContext &) = delete;
  3420. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3421. };
  3422. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3423. struct WolfSSLCAStore {
  3424. std::string pem_data;
  3425. };
  3426. } // namespace impl
  3427. } // namespace tls
  3428. #endif
  3429. #endif // CPPHTTPLIB_SSL_ENABLED
  3430. namespace stream {
  3431. class Result {
  3432. public:
  3433. Result();
  3434. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3435. Result(Result &&other) noexcept;
  3436. Result &operator=(Result &&other) noexcept;
  3437. Result(const Result &) = delete;
  3438. Result &operator=(const Result &) = delete;
  3439. // Response info
  3440. bool is_valid() const;
  3441. explicit operator bool() const;
  3442. int status() const;
  3443. const Headers &headers() const;
  3444. std::string get_header_value(const std::string &key,
  3445. const char *def = "") const;
  3446. bool has_header(const std::string &key) const;
  3447. Error error() const;
  3448. Error read_error() const;
  3449. bool has_read_error() const;
  3450. // Stream reading
  3451. bool next();
  3452. const char *data() const;
  3453. size_t size() const;
  3454. std::string read_all();
  3455. private:
  3456. ClientImpl::StreamHandle handle_;
  3457. std::string buffer_;
  3458. size_t current_size_ = 0;
  3459. size_t chunk_size_;
  3460. bool finished_ = false;
  3461. };
  3462. // GET
  3463. template <typename ClientType>
  3464. inline Result Get(ClientType &cli, const std::string &path,
  3465. size_t chunk_size = 8192) {
  3466. return Result{cli.open_stream("GET", path), chunk_size};
  3467. }
  3468. template <typename ClientType>
  3469. inline Result Get(ClientType &cli, const std::string &path,
  3470. const Headers &headers, size_t chunk_size = 8192) {
  3471. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3472. }
  3473. template <typename ClientType>
  3474. inline Result Get(ClientType &cli, const std::string &path,
  3475. const Params &params, size_t chunk_size = 8192) {
  3476. return Result{cli.open_stream("GET", path, params), chunk_size};
  3477. }
  3478. template <typename ClientType>
  3479. inline Result Get(ClientType &cli, const std::string &path,
  3480. const Params &params, const Headers &headers,
  3481. size_t chunk_size = 8192) {
  3482. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3483. }
  3484. // POST
  3485. template <typename ClientType>
  3486. inline Result Post(ClientType &cli, const std::string &path,
  3487. const std::string &body, const std::string &content_type,
  3488. size_t chunk_size = 8192) {
  3489. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3490. chunk_size};
  3491. }
  3492. template <typename ClientType>
  3493. inline Result Post(ClientType &cli, const std::string &path,
  3494. const Headers &headers, const std::string &body,
  3495. const std::string &content_type, size_t chunk_size = 8192) {
  3496. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3497. chunk_size};
  3498. }
  3499. template <typename ClientType>
  3500. inline Result Post(ClientType &cli, const std::string &path,
  3501. const Params &params, const std::string &body,
  3502. const std::string &content_type, size_t chunk_size = 8192) {
  3503. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3504. chunk_size};
  3505. }
  3506. template <typename ClientType>
  3507. inline Result Post(ClientType &cli, const std::string &path,
  3508. const Params &params, const Headers &headers,
  3509. const std::string &body, const std::string &content_type,
  3510. size_t chunk_size = 8192) {
  3511. return Result{
  3512. cli.open_stream("POST", path, params, headers, body, content_type),
  3513. chunk_size};
  3514. }
  3515. // PUT
  3516. template <typename ClientType>
  3517. inline Result Put(ClientType &cli, const std::string &path,
  3518. const std::string &body, const std::string &content_type,
  3519. size_t chunk_size = 8192) {
  3520. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3521. chunk_size};
  3522. }
  3523. template <typename ClientType>
  3524. inline Result Put(ClientType &cli, const std::string &path,
  3525. const Headers &headers, const std::string &body,
  3526. const std::string &content_type, size_t chunk_size = 8192) {
  3527. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3528. chunk_size};
  3529. }
  3530. template <typename ClientType>
  3531. inline Result Put(ClientType &cli, const std::string &path,
  3532. const Params &params, const std::string &body,
  3533. const std::string &content_type, size_t chunk_size = 8192) {
  3534. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3535. chunk_size};
  3536. }
  3537. template <typename ClientType>
  3538. inline Result Put(ClientType &cli, const std::string &path,
  3539. const Params &params, const Headers &headers,
  3540. const std::string &body, const std::string &content_type,
  3541. size_t chunk_size = 8192) {
  3542. return Result{
  3543. cli.open_stream("PUT", path, params, headers, body, content_type),
  3544. chunk_size};
  3545. }
  3546. // PATCH
  3547. template <typename ClientType>
  3548. inline Result Patch(ClientType &cli, const std::string &path,
  3549. const std::string &body, const std::string &content_type,
  3550. size_t chunk_size = 8192) {
  3551. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3552. chunk_size};
  3553. }
  3554. template <typename ClientType>
  3555. inline Result Patch(ClientType &cli, const std::string &path,
  3556. const Headers &headers, const std::string &body,
  3557. const std::string &content_type, size_t chunk_size = 8192) {
  3558. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3559. chunk_size};
  3560. }
  3561. template <typename ClientType>
  3562. inline Result Patch(ClientType &cli, const std::string &path,
  3563. const Params &params, const std::string &body,
  3564. const std::string &content_type, size_t chunk_size = 8192) {
  3565. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3566. chunk_size};
  3567. }
  3568. template <typename ClientType>
  3569. inline Result Patch(ClientType &cli, const std::string &path,
  3570. const Params &params, const Headers &headers,
  3571. const std::string &body, const std::string &content_type,
  3572. size_t chunk_size = 8192) {
  3573. return Result{
  3574. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3575. chunk_size};
  3576. }
  3577. // DELETE
  3578. template <typename ClientType>
  3579. inline Result Delete(ClientType &cli, const std::string &path,
  3580. size_t chunk_size = 8192) {
  3581. return Result{cli.open_stream("DELETE", path), chunk_size};
  3582. }
  3583. template <typename ClientType>
  3584. inline Result Delete(ClientType &cli, const std::string &path,
  3585. const Headers &headers, size_t chunk_size = 8192) {
  3586. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3587. }
  3588. template <typename ClientType>
  3589. inline Result Delete(ClientType &cli, const std::string &path,
  3590. const std::string &body, const std::string &content_type,
  3591. size_t chunk_size = 8192) {
  3592. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3593. chunk_size};
  3594. }
  3595. template <typename ClientType>
  3596. inline Result Delete(ClientType &cli, const std::string &path,
  3597. const Headers &headers, const std::string &body,
  3598. const std::string &content_type,
  3599. size_t chunk_size = 8192) {
  3600. return Result{
  3601. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3602. chunk_size};
  3603. }
  3604. template <typename ClientType>
  3605. inline Result Delete(ClientType &cli, const std::string &path,
  3606. const Params &params, size_t chunk_size = 8192) {
  3607. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3608. }
  3609. template <typename ClientType>
  3610. inline Result Delete(ClientType &cli, const std::string &path,
  3611. const Params &params, const Headers &headers,
  3612. size_t chunk_size = 8192) {
  3613. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3614. }
  3615. template <typename ClientType>
  3616. inline Result Delete(ClientType &cli, const std::string &path,
  3617. const Params &params, const std::string &body,
  3618. const std::string &content_type,
  3619. size_t chunk_size = 8192) {
  3620. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3621. chunk_size};
  3622. }
  3623. template <typename ClientType>
  3624. inline Result Delete(ClientType &cli, const std::string &path,
  3625. const Params &params, const Headers &headers,
  3626. const std::string &body, const std::string &content_type,
  3627. size_t chunk_size = 8192) {
  3628. return Result{
  3629. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3630. chunk_size};
  3631. }
  3632. // HEAD
  3633. template <typename ClientType>
  3634. inline Result Head(ClientType &cli, const std::string &path,
  3635. size_t chunk_size = 8192) {
  3636. return Result{cli.open_stream("HEAD", path), chunk_size};
  3637. }
  3638. template <typename ClientType>
  3639. inline Result Head(ClientType &cli, const std::string &path,
  3640. const Headers &headers, size_t chunk_size = 8192) {
  3641. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3642. }
  3643. template <typename ClientType>
  3644. inline Result Head(ClientType &cli, const std::string &path,
  3645. const Params &params, size_t chunk_size = 8192) {
  3646. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3647. }
  3648. template <typename ClientType>
  3649. inline Result Head(ClientType &cli, const std::string &path,
  3650. const Params &params, const Headers &headers,
  3651. size_t chunk_size = 8192) {
  3652. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3653. }
  3654. // OPTIONS
  3655. template <typename ClientType>
  3656. inline Result Options(ClientType &cli, const std::string &path,
  3657. size_t chunk_size = 8192) {
  3658. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3659. }
  3660. template <typename ClientType>
  3661. inline Result Options(ClientType &cli, const std::string &path,
  3662. const Headers &headers, size_t chunk_size = 8192) {
  3663. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3664. }
  3665. template <typename ClientType>
  3666. inline Result Options(ClientType &cli, const std::string &path,
  3667. const Params &params, size_t chunk_size = 8192) {
  3668. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3669. }
  3670. template <typename ClientType>
  3671. inline Result Options(ClientType &cli, const std::string &path,
  3672. const Params &params, const Headers &headers,
  3673. size_t chunk_size = 8192) {
  3674. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3675. }
  3676. } // namespace stream
  3677. namespace sse {
  3678. struct SSEMessage {
  3679. std::string event; // Event type (default: "message")
  3680. std::string data; // Event payload
  3681. std::string id; // Event ID for Last-Event-ID header
  3682. SSEMessage();
  3683. void clear();
  3684. };
  3685. class SSEClient {
  3686. public:
  3687. using MessageHandler = std::function<void(const SSEMessage &)>;
  3688. using ErrorHandler = std::function<void(Error)>;
  3689. using OpenHandler = std::function<void()>;
  3690. SSEClient(Client &client, const std::string &path);
  3691. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3692. ~SSEClient();
  3693. SSEClient(const SSEClient &) = delete;
  3694. SSEClient &operator=(const SSEClient &) = delete;
  3695. // Event handlers
  3696. SSEClient &on_message(MessageHandler handler);
  3697. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3698. SSEClient &on_open(OpenHandler handler);
  3699. SSEClient &on_error(ErrorHandler handler);
  3700. SSEClient &set_reconnect_interval(int ms);
  3701. SSEClient &set_max_reconnect_attempts(int n);
  3702. // Update headers (thread-safe)
  3703. SSEClient &set_headers(const Headers &headers);
  3704. // State accessors
  3705. bool is_connected() const;
  3706. std::string last_event_id() const;
  3707. // Blocking start - runs event loop with auto-reconnect
  3708. void start();
  3709. // Non-blocking start - runs in background thread
  3710. void start_async();
  3711. // Stop the client (thread-safe)
  3712. void stop();
  3713. private:
  3714. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3715. bool &has_data, bool &has_id);
  3716. void run_event_loop();
  3717. void dispatch_event(const SSEMessage &msg);
  3718. bool should_reconnect(int count) const;
  3719. void wait_for_reconnect();
  3720. // Client and path
  3721. Client &client_;
  3722. std::string path_;
  3723. Headers headers_;
  3724. mutable std::mutex headers_mutex_;
  3725. // Callbacks
  3726. MessageHandler on_message_;
  3727. std::map<std::string, MessageHandler> event_handlers_;
  3728. OpenHandler on_open_;
  3729. ErrorHandler on_error_;
  3730. // Configuration
  3731. int reconnect_interval_ms_ = 3000;
  3732. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3733. // State
  3734. std::atomic<bool> running_{false};
  3735. std::atomic<bool> connected_{false};
  3736. // Written by the event loop, which start_async() runs on its own thread
  3737. std::string last_event_id_;
  3738. mutable std::mutex last_event_id_mutex_;
  3739. // Async support
  3740. std::thread async_thread_;
  3741. };
  3742. } // namespace sse
  3743. namespace ws {
  3744. class WebSocketClient;
  3745. enum class Opcode : uint8_t {
  3746. Continuation = 0x0,
  3747. Text = 0x1,
  3748. Binary = 0x2,
  3749. Close = 0x8,
  3750. Ping = 0x9,
  3751. Pong = 0xA,
  3752. };
  3753. enum class CloseStatus : uint16_t {
  3754. Normal = 1000,
  3755. GoingAway = 1001,
  3756. ProtocolError = 1002,
  3757. UnsupportedData = 1003,
  3758. NoStatus = 1005,
  3759. Abnormal = 1006,
  3760. InvalidPayload = 1007,
  3761. PolicyViolation = 1008,
  3762. MessageTooBig = 1009,
  3763. MandatoryExtension = 1010,
  3764. InternalError = 1011,
  3765. };
  3766. // Timeout is returned only when a read timeout was set and it elapsed before
  3767. // any byte of a frame arrived: nothing was consumed and the connection is
  3768. // still open, so the caller can send on it and read again. `msg` is left
  3769. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3770. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3771. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3772. // upgrade handshake fully succeeded. On failure error() identifies the
  3773. // failing layer; status()/headers() expose the server's upgrade response
  3774. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3775. // CONNECT when error() is ProxyConnection.
  3776. class Result {
  3777. public:
  3778. Result() = default;
  3779. Result(Error err, int status, Headers &&headers)
  3780. : err_(err), status_(status), headers_(std::move(headers)) {}
  3781. explicit operator bool() const { return err_ == Error::Success; }
  3782. Error error() const { return err_; }
  3783. // Upgrade response info
  3784. int status() const { return status_; }
  3785. const Headers &headers() const { return headers_; }
  3786. std::string get_header_value(const std::string &key,
  3787. const char *def = "") const {
  3788. return detail::get_header_value(headers_, key, def, 0);
  3789. }
  3790. bool has_header(const std::string &key) const {
  3791. return headers_.find(key) != headers_.end();
  3792. }
  3793. #ifdef CPPHTTPLIB_SSL_ENABLED
  3794. Result(Error err, int status, Headers &&headers, int ssl_error,
  3795. uint64_t ssl_backend_error)
  3796. : err_(err), status_(status), headers_(std::move(headers)),
  3797. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3798. int ssl_error() const { return ssl_error_; }
  3799. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3800. #endif
  3801. private:
  3802. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3803. int status_ = -1;
  3804. Headers headers_;
  3805. #ifdef CPPHTTPLIB_SSL_ENABLED
  3806. int ssl_error_ = 0;
  3807. uint64_t ssl_backend_error_ = 0;
  3808. #endif
  3809. };
  3810. class WebSocket {
  3811. public:
  3812. WebSocket(const WebSocket &) = delete;
  3813. WebSocket &operator=(const WebSocket &) = delete;
  3814. ~WebSocket();
  3815. ReadResult read(std::string &msg);
  3816. bool send(const std::string &data);
  3817. bool send(const char *data, size_t len);
  3818. void close(CloseStatus status = CloseStatus::Normal,
  3819. const std::string &reason = "");
  3820. const Request &request() const;
  3821. bool is_open() const;
  3822. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3823. // A server handler owns its connection's timeout this way; a client sets it
  3824. // through WebSocketClient. Safe to call while another thread is in read().
  3825. //
  3826. // Only a timeout set here is reported as Timeout. The compile-time default
  3827. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3828. // than a request for control, so when it elapses read() returns Fail and
  3829. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3830. void set_read_timeout(time_t sec, time_t usec = 0);
  3831. template <class Rep, class Period>
  3832. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3833. private:
  3834. friend class httplib::Server;
  3835. friend class httplib::ws::WebSocketClient;
  3836. WebSocket(
  3837. Stream &strm, const Request &req, bool is_server,
  3838. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3839. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3840. : strm_(strm), req_(req), is_server_(is_server),
  3841. ping_interval_sec_(ping_interval_sec),
  3842. max_missed_pongs_(max_missed_pongs) {
  3843. start_heartbeat();
  3844. }
  3845. WebSocket(
  3846. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3847. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3848. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3849. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3850. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3851. max_missed_pongs_(max_missed_pongs) {
  3852. start_heartbeat();
  3853. }
  3854. void start_heartbeat();
  3855. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3856. Stream &strm_;
  3857. std::unique_ptr<Stream> owned_strm_;
  3858. Request req_;
  3859. bool is_server_;
  3860. time_t ping_interval_sec_;
  3861. int max_missed_pongs_;
  3862. int unacked_pings_ = 0;
  3863. std::atomic<bool> closed_{false};
  3864. // Set when the peer stopped answering pings, to end a read() waiting on it
  3865. std::atomic<bool> pong_timed_out_{false};
  3866. // Set once the caller has bounded read() through set_read_timeout(). Until
  3867. // then the timeout in effect is the compile-time default, and elapsing it
  3868. // is a failure that closes the connection, not a Timeout.
  3869. std::atomic<bool> read_timeout_set_{false};
  3870. std::mutex write_mutex_;
  3871. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3872. // may do so: read_websocket_frame() reads a payload until it has the whole
  3873. // declared length, so a second parser stealing bytes silently corrupts the
  3874. // message the first one is assembling.
  3875. std::mutex read_mutex_;
  3876. std::thread ping_thread_;
  3877. std::mutex ping_mutex_;
  3878. std::condition_variable ping_cv_;
  3879. };
  3880. class WebSocketClient {
  3881. public:
  3882. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3883. const Headers &headers = {});
  3884. ~WebSocketClient();
  3885. WebSocketClient(const WebSocketClient &) = delete;
  3886. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3887. bool is_valid() const;
  3888. Result connect();
  3889. ReadResult read(std::string &msg);
  3890. bool send(const std::string &data);
  3891. bool send(const char *data, size_t len);
  3892. void close(CloseStatus status = CloseStatus::Normal,
  3893. const std::string &reason = "");
  3894. bool is_open() const;
  3895. const std::string &subprotocol() const;
  3896. void set_read_timeout(time_t sec, time_t usec = 0);
  3897. template <class Rep, class Period>
  3898. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3899. void set_write_timeout(time_t sec, time_t usec = 0);
  3900. template <class Rep, class Period>
  3901. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3902. void set_websocket_ping_interval(time_t sec);
  3903. void set_websocket_max_missed_pongs(int count);
  3904. void set_tcp_nodelay(bool on);
  3905. void set_address_family(int family);
  3906. void set_ipv6_v6only(bool on);
  3907. void set_socket_options(SocketOptions socket_options);
  3908. void set_connection_timeout(time_t sec, time_t usec = 0);
  3909. template <class Rep, class Period>
  3910. void
  3911. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3912. void set_interface(const std::string &intf);
  3913. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3914. void set_proxy(const std::string &host, int port);
  3915. void set_proxy_basic_auth(const std::string &username,
  3916. const std::string &password);
  3917. void set_proxy_bearer_token_auth(const std::string &token);
  3918. void set_no_proxy(const std::vector<std::string> &patterns);
  3919. #ifdef CPPHTTPLIB_SSL_ENABLED
  3920. struct PemMemory {
  3921. const char *cert_pem;
  3922. size_t cert_pem_len;
  3923. const char *key_pem;
  3924. size_t key_pem_len;
  3925. const char *private_key_password;
  3926. };
  3927. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3928. const PemMemory &pem, const Headers &headers = {});
  3929. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3930. const std::string &ca_cert_dir_path = std::string());
  3931. void set_ca_cert_store(tls::ca_store_t store);
  3932. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3933. void enable_server_certificate_verification(bool enabled);
  3934. void enable_server_hostname_verification(bool enabled);
  3935. void enable_system_ca(bool enabled);
  3936. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3937. void set_session_verifier(
  3938. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3939. void set_proxy_digest_auth(const std::string &username,
  3940. const std::string &password);
  3941. #endif
  3942. private:
  3943. void shutdown_and_close();
  3944. std::pair<time_t, time_t> handshake_timeout() const;
  3945. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3946. int &ssl_error, uint64_t &ssl_backend_error);
  3947. void prepare_default_headers(Request &req);
  3948. bool is_proxy_enabled() const;
  3949. bool create_and_connect_socket(Error &error);
  3950. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  3951. bool connect_with_proxy(Response &proxy_res, Error &error);
  3952. std::string host_;
  3953. int port_;
  3954. std::string path_;
  3955. Headers headers_;
  3956. std::string subprotocol_;
  3957. bool is_valid_ = false;
  3958. socket_t sock_ = INVALID_SOCKET;
  3959. std::unique_ptr<WebSocket> ws_;
  3960. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3961. time_t read_timeout_usec_ = 0;
  3962. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3963. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3964. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3965. time_t websocket_ping_interval_sec_ =
  3966. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3967. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3968. int address_family_ = AF_UNSPEC;
  3969. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3970. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3971. SocketOptions socket_options_ = nullptr;
  3972. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3973. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3974. std::string interface_;
  3975. // Hostname to connection target map. The value is an IP literal or another
  3976. // hostname; only the connection target changes, never the identity.
  3977. std::map<std::string, std::string> addr_map_;
  3978. std::string proxy_host_;
  3979. int proxy_port_ = -1;
  3980. std::string proxy_basic_auth_username_;
  3981. std::string proxy_basic_auth_password_;
  3982. std::string proxy_bearer_token_auth_token_;
  3983. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  3984. #ifdef CPPHTTPLIB_SSL_ENABLED
  3985. bool is_ssl_ = false;
  3986. tls::ctx_t tls_ctx_ = nullptr;
  3987. tls::session_t tls_session_ = nullptr;
  3988. std::string ca_cert_file_path_;
  3989. std::string ca_cert_dir_path_;
  3990. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  3991. // no certificate, so that a CA that failed to come through fails
  3992. // verification instead of letting the system CAs in.
  3993. bool custom_ca_loaded_ = false;
  3994. bool certs_loaded_ = false;
  3995. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3996. bool server_certificate_verification_ = true;
  3997. bool server_hostname_verification_ = true;
  3998. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  3999. std::string proxy_digest_auth_username_;
  4000. std::string proxy_digest_auth_password_;
  4001. #endif
  4002. };
  4003. template <class Rep, class Period>
  4004. inline void WebSocket::set_read_timeout(
  4005. const std::chrono::duration<Rep, Period> &duration) {
  4006. detail::duration_to_sec_and_usec(
  4007. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4008. }
  4009. template <class Rep, class Period>
  4010. inline void WebSocketClient::set_read_timeout(
  4011. const std::chrono::duration<Rep, Period> &duration) {
  4012. detail::duration_to_sec_and_usec(
  4013. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4014. }
  4015. template <class Rep, class Period>
  4016. inline void WebSocketClient::set_write_timeout(
  4017. const std::chrono::duration<Rep, Period> &duration) {
  4018. detail::duration_to_sec_and_usec(
  4019. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  4020. }
  4021. template <class Rep, class Period>
  4022. inline void WebSocketClient::set_connection_timeout(
  4023. const std::chrono::duration<Rep, Period> &duration) {
  4024. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  4025. set_connection_timeout(sec, usec);
  4026. });
  4027. }
  4028. namespace impl {
  4029. bool is_valid_utf8(const std::string &s);
  4030. // Three states, because a failure that consumed bytes and one that consumed
  4031. // none are not the same thing: the first has left the stream in the middle of
  4032. // a frame and the connection cannot be reused, the second can just be retried.
  4033. enum class FrameRead { Ok, Fail, Timeout };
  4034. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4035. std::string &payload, bool &fin,
  4036. bool expect_masked, size_t max_len);
  4037. } // namespace impl
  4038. } // namespace ws
  4039. // ----------------------------------------------------------------------------
  4040. /*
  4041. * Implementation that will be part of the .cc file if split into .h + .cc.
  4042. */
  4043. namespace stream {
  4044. // stream::Result implementations
  4045. inline Result::Result() : chunk_size_(8192) {}
  4046. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4047. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4048. inline Result::Result(Result &&other) noexcept
  4049. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4050. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4051. finished_(other.finished_) {
  4052. other.current_size_ = 0;
  4053. other.finished_ = true;
  4054. }
  4055. inline Result &Result::operator=(Result &&other) noexcept {
  4056. if (this != &other) {
  4057. handle_ = std::move(other.handle_);
  4058. buffer_ = std::move(other.buffer_);
  4059. current_size_ = other.current_size_;
  4060. chunk_size_ = other.chunk_size_;
  4061. finished_ = other.finished_;
  4062. other.current_size_ = 0;
  4063. other.finished_ = true;
  4064. }
  4065. return *this;
  4066. }
  4067. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4068. inline Result::operator bool() const { return is_valid(); }
  4069. inline int Result::status() const {
  4070. return handle_.response ? handle_.response->status : -1;
  4071. }
  4072. inline const Headers &Result::headers() const {
  4073. static const Headers empty_headers;
  4074. return handle_.response ? handle_.response->headers : empty_headers;
  4075. }
  4076. inline std::string Result::get_header_value(const std::string &key,
  4077. const char *def) const {
  4078. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4079. }
  4080. inline bool Result::has_header(const std::string &key) const {
  4081. return handle_.response ? handle_.response->has_header(key) : false;
  4082. }
  4083. inline Error Result::error() const { return handle_.error; }
  4084. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4085. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4086. inline bool Result::next() {
  4087. if (!handle_.is_valid() || finished_) { return false; }
  4088. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4089. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4090. if (n > 0) {
  4091. current_size_ = static_cast<size_t>(n);
  4092. return true;
  4093. }
  4094. current_size_ = 0;
  4095. finished_ = true;
  4096. return false;
  4097. }
  4098. inline const char *Result::data() const { return buffer_.data(); }
  4099. inline size_t Result::size() const { return current_size_; }
  4100. inline std::string Result::read_all() {
  4101. std::string result;
  4102. while (next()) {
  4103. result.append(data(), size());
  4104. }
  4105. return result;
  4106. }
  4107. } // namespace stream
  4108. namespace sse {
  4109. // SSEMessage implementations
  4110. inline SSEMessage::SSEMessage() : event("message") {}
  4111. inline void SSEMessage::clear() {
  4112. event = "message";
  4113. data.clear();
  4114. id.clear();
  4115. }
  4116. // SSEClient implementations
  4117. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4118. : client_(client), path_(path) {}
  4119. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4120. const Headers &headers)
  4121. : client_(client), path_(path), headers_(headers) {}
  4122. inline SSEClient::~SSEClient() { stop(); }
  4123. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4124. on_message_ = std::move(handler);
  4125. return *this;
  4126. }
  4127. inline SSEClient &SSEClient::on_event(const std::string &type,
  4128. MessageHandler handler) {
  4129. event_handlers_[type] = std::move(handler);
  4130. return *this;
  4131. }
  4132. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4133. on_open_ = std::move(handler);
  4134. return *this;
  4135. }
  4136. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4137. on_error_ = std::move(handler);
  4138. return *this;
  4139. }
  4140. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4141. reconnect_interval_ms_ = ms;
  4142. return *this;
  4143. }
  4144. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4145. max_reconnect_attempts_ = n;
  4146. return *this;
  4147. }
  4148. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4149. std::lock_guard<std::mutex> lock(headers_mutex_);
  4150. headers_ = headers;
  4151. return *this;
  4152. }
  4153. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4154. inline std::string SSEClient::last_event_id() const {
  4155. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4156. return last_event_id_;
  4157. }
  4158. inline void SSEClient::start() {
  4159. running_.store(true);
  4160. run_event_loop();
  4161. }
  4162. inline void SSEClient::start_async() {
  4163. running_.store(true);
  4164. async_thread_ = std::thread([this]() { run_event_loop(); });
  4165. }
  4166. inline void SSEClient::stop() {
  4167. running_.store(false);
  4168. client_.stop(); // Cancel any pending operations
  4169. if (async_thread_.joinable()) { async_thread_.join(); }
  4170. }
  4171. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4172. int &retry_ms, bool &has_data,
  4173. bool &has_id) {
  4174. // Blank line signals end of event
  4175. if (line.empty()) { return true; }
  4176. // Lines starting with ':' are comments (ignored)
  4177. if (line[0] == ':') { return false; }
  4178. // Find the colon separator
  4179. auto colon_pos = line.find(':');
  4180. auto field = line.substr(0, colon_pos);
  4181. std::string value;
  4182. // Value starts after colon, skip optional single space
  4183. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4184. auto value_start = colon_pos + 1;
  4185. if (line[value_start] == ' ') { value_start++; }
  4186. value = line.substr(value_start);
  4187. }
  4188. // Handle known fields
  4189. if (field == "event") {
  4190. // An empty event type is dispatched as "message" per the SSE spec
  4191. msg.event = value.empty() ? std::string("message") : std::move(value);
  4192. } else if (field == "data") {
  4193. // Multiple data lines are concatenated with newlines
  4194. if (has_data) { msg.data += "\n"; }
  4195. msg.data += value;
  4196. has_data = true;
  4197. } else if (field == "id") {
  4198. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4199. // valid (clears the last event ID)
  4200. if (detail::fields::is_field_value(value)) {
  4201. msg.id = value;
  4202. has_id = true;
  4203. }
  4204. } else if (field == "retry") {
  4205. // Parse retry interval in milliseconds
  4206. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4207. if (detail::is_numeric(value)) {
  4208. int v = 0;
  4209. auto res =
  4210. detail::from_chars(value.data(), value.data() + value.size(), v);
  4211. if (res.ec == std::errc{}) { retry_ms = v; }
  4212. }
  4213. }
  4214. // Unknown fields are ignored per SSE spec
  4215. return false;
  4216. }
  4217. inline void SSEClient::run_event_loop() {
  4218. auto reconnect_count = 0;
  4219. while (running_.load()) {
  4220. // Build headers, including Last-Event-ID if we have one
  4221. Headers request_headers;
  4222. {
  4223. std::lock_guard<std::mutex> lock(headers_mutex_);
  4224. request_headers = headers_;
  4225. }
  4226. if (!last_event_id_.empty()) {
  4227. request_headers.emplace("Last-Event-ID", last_event_id_);
  4228. }
  4229. // Open streaming connection. An event stream has no end, so each event is
  4230. // bounded instead of the whole body.
  4231. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4232. handle.body_reader_.payload_max_length = 0;
  4233. // stop() ends a read that is waiting for the next event
  4234. if (handle.stream_) {
  4235. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4236. }
  4237. stream::Result result{std::move(handle)};
  4238. // Connection error handling
  4239. if (!result) {
  4240. connected_.store(false);
  4241. if (on_error_) { on_error_(result.error()); }
  4242. if (!should_reconnect(reconnect_count)) { break; }
  4243. wait_for_reconnect();
  4244. reconnect_count++;
  4245. continue;
  4246. }
  4247. if (result.status() != StatusCode::OK_200) {
  4248. connected_.store(false);
  4249. if (on_error_) { on_error_(Error::Connection); }
  4250. // For certain errors, don't reconnect.
  4251. // Note: 401 is intentionally absent so that handlers can refresh
  4252. // credentials via set_headers() and let the client reconnect.
  4253. if (result.status() == StatusCode::NoContent_204 ||
  4254. result.status() == StatusCode::NotFound_404 ||
  4255. result.status() == StatusCode::Forbidden_403) {
  4256. break;
  4257. }
  4258. if (!should_reconnect(reconnect_count)) { break; }
  4259. wait_for_reconnect();
  4260. reconnect_count++;
  4261. continue;
  4262. }
  4263. // Connection successful
  4264. connected_.store(true);
  4265. reconnect_count = 0;
  4266. if (on_open_) { on_open_(); }
  4267. // Event receiving loop
  4268. std::string buffer;
  4269. SSEMessage current_msg;
  4270. auto has_data = false;
  4271. auto has_id = false;
  4272. auto first_line = true;
  4273. auto after_cr = false;
  4274. auto event_too_long = false;
  4275. while (running_.load() && result.next()) {
  4276. // What is left in the buffer has no line ending
  4277. auto search_pos = buffer.size();
  4278. buffer.append(result.data(), result.size());
  4279. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4280. // per the SSE spec
  4281. size_t line_start = 0;
  4282. size_t eol_pos;
  4283. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4284. std::string::npos) {
  4285. auto line = buffer.substr(line_start, eol_pos - line_start);
  4286. line_start = eol_pos + 1;
  4287. search_pos = line_start;
  4288. // The \n of a \r\n may arrive in a later chunk than its \r
  4289. auto is_lf_of_crlf =
  4290. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4291. after_cr = buffer[eol_pos] == '\r';
  4292. if (is_lf_of_crlf) { continue; }
  4293. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4294. if (first_line) {
  4295. first_line = false;
  4296. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4297. }
  4298. // Parse the line and check if event is complete
  4299. auto event_complete = parse_sse_line(
  4300. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4301. if (event_complete) {
  4302. // Update last_event_id for reconnection, even for an event that
  4303. // has no data. An empty id clears it.
  4304. if (has_id) {
  4305. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4306. last_event_id_ = current_msg.id;
  4307. }
  4308. // An event without a data field is not dispatched
  4309. if (has_data) { dispatch_event(current_msg); }
  4310. // Reset the message for the next event either way
  4311. current_msg.clear();
  4312. has_data = false;
  4313. has_id = false;
  4314. }
  4315. }
  4316. // Keep unprocessed data in buffer
  4317. buffer.erase(0, line_start);
  4318. // Neither an event nor a line still waiting for its end may grow
  4319. // without bound. 0 means no limit.
  4320. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4321. buffer.size() + current_msg.data.size() >
  4322. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4323. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4324. event_too_long = true;
  4325. break;
  4326. }
  4327. }
  4328. // Connection ended
  4329. connected_.store(false);
  4330. // Reconnecting would only get the same event again
  4331. if (!running_.load() || event_too_long) { break; }
  4332. // Check for read errors
  4333. if (result.has_read_error()) {
  4334. if (on_error_) { on_error_(result.read_error()); }
  4335. }
  4336. if (!should_reconnect(reconnect_count)) { break; }
  4337. wait_for_reconnect();
  4338. reconnect_count++;
  4339. }
  4340. connected_.store(false);
  4341. }
  4342. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4343. // Check for specific event type handler first
  4344. auto it = event_handlers_.find(msg.event);
  4345. if (it != event_handlers_.end()) {
  4346. it->second(msg);
  4347. return;
  4348. }
  4349. // Fall back to generic message handler
  4350. if (on_message_) { on_message_(msg); }
  4351. }
  4352. inline bool SSEClient::should_reconnect(int count) const {
  4353. if (!running_.load()) { return false; }
  4354. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4355. return count < max_reconnect_attempts_;
  4356. }
  4357. inline void SSEClient::wait_for_reconnect() {
  4358. // Use small increments to check running_ flag frequently.
  4359. // Always wait at least one increment, so that a zero interval (e.g.
  4360. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4361. const auto step_ms = 100;
  4362. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4363. auto waited = 0;
  4364. while (running_.load() && waited < interval_ms) {
  4365. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4366. waited += step_ms;
  4367. }
  4368. }
  4369. } // namespace sse
  4370. #ifdef CPPHTTPLIB_SSL_ENABLED
  4371. /*
  4372. * TLS abstraction layer - internal function declarations
  4373. * These are implementation details and not part of the public API.
  4374. */
  4375. namespace tls {
  4376. // Client context
  4377. ctx_t create_client_context();
  4378. void free_context(ctx_t ctx);
  4379. bool set_min_version(ctx_t ctx, Version version);
  4380. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4381. bool load_ca_file(ctx_t ctx, const char *file_path);
  4382. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4383. bool load_system_certs(ctx_t ctx);
  4384. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4385. const char *password);
  4386. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4387. const char *key_path, const char *password);
  4388. // Server context
  4389. ctx_t create_server_context();
  4390. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4391. const char *password);
  4392. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4393. const char *key_path, const char *password);
  4394. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4395. void set_verify_client(ctx_t ctx, bool require);
  4396. // Session management
  4397. session_t create_session(ctx_t ctx, socket_t sock);
  4398. void free_session(session_t session);
  4399. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4400. // Handshake (non-blocking capable)
  4401. TlsError connect(session_t session);
  4402. TlsError accept(session_t session);
  4403. // Handshake with timeout (blocking until timeout)
  4404. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4405. time_t timeout_usec, TlsError *err);
  4406. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4407. time_t timeout_usec, TlsError *err);
  4408. // I/O (non-blocking capable)
  4409. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4410. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4411. int pending(const_session_t session);
  4412. void shutdown(session_t session, bool graceful);
  4413. // Connection state
  4414. bool is_peer_closed(session_t session, socket_t sock);
  4415. // Certificate verification
  4416. cert_t get_peer_cert(const_session_t session);
  4417. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4418. // do not use them after free_session(), as with get_peer_cert().
  4419. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4420. void free_cert(cert_t cert);
  4421. // Matches the host against the subjectAltName entries only, never the Common
  4422. // Name (RFC 9525).
  4423. bool verify_hostname(cert_t cert, const char *hostname);
  4424. uint64_t hostname_mismatch_code();
  4425. long get_verify_result(const_session_t session);
  4426. // Certificate introspection
  4427. std::string get_cert_subject_cn(cert_t cert);
  4428. std::string get_cert_issuer_name(cert_t cert);
  4429. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4430. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4431. std::string get_cert_serial(cert_t cert);
  4432. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4433. const char *get_sni(const_session_t session);
  4434. // CA store management
  4435. ca_store_t create_ca_store(const char *pem, size_t len);
  4436. void free_ca_store(ca_store_t store);
  4437. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4438. // Free each with free_cert(), and do not use them once the context's CA
  4439. // certificates change.
  4440. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4441. std::vector<std::string> get_ca_names(ctx_t ctx);
  4442. // Dynamic certificate update (for servers)
  4443. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4444. const char *password);
  4445. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4446. // Certificate verification callback
  4447. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4448. long get_verify_error(const_session_t session);
  4449. std::string verify_error_string(long error_code);
  4450. // TlsError information
  4451. uint64_t peek_error();
  4452. uint64_t get_error();
  4453. std::string error_string(uint64_t code);
  4454. } // namespace tls
  4455. #endif // CPPHTTPLIB_SSL_ENABLED
  4456. /*
  4457. * Group 1: detail namespace - Non-SSL utilities
  4458. */
  4459. namespace detail {
  4460. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4461. const void *optval, socklen_t optlen) {
  4462. return setsockopt(sock, level, optname,
  4463. #ifdef _WIN32
  4464. reinterpret_cast<const char *>(optval),
  4465. #else
  4466. optval,
  4467. #endif
  4468. optlen) == 0;
  4469. }
  4470. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4471. time_t sec, time_t usec) {
  4472. #ifdef _WIN32
  4473. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4474. #else
  4475. timeval timeout;
  4476. timeout.tv_sec = static_cast<long>(sec);
  4477. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4478. #endif
  4479. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4480. }
  4481. inline bool is_hex(char c, int &v) {
  4482. if (is_ascii_digit(c)) {
  4483. v = c - '0';
  4484. return true;
  4485. } else if ('A' <= c && c <= 'F') {
  4486. v = c - 'A' + 10;
  4487. return true;
  4488. } else if ('a' <= c && c <= 'f') {
  4489. v = c - 'a' + 10;
  4490. return true;
  4491. }
  4492. return false;
  4493. }
  4494. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4495. int &val) {
  4496. if (i >= s.size()) { return false; }
  4497. val = 0;
  4498. for (; cnt; i++, cnt--) {
  4499. if (!s[i]) { return false; }
  4500. auto v = 0;
  4501. if (is_hex(s[i], v)) {
  4502. val = val * 16 + v;
  4503. } else {
  4504. return false;
  4505. }
  4506. }
  4507. return true;
  4508. }
  4509. inline std::string from_i_to_hex(size_t n) {
  4510. static const auto charset = "0123456789abcdef";
  4511. std::string ret;
  4512. do {
  4513. ret = charset[n & 15] + ret;
  4514. n >>= 4;
  4515. } while (n > 0);
  4516. return ret;
  4517. }
  4518. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4519. // builds and trips -Wtautological-type-limit-compare.
  4520. inline bool fits_in_size_t(uint64_t n) {
  4521. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4522. }
  4523. inline std::string compute_etag(const FileStat &fs,
  4524. const std::string &suffix = std::string()) {
  4525. if (!fs.is_file()) { return std::string(); }
  4526. // If mtime cannot be determined (negative value indicates an error
  4527. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4528. // value like 0 could collide with a real file that legitimately has
  4529. // mtime == 0 (epoch) and lead to misleading validators.
  4530. auto mtime_raw = fs.mtime();
  4531. if (mtime_raw < 0) { return std::string(); }
  4532. auto mtime = static_cast<size_t>(mtime_raw);
  4533. auto size = fs.size();
  4534. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4535. from_i_to_hex(size) + suffix + "\"";
  4536. }
  4537. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4538. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4539. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4540. inline std::string file_mtime_to_http_date(time_t mtime) {
  4541. if (mtime < 0) { return std::string(); }
  4542. struct tm tm_buf;
  4543. #ifdef _WIN32
  4544. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4545. #else
  4546. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4547. #endif
  4548. char buf[64];
  4549. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4550. return std::string();
  4551. }
  4552. return std::string(buf);
  4553. }
  4554. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4555. inline time_t parse_http_date(const std::string &date_str) {
  4556. struct tm tm_buf;
  4557. // Create a classic locale object once for all parsing attempts
  4558. const std::locale classic_locale = std::locale::classic();
  4559. // Try to parse using std::get_time (C++11, cross-platform)
  4560. auto try_parse = [&](const char *fmt) -> bool {
  4561. std::istringstream ss(date_str);
  4562. ss.imbue(classic_locale);
  4563. memset(&tm_buf, 0, sizeof(tm_buf));
  4564. ss >> std::get_time(&tm_buf, fmt);
  4565. return !ss.fail();
  4566. };
  4567. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4568. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4569. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4570. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4571. // asctime format: "Sun Nov 6 08:49:37 1994"
  4572. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4573. return static_cast<time_t>(-1);
  4574. }
  4575. }
  4576. }
  4577. #ifdef _WIN32
  4578. return _mkgmtime(&tm_buf);
  4579. #elif defined _AIX
  4580. return mktime(&tm_buf);
  4581. #else
  4582. return timegm(&tm_buf);
  4583. #endif
  4584. }
  4585. inline bool is_weak_etag(const std::string &s) {
  4586. // Check if the string is a weak ETag (starts with 'W/"')
  4587. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4588. }
  4589. inline bool is_strong_etag(const std::string &s) {
  4590. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4591. // chars)
  4592. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4593. }
  4594. inline size_t to_utf8(int code, char *buff) {
  4595. if (code < 0x0080) {
  4596. buff[0] = static_cast<char>(code & 0x7F);
  4597. return 1;
  4598. } else if (code < 0x0800) {
  4599. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4600. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4601. return 2;
  4602. } else if (code < 0xD800) {
  4603. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4604. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4605. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4606. return 3;
  4607. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4608. return 0;
  4609. } else if (code < 0x10000) {
  4610. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4611. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4612. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4613. return 3;
  4614. } else if (code < 0x110000) {
  4615. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4616. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4617. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4618. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4619. return 4;
  4620. }
  4621. // NOTREACHED
  4622. return 0;
  4623. }
  4624. } // namespace detail
  4625. namespace ws {
  4626. namespace impl {
  4627. inline bool is_valid_utf8(const std::string &s) {
  4628. size_t i = 0;
  4629. auto n = s.size();
  4630. while (i < n) {
  4631. auto c = static_cast<unsigned char>(s[i]);
  4632. size_t len;
  4633. uint32_t cp;
  4634. if (c < 0x80) {
  4635. i++;
  4636. continue;
  4637. } else if ((c & 0xE0) == 0xC0) {
  4638. len = 2;
  4639. cp = c & 0x1F;
  4640. } else if ((c & 0xF0) == 0xE0) {
  4641. len = 3;
  4642. cp = c & 0x0F;
  4643. } else if ((c & 0xF8) == 0xF0) {
  4644. len = 4;
  4645. cp = c & 0x07;
  4646. } else {
  4647. return false;
  4648. }
  4649. if (i + len > n) { return false; }
  4650. for (size_t j = 1; j < len; j++) {
  4651. auto b = static_cast<unsigned char>(s[i + j]);
  4652. if ((b & 0xC0) != 0x80) { return false; }
  4653. cp = (cp << 6) | (b & 0x3F);
  4654. }
  4655. // Overlong encoding check
  4656. if (len == 2 && cp < 0x80) { return false; }
  4657. if (len == 3 && cp < 0x800) { return false; }
  4658. if (len == 4 && cp < 0x10000) { return false; }
  4659. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4660. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4661. if (cp > 0x10FFFF) { return false; }
  4662. i += len;
  4663. }
  4664. return true;
  4665. }
  4666. } // namespace impl
  4667. } // namespace ws
  4668. namespace detail {
  4669. // NOTE: This code came up with the following stackoverflow post:
  4670. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4671. inline std::string base64_encode(const std::string &in) {
  4672. static const auto lookup =
  4673. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4674. std::string out;
  4675. out.reserve(in.size());
  4676. // Unsigned: the accumulator is never masked, so with a signed int the
  4677. // `val << 8` below overflows once enough bytes are folded in (undefined
  4678. // behaviour before C++20). Only the low bits are ever emitted, so the
  4679. // wrap-around of an unsigned accumulator does not affect the output.
  4680. uint32_t val = 0;
  4681. auto valb = -6;
  4682. for (auto c : in) {
  4683. val = (val << 8) + static_cast<uint8_t>(c);
  4684. valb += 8;
  4685. while (valb >= 0) {
  4686. out.push_back(lookup[(val >> valb) & 0x3F]);
  4687. valb -= 6;
  4688. }
  4689. }
  4690. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4691. while (out.size() % 4) {
  4692. out.push_back('=');
  4693. }
  4694. return out;
  4695. }
  4696. inline std::string sha1(const std::string &input) {
  4697. // RFC 3174 SHA-1 implementation
  4698. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4699. return (x << n) | (x >> (32 - n));
  4700. };
  4701. uint32_t h0 = 0x67452301;
  4702. uint32_t h1 = 0xEFCDAB89;
  4703. uint32_t h2 = 0x98BADCFE;
  4704. uint32_t h3 = 0x10325476;
  4705. uint32_t h4 = 0xC3D2E1F0;
  4706. // Pre-processing: adding padding bits
  4707. std::string msg = input;
  4708. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4709. msg.push_back(static_cast<char>(0x80u));
  4710. while (msg.size() % 64 != 56) {
  4711. msg.push_back(0);
  4712. }
  4713. // Append original length in bits as 64-bit big-endian
  4714. for (int i = 56; i >= 0; i -= 8) {
  4715. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4716. }
  4717. // Process each 512-bit chunk
  4718. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4719. uint32_t w[80];
  4720. for (size_t i = 0; i < 16; i++) {
  4721. w[i] =
  4722. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4723. << 24) |
  4724. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4725. << 16) |
  4726. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4727. << 8) |
  4728. (static_cast<uint32_t>(
  4729. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4730. }
  4731. for (int i = 16; i < 80; i++) {
  4732. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4733. }
  4734. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4735. for (int i = 0; i < 80; i++) {
  4736. uint32_t f, k;
  4737. if (i < 20) {
  4738. f = (b & c) | ((~b) & d);
  4739. k = 0x5A827999;
  4740. } else if (i < 40) {
  4741. f = b ^ c ^ d;
  4742. k = 0x6ED9EBA1;
  4743. } else if (i < 60) {
  4744. f = (b & c) | (b & d) | (c & d);
  4745. k = 0x8F1BBCDC;
  4746. } else {
  4747. f = b ^ c ^ d;
  4748. k = 0xCA62C1D6;
  4749. }
  4750. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4751. e = d;
  4752. d = c;
  4753. c = left_rotate(b, 30);
  4754. b = a;
  4755. a = temp;
  4756. }
  4757. h0 += a;
  4758. h1 += b;
  4759. h2 += c;
  4760. h3 += d;
  4761. h4 += e;
  4762. }
  4763. // Produce the final hash as a 20-byte binary string
  4764. std::string hash(20, '\0');
  4765. for (size_t i = 0; i < 4; i++) {
  4766. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4767. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4768. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4769. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4770. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4771. }
  4772. return hash;
  4773. }
  4774. inline std::string websocket_accept_key(const std::string &client_key) {
  4775. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4776. return base64_encode(sha1(client_key + magic));
  4777. }
  4778. inline bool is_websocket_upgrade(const Request &req) {
  4779. if (req.method != "GET") { return false; }
  4780. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4781. // list of protocols and asks recipients to match each name
  4782. // case-insensitively, so look for the token rather than compare the whole
  4783. // field value.
  4784. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4785. // Check Connection: Upgrade
  4786. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4787. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4788. // RFC 6455 Section 4.2.1
  4789. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4790. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4791. return false;
  4792. }
  4793. static const std::string b64chars =
  4794. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4795. for (size_t i = 0; i < 22; i++) {
  4796. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4797. }
  4798. // Check Sec-WebSocket-Version: 13
  4799. auto version = req.get_header_value("Sec-WebSocket-Version");
  4800. if (version != "13") { return false; }
  4801. return true;
  4802. }
  4803. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4804. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4805. thread_local std::random_device rd;
  4806. size_t filled = 0;
  4807. while (filled < n) {
  4808. auto v = rd();
  4809. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4810. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4811. }
  4812. }
  4813. }
  4814. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4815. const char *data, size_t len, bool fin,
  4816. bool mask) {
  4817. // First byte: FIN + opcode
  4818. uint8_t header[2];
  4819. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4820. (static_cast<uint8_t>(opcode) & 0x0F));
  4821. // Second byte: MASK + payload length
  4822. if (len < 126) {
  4823. header[1] = static_cast<uint8_t>(len);
  4824. if (mask) { header[1] |= 0x80; }
  4825. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4826. return false;
  4827. }
  4828. } else if (len <= 0xFFFF) {
  4829. header[1] = 126;
  4830. if (mask) { header[1] |= 0x80; }
  4831. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4832. return false;
  4833. }
  4834. uint8_t ext[2];
  4835. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4836. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4837. if (!write_data(strm, reinterpret_cast<char *>(ext), 2)) { return false; }
  4838. } else {
  4839. header[1] = 127;
  4840. if (mask) { header[1] |= 0x80; }
  4841. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4842. return false;
  4843. }
  4844. uint8_t ext[8];
  4845. for (int i = 7; i >= 0; i--) {
  4846. ext[7 - i] =
  4847. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4848. }
  4849. if (!write_data(strm, reinterpret_cast<char *>(ext), 8)) { return false; }
  4850. }
  4851. if (mask) {
  4852. // Generate random mask key
  4853. uint8_t mask_key[4];
  4854. fill_random_bytes(mask_key, sizeof(mask_key));
  4855. if (!write_data(strm, reinterpret_cast<char *>(mask_key), 4)) {
  4856. return false;
  4857. }
  4858. // Write masked payload in chunks
  4859. const size_t chunk_size = 4096;
  4860. std::vector<char> buf((std::min)(len, chunk_size));
  4861. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4862. size_t n = (std::min)(chunk_size, len - offset);
  4863. for (size_t i = 0; i < n; i++) {
  4864. buf[i] =
  4865. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4866. }
  4867. if (!write_data(strm, buf.data(), n)) { return false; }
  4868. }
  4869. } else {
  4870. if (len > 0) {
  4871. if (!write_data(strm, data, len)) { return false; }
  4872. }
  4873. }
  4874. return true;
  4875. }
  4876. } // namespace detail
  4877. namespace ws {
  4878. namespace impl {
  4879. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4880. // hands back whatever its buffer already holds -- so every multi-byte field has
  4881. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4882. // header straddles the read buffer's boundary.
  4883. //
  4884. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4885. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4886. // there is a failure like any other. (When read() fails it always records why,
  4887. // so the error belongs to this call and not to an earlier one.)
  4888. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4889. auto p = static_cast<char *>(buf);
  4890. size_t total = 0;
  4891. while (total < size) {
  4892. auto n = strm.read(p + total, size - total);
  4893. if (n <= 0) {
  4894. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4895. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4896. }
  4897. total += static_cast<size_t>(n);
  4898. }
  4899. return FrameRead::Ok;
  4900. }
  4901. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4902. std::string &payload, bool &fin,
  4903. bool expect_masked, size_t max_len) {
  4904. // Read first 2 bytes. This is the only read that may report a timeout: it
  4905. // sits on a frame boundary, where nothing has been consumed yet.
  4906. uint8_t header[2];
  4907. FrameRead first = read_exact(strm, header, 2);
  4908. if (first != FrameRead::Ok) { return first; }
  4909. fin = (header[0] & 0x80) != 0;
  4910. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4911. if (header[0] & 0x70) { return FrameRead::Fail; }
  4912. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4913. bool masked = (header[1] & 0x80) != 0;
  4914. uint64_t payload_len = header[1] & 0x7F;
  4915. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4916. // MUST have a payload length of 125 bytes or less
  4917. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4918. if (is_control) {
  4919. if (!fin) { return FrameRead::Fail; }
  4920. if (payload_len > 125) { return FrameRead::Fail; }
  4921. }
  4922. if (masked != expect_masked) { return FrameRead::Fail; }
  4923. // Extended payload length
  4924. if (payload_len == 126) {
  4925. uint8_t ext[2];
  4926. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4927. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4928. } else if (payload_len == 127) {
  4929. uint8_t ext[8];
  4930. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4931. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4932. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4933. payload_len = 0;
  4934. for (int i = 0; i < 8; i++) {
  4935. payload_len = (payload_len << 8) | ext[i];
  4936. }
  4937. }
  4938. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4939. // size_t cannot hold (32-bit builds) is refused either way.
  4940. if ((max_len > 0 && payload_len > max_len) ||
  4941. !detail::fits_in_size_t(payload_len)) {
  4942. return FrameRead::Fail;
  4943. }
  4944. // Read mask key if present
  4945. uint8_t mask_key[4] = {0};
  4946. if (masked) {
  4947. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4948. return FrameRead::Fail;
  4949. }
  4950. }
  4951. // Grow the payload only as it arrives, since a header alone can announce
  4952. // max_len bytes that never come.
  4953. payload.clear();
  4954. auto len = static_cast<size_t>(payload_len);
  4955. while (payload.size() < len) {
  4956. auto offset = payload.size();
  4957. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4958. payload.resize(offset + n);
  4959. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4960. return FrameRead::Fail;
  4961. }
  4962. }
  4963. // Unmask if needed
  4964. if (masked) {
  4965. for (size_t i = 0; i < payload.size(); i++) {
  4966. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4967. }
  4968. }
  4969. return FrameRead::Ok;
  4970. }
  4971. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4972. // be sent followed by a UTF-8 reason.
  4973. inline bool is_valid_close_payload(const std::string &payload) {
  4974. if (payload.empty()) { return true; }
  4975. if (payload.size() < 2) { return false; }
  4976. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  4977. static_cast<uint8_t>(payload[1]);
  4978. auto may_be_sent = (1000 <= code && code <= 1003) ||
  4979. (1007 <= code && code <= 1014) ||
  4980. (3000 <= code && code <= 4999);
  4981. return may_be_sent && is_valid_utf8(payload.substr(2));
  4982. }
  4983. } // namespace impl
  4984. } // namespace ws
  4985. namespace detail {
  4986. // A path a mount point serves: absolute, with no empty segment except a
  4987. // trailing '/' and no segment ending in '.' or a space (which covers "." and
  4988. // ".." and names Windows trims into another file's name), so the file served
  4989. // is the one that req.path names to the handlers that ran before it.
  4990. inline bool is_valid_path(const std::string &path) {
  4991. if (path.empty() || path[0] != '/') { return false; }
  4992. auto beg = size_t{1};
  4993. for (auto i = beg; i <= path.size(); i++) {
  4994. if (i < path.size() && path[i] != '/') {
  4995. if (path[i] == '\0' || path[i] == '\\') { return false; }
  4996. continue;
  4997. }
  4998. auto len = i - beg;
  4999. if ((len == 0 && i < path.size()) ||
  5000. (len > 0 && (path[i - 1] == '.' || path[i - 1] == ' '))) {
  5001. return false;
  5002. }
  5003. beg = i + 1;
  5004. }
  5005. return true;
  5006. }
  5007. inline bool canonicalize_path(const char *path, std::string &resolved) {
  5008. #if defined(_WIN32)
  5009. char buf[_MAX_PATH];
  5010. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  5011. resolved = buf;
  5012. #elif defined(PATH_MAX)
  5013. char buf[PATH_MAX];
  5014. if (realpath(path, buf) == nullptr) { return false; }
  5015. resolved = buf;
  5016. #else
  5017. auto buf = realpath(path, nullptr);
  5018. auto guard = scope_exit([&]() { std::free(buf); });
  5019. if (buf == nullptr) { return false; }
  5020. resolved = buf;
  5021. #endif
  5022. return true;
  5023. }
  5024. inline bool is_path_within_base(const std::string &resolved_path,
  5025. const std::string &resolved_base) {
  5026. #if defined(_WIN32)
  5027. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  5028. resolved_base.size()) == 0;
  5029. #else
  5030. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  5031. resolved_base.size()) == 0;
  5032. #endif
  5033. }
  5034. inline FileStat::FileStat(const std::string &path) {
  5035. #if defined(_WIN32)
  5036. auto wpath = u8string_to_wstring(path.c_str());
  5037. ret_ = _wstat(wpath.c_str(), &st_);
  5038. #else
  5039. ret_ = stat(path.c_str(), &st_);
  5040. #endif
  5041. }
  5042. inline bool FileStat::is_file() const {
  5043. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5044. }
  5045. inline bool FileStat::is_dir() const {
  5046. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5047. }
  5048. inline time_t FileStat::mtime() const {
  5049. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5050. : static_cast<time_t>(-1);
  5051. }
  5052. inline size_t FileStat::size() const {
  5053. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5054. }
  5055. inline std::string encode_path(const std::string &s) {
  5056. std::string result;
  5057. result.reserve(s.size());
  5058. for (size_t i = 0; s[i]; i++) {
  5059. switch (s[i]) {
  5060. case ' ': result += "%20"; break;
  5061. case '+': result += "%2B"; break;
  5062. case '\'': result += "%27"; break;
  5063. case ',': result += "%2C"; break;
  5064. // case ':': result += "%3A"; break; // ok? probably...
  5065. case ';': result += "%3B"; break;
  5066. default:
  5067. auto c = static_cast<uint8_t>(s[i]);
  5068. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5069. // in a request-target as-is.
  5070. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5071. result += '%';
  5072. char hex[4];
  5073. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5074. assert(len == 2);
  5075. result.append(hex, static_cast<size_t>(len));
  5076. } else {
  5077. result += s[i];
  5078. }
  5079. break;
  5080. }
  5081. }
  5082. return result;
  5083. }
  5084. inline std::string file_extension(const std::string &path) {
  5085. auto i = path.size();
  5086. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5087. i--;
  5088. }
  5089. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5090. return std::string();
  5091. }
  5092. return path.substr(i);
  5093. }
  5094. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5095. template <typename T>
  5096. inline bool parse_header(const char *beg, const char *end, T fn);
  5097. template <typename T>
  5098. inline bool parse_header(const char *beg, const char *end, T fn) {
  5099. // Skip trailing spaces and tabs.
  5100. while (beg < end && is_space_or_tab(end[-1])) {
  5101. end--;
  5102. }
  5103. auto p = beg;
  5104. while (p < end && *p != ':') {
  5105. p++;
  5106. }
  5107. auto name = std::string(beg, p);
  5108. if (!detail::fields::is_field_name(name)) { return false; }
  5109. if (p == end) { return false; }
  5110. auto key_end = p;
  5111. if (*p++ != ':') { return false; }
  5112. while (p < end && is_space_or_tab(*p)) {
  5113. p++;
  5114. }
  5115. if (p <= end) {
  5116. auto key_len = key_end - beg;
  5117. if (!key_len) { return false; }
  5118. auto key = std::string(beg, key_end);
  5119. auto val = std::string(p, end);
  5120. if (!detail::fields::is_field_value(val)) { return false; }
  5121. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5122. // percent-decoded by the recipient. Applications that need to interpret a
  5123. // value as a URI component should call httplib::decode_uri_component()
  5124. // (or decode_path_component()) explicitly.
  5125. fn(key, val);
  5126. return true;
  5127. }
  5128. return false;
  5129. }
  5130. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5131. const Headers &src_headers) {
  5132. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5133. // transfer coding is complete when a chunk with a chunk-size of zero is
  5134. // received, possibly followed by a trailer section, and finally terminated by
  5135. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5136. //
  5137. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5138. // doesn't care for the existence of the final CRLF. In other words, it seems
  5139. // to be ok whether the final CRLF exists or not in the chunked data.
  5140. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5141. //
  5142. // According to the reference code in RFC 9112, cpp-httplib now allows
  5143. // chunked transfer coding data without the final CRLF.
  5144. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5145. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5146. "transfer-encoding",
  5147. "content-length",
  5148. "host",
  5149. "authorization",
  5150. "www-authenticate",
  5151. "proxy-authenticate",
  5152. "proxy-authorization",
  5153. "cookie",
  5154. "set-cookie",
  5155. "cache-control",
  5156. "expect",
  5157. "max-forwards",
  5158. "pragma",
  5159. "range",
  5160. "te",
  5161. "age",
  5162. "expires",
  5163. "date",
  5164. "location",
  5165. "retry-after",
  5166. "vary",
  5167. "warning",
  5168. "content-encoding",
  5169. "content-type",
  5170. "content-range",
  5171. "trailer"};
  5172. case_ignore::unordered_set<std::string> declared_trailers;
  5173. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5174. if (!trailer_header.empty()) {
  5175. // split() trims each token and skips empty ones, so the name arrives ready
  5176. // to look up.
  5177. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5178. ',', [&](const char *b, const char *e) {
  5179. // A legitimate message declares only a handful of trailers. Cap the
  5180. // set so a peer cannot grow it without bound: an oversized set only
  5181. // arises from an attempt to force many colliding names into
  5182. // quadratic lookups (case_ignore::hash is unkeyed).
  5183. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5184. return;
  5185. }
  5186. std::string key(b, e);
  5187. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5188. declared_trailers.insert(key);
  5189. }
  5190. });
  5191. }
  5192. size_t trailer_header_count = 0;
  5193. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5194. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5195. // Count every received trailer field, not only the declared ones stored in
  5196. // dest, so undeclared fields cannot keep this loop running past the limit.
  5197. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5198. constexpr auto line_terminator_len = 2;
  5199. auto line_beg = line_reader.ptr();
  5200. auto line_end =
  5201. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5202. if (!parse_header(line_beg, line_end,
  5203. [&](const std::string &key, const std::string &val) {
  5204. if (declared_trailers.find(key) !=
  5205. declared_trailers.end()) {
  5206. dest.emplace(key, val);
  5207. }
  5208. })) {
  5209. return false;
  5210. }
  5211. trailer_header_count++;
  5212. if (!line_reader.getline()) { return false; }
  5213. }
  5214. return true;
  5215. }
  5216. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5217. size_t right) {
  5218. while (b + left < e && is_space_or_tab(b[left])) {
  5219. left++;
  5220. }
  5221. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5222. right--;
  5223. }
  5224. return std::make_pair(left, right);
  5225. }
  5226. inline std::string trim_copy(const std::string &s) {
  5227. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5228. return s.substr(r.first, r.second - r.first);
  5229. }
  5230. inline std::string trim_double_quotes_copy(const std::string &s) {
  5231. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5232. return s.substr(1, s.size() - 2);
  5233. }
  5234. return s;
  5235. }
  5236. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5237. // here, as browsers send any other backslash, such as one in a Windows path,
  5238. // as it is.
  5239. inline std::string unquote_param(const std::string &s) {
  5240. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5241. std::string out;
  5242. for (size_t i = 1; i + 1 < s.size(); i++) {
  5243. if (s[i] == '\\' && i + 2 < s.size() &&
  5244. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5245. i++;
  5246. }
  5247. out += s[i];
  5248. }
  5249. return out;
  5250. }
  5251. inline void
  5252. divide(const char *data, std::size_t size, char d,
  5253. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5254. fn) {
  5255. const auto it = std::find(data, data + size, d);
  5256. const auto found = static_cast<std::size_t>(it != data + size);
  5257. const auto lhs_data = data;
  5258. const auto lhs_size = static_cast<std::size_t>(it - data);
  5259. const auto rhs_data = it + found;
  5260. const auto rhs_size = size - lhs_size - found;
  5261. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5262. }
  5263. inline void
  5264. divide(const std::string &str, char d,
  5265. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5266. fn) {
  5267. divide(str.data(), str.size(), d, std::move(fn));
  5268. }
  5269. inline void split(const char *b, const char *e, char d,
  5270. std::function<void(const char *, const char *)> fn) {
  5271. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5272. }
  5273. inline void split(const char *b, const char *e, char d, size_t m,
  5274. std::function<void(const char *, const char *)> fn) {
  5275. size_t i = 0;
  5276. size_t beg = 0;
  5277. size_t count = 1;
  5278. while (e ? (b + i < e) : (b[i] != '\0')) {
  5279. if (b[i] == d && count < m) {
  5280. auto r = trim(b, e, beg, i);
  5281. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5282. beg = i + 1;
  5283. count++;
  5284. }
  5285. i++;
  5286. }
  5287. if (i) {
  5288. auto r = trim(b, e, beg, i);
  5289. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5290. }
  5291. }
  5292. // Same contract as split(), except that a delimiter inside a quoted-string is
  5293. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5294. // quoted-string, and ';' and '=' are legal characters inside one.
  5295. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5296. std::function<void(const char *, const char *)> fn) {
  5297. size_t i = 0;
  5298. size_t beg = 0;
  5299. size_t count = 1;
  5300. auto in_quotes = false;
  5301. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5302. while (has(i)) {
  5303. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5304. // A quoted-pair, whose second character does not end the string.
  5305. i++;
  5306. } else if (b[i] == '"') {
  5307. in_quotes = !in_quotes;
  5308. } else if (b[i] == d && !in_quotes && count < m) {
  5309. auto r = trim(b, e, beg, i);
  5310. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5311. beg = i + 1;
  5312. count++;
  5313. }
  5314. i++;
  5315. }
  5316. if (i) {
  5317. auto r = trim(b, e, beg, i);
  5318. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5319. }
  5320. }
  5321. inline void split_unquoted(const char *b, const char *e, char d,
  5322. std::function<void(const char *, const char *)> fn) {
  5323. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5324. std::move(fn));
  5325. }
  5326. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5327. // key a token, so the first '=' is the separator even when the value is a
  5328. // quoted-string carrying more of them.
  5329. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5330. std::string &val) {
  5331. divide(
  5332. b, static_cast<std::size_t>(e - b), '=',
  5333. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5334. const auto kr = trim(kb, kb + klen, 0, klen);
  5335. key.assign(kb + kr.first, kb + kr.second);
  5336. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5337. val.assign(vb + vr.first, vb + vr.second);
  5338. });
  5339. }
  5340. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5341. std::function<bool(const char *, const char *)> fn) {
  5342. size_t i = 0;
  5343. size_t beg = 0;
  5344. size_t count = 1;
  5345. while (e ? (b + i < e) : (b[i] != '\0')) {
  5346. if (b[i] == d && count < m) {
  5347. auto r = trim(b, e, beg, i);
  5348. if (r.first < r.second) {
  5349. auto found = fn(&b[r.first], &b[r.second]);
  5350. if (found) { return true; }
  5351. }
  5352. beg = i + 1;
  5353. count++;
  5354. }
  5355. i++;
  5356. }
  5357. if (i) {
  5358. auto r = trim(b, e, beg, i);
  5359. if (r.first < r.second) {
  5360. auto found = fn(&b[r.first], &b[r.second]);
  5361. if (found) { return true; }
  5362. }
  5363. }
  5364. return false;
  5365. }
  5366. inline bool split_find(const char *b, const char *e, char d,
  5367. std::function<bool(const char *, const char *)> fn) {
  5368. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5369. std::move(fn));
  5370. }
  5371. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5372. size_t fixed_buffer_size)
  5373. : strm_(strm), fixed_buffer_(fixed_buffer),
  5374. fixed_buffer_size_(fixed_buffer_size) {}
  5375. inline const char *stream_line_reader::ptr() const {
  5376. if (growable_buffer_.empty()) {
  5377. return fixed_buffer_;
  5378. } else {
  5379. return growable_buffer_.data();
  5380. }
  5381. }
  5382. inline size_t stream_line_reader::size() const {
  5383. if (growable_buffer_.empty()) {
  5384. return fixed_buffer_used_size_;
  5385. } else {
  5386. return growable_buffer_.size();
  5387. }
  5388. }
  5389. inline bool stream_line_reader::end_with_crlf() const {
  5390. auto end = ptr() + size();
  5391. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5392. }
  5393. inline bool stream_line_reader::getline() {
  5394. fixed_buffer_used_size_ = 0;
  5395. growable_buffer_.clear();
  5396. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5397. char prev_byte = 0;
  5398. #endif
  5399. for (size_t i = 0;; i++) {
  5400. // Fast path: whatever the stream has already buffered can be scanned for
  5401. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5402. // call, a bounds check and a one-byte copy per character of the request.
  5403. size_t buffered_size = 0;
  5404. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5405. auto take = buffered_size;
  5406. auto terminated = false;
  5407. for (size_t at = 0; at < buffered_size;) {
  5408. auto nl = static_cast<const char *>(
  5409. memchr(buffered + at, '\n', buffered_size - at));
  5410. if (!nl) { break; }
  5411. auto pos = static_cast<size_t>(nl - buffered);
  5412. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5413. take = pos + 1;
  5414. terminated = true;
  5415. break;
  5416. #else
  5417. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5418. // be the last byte of an earlier chunk, hence prev_byte.
  5419. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5420. take = pos + 1;
  5421. terminated = true;
  5422. break;
  5423. }
  5424. at = pos + 1;
  5425. #endif
  5426. }
  5427. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5428. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5429. prev_byte = buffered[take - 1];
  5430. #endif
  5431. append(buffered, take);
  5432. strm_.consume_buffered(take);
  5433. i += take;
  5434. if (terminated) { return true; }
  5435. continue;
  5436. }
  5437. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5438. // Treat exceptionally long lines as an error to
  5439. // prevent infinite loops/memory exhaustion
  5440. return false;
  5441. }
  5442. char byte;
  5443. auto n = strm_.read(&byte, 1);
  5444. if (n < 0) {
  5445. return false;
  5446. } else if (n == 0) {
  5447. if (i == 0) {
  5448. return false;
  5449. } else {
  5450. break;
  5451. }
  5452. }
  5453. append(byte);
  5454. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5455. if (byte == '\n') { break; }
  5456. #else
  5457. if (prev_byte == '\r' && byte == '\n') { break; }
  5458. prev_byte = byte;
  5459. #endif
  5460. }
  5461. return true;
  5462. }
  5463. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5464. inline void stream_line_reader::append(const char *data, size_t size) {
  5465. // Once the line has outgrown the fixed buffer everything must keep going to
  5466. // the growable one, even if a later chunk would have fit. Without the
  5467. // emptiness check a short append after a long one would land in the fixed
  5468. // buffer, which ptr() and size() no longer look at, and be lost.
  5469. if (growable_buffer_.empty() &&
  5470. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5471. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5472. fixed_buffer_used_size_ += size;
  5473. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5474. } else {
  5475. // Unlike the per-character overload, this can be the very first append of
  5476. // the line, so the fixed buffer may hold nothing and carry no terminator
  5477. // yet. assign() takes an explicit length and does not need one.
  5478. if (growable_buffer_.empty()) {
  5479. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5480. }
  5481. growable_buffer_.append(data, size);
  5482. }
  5483. }
  5484. inline mmap::mmap(const char *path) { open(path); }
  5485. inline mmap::~mmap() { close(); }
  5486. inline bool mmap::open(const char *path) {
  5487. close();
  5488. #if defined(_WIN32)
  5489. auto wpath = u8string_to_wstring(path);
  5490. if (wpath.empty()) { return false; }
  5491. hFile_ =
  5492. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5493. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5494. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5495. LARGE_INTEGER size{};
  5496. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5497. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5498. // See:
  5499. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5500. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5501. size_ = static_cast<size_t>(size.QuadPart);
  5502. hMapping_ =
  5503. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5504. // Special treatment for an empty file...
  5505. if (hMapping_ == NULL && size_ == 0) {
  5506. close();
  5507. is_open_empty_file = true;
  5508. return true;
  5509. }
  5510. if (hMapping_ == NULL) {
  5511. close();
  5512. return false;
  5513. }
  5514. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5515. if (addr_ == nullptr) {
  5516. close();
  5517. return false;
  5518. }
  5519. #else
  5520. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5521. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5522. if (fd_ == -1) { return false; }
  5523. // Only a regular file has a size to serve, unlike a directory or a device.
  5524. struct stat sb;
  5525. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5526. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5527. close();
  5528. return false;
  5529. }
  5530. size_ = static_cast<size_t>(sb.st_size);
  5531. #endif
  5532. return true;
  5533. }
  5534. inline bool mmap::is_open() const {
  5535. #if defined(_WIN32)
  5536. return is_open_empty_file ? true : addr_ != nullptr;
  5537. #else
  5538. return fd_ != -1;
  5539. #endif
  5540. }
  5541. inline size_t mmap::size() const { return size_; }
  5542. inline void mmap::close() {
  5543. #if defined(_WIN32)
  5544. if (addr_) {
  5545. ::UnmapViewOfFile(addr_);
  5546. addr_ = nullptr;
  5547. }
  5548. if (hMapping_) {
  5549. ::CloseHandle(hMapping_);
  5550. hMapping_ = NULL;
  5551. }
  5552. if (hFile_ != INVALID_HANDLE_VALUE) {
  5553. ::CloseHandle(hFile_);
  5554. hFile_ = INVALID_HANDLE_VALUE;
  5555. }
  5556. is_open_empty_file = false;
  5557. #else
  5558. if (fd_ != -1) {
  5559. ::close(fd_);
  5560. fd_ = -1;
  5561. }
  5562. #endif
  5563. size_ = 0;
  5564. }
  5565. inline int close_socket(socket_t sock) noexcept {
  5566. #ifdef _WIN32
  5567. return closesocket(sock);
  5568. #else
  5569. return close(sock);
  5570. #endif
  5571. }
  5572. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5573. ssize_t res = 0;
  5574. while (true) {
  5575. res = fn();
  5576. if (res < 0 && errno == EINTR) {
  5577. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5578. continue;
  5579. }
  5580. break;
  5581. }
  5582. return res;
  5583. }
  5584. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5585. if (offset >= size_) { return 0; }
  5586. len = (std::min)(len, size_ - offset);
  5587. #if defined(_WIN32)
  5588. // Windows does not let a mapped file be truncated.
  5589. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5590. return len;
  5591. #else
  5592. auto n = handle_EINTR(
  5593. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5594. return n > 0 ? static_cast<size_t>(n) : 0;
  5595. #endif
  5596. }
  5597. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5598. return handle_EINTR([&]() {
  5599. return recv(sock,
  5600. #ifdef _WIN32
  5601. static_cast<char *>(ptr), static_cast<int>(size),
  5602. #else
  5603. ptr, size,
  5604. #endif
  5605. flags);
  5606. });
  5607. }
  5608. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5609. int flags) {
  5610. return handle_EINTR([&]() {
  5611. return send(sock,
  5612. #ifdef _WIN32
  5613. static_cast<const char *>(ptr), static_cast<int>(size),
  5614. #else
  5615. ptr, size,
  5616. #endif
  5617. flags);
  5618. });
  5619. }
  5620. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5621. #ifdef _WIN32
  5622. return ::WSAPoll(fds, nfds, timeout);
  5623. #else
  5624. return ::poll(fds, nfds, timeout);
  5625. #endif
  5626. }
  5627. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5628. time_t usec) {
  5629. struct pollfd pfd;
  5630. pfd.fd = sock;
  5631. pfd.events = events;
  5632. pfd.revents = 0;
  5633. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5634. // "return immediately", which callers here rely on to probe a socket.
  5635. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5636. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5637. }
  5638. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5639. return select_impl(sock, POLLIN, sec, usec);
  5640. }
  5641. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5642. return select_impl(sock, POLLOUT, sec, usec);
  5643. }
  5644. // The point sec and usec from now, for select_until(). A negative sec never
  5645. // comes, as a negative timeout waits forever in select_impl().
  5646. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5647. time_t usec) {
  5648. if (sec < 0) { return (std::chrono::steady_clock::time_point::max)(); }
  5649. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5650. std::chrono::microseconds(usec);
  5651. }
  5652. // Waits only for the time left until deadline, so that all the waits of one
  5653. // TLS handshake come out of a single timeout.
  5654. inline ssize_t select_until(socket_t sock, short events,
  5655. std::chrono::steady_clock::time_point deadline) {
  5656. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5657. return select_impl(sock, events, -1, 0);
  5658. }
  5659. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5660. deadline - std::chrono::steady_clock::now())
  5661. .count();
  5662. if (left <= 0) { return 0; }
  5663. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5664. static_cast<time_t>(left % 1000000));
  5665. }
  5666. // select_read(), but waits in slices and gives up once interrupted() returns
  5667. // true. A local shutdown() would not wake the wait on Windows.
  5668. inline ssize_t
  5669. select_read_interruptible(socket_t sock, time_t sec, time_t usec,
  5670. const std::function<bool()> &interrupted) {
  5671. if (!interrupted) { return select_read(sock, sec, usec); }
  5672. const auto slice = std::chrono::microseconds(100000);
  5673. auto deadline = deadline_after(sec, usec);
  5674. while (!interrupted()) {
  5675. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5676. deadline - std::chrono::steady_clock::now());
  5677. auto wait =
  5678. (std::max)((std::min)(left, slice), std::chrono::microseconds(0));
  5679. auto ret = select_impl(sock, POLLIN, 0, static_cast<time_t>(wait.count()));
  5680. if (ret != 0 || wait < slice) { return ret; }
  5681. }
  5682. return 0;
  5683. }
  5684. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5685. time_t usec) {
  5686. struct pollfd pfd_read;
  5687. pfd_read.fd = sock;
  5688. pfd_read.events = POLLIN | POLLOUT;
  5689. pfd_read.revents = 0;
  5690. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5691. auto poll_res =
  5692. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5693. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5694. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5695. auto error = 0;
  5696. socklen_t len = sizeof(error);
  5697. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5698. reinterpret_cast<char *>(&error), &len);
  5699. auto successful = res >= 0 && !error;
  5700. return successful ? Error::Success : Error::Connection;
  5701. }
  5702. return Error::Connection;
  5703. }
  5704. inline bool is_socket_alive(socket_t sock) {
  5705. const auto val = detail::select_read(sock, 0, 0);
  5706. if (val == 0) {
  5707. return true;
  5708. } else if (val < 0 && errno == EBADF) {
  5709. return false;
  5710. }
  5711. char buf[1];
  5712. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5713. }
  5714. class SocketStream final : public Stream {
  5715. public:
  5716. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5717. time_t write_timeout_sec, time_t write_timeout_usec,
  5718. time_t max_timeout_msec = 0,
  5719. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5720. (std::chrono::steady_clock::time_point::min)());
  5721. ~SocketStream() override;
  5722. bool is_readable() const override;
  5723. bool wait_readable() const override;
  5724. bool wait_writable() const override;
  5725. bool is_peer_alive() const override;
  5726. ssize_t read(char *ptr, size_t size) override;
  5727. ssize_t write(const char *ptr, size_t size) override;
  5728. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5729. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5730. socket_t socket() const override;
  5731. time_t duration() const override;
  5732. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5733. void set_max_timeout(time_t msec) override;
  5734. void set_read_interrupt(std::function<bool()> interrupted) override;
  5735. const char *buffered_data(size_t &size) const override;
  5736. void consume_buffered(size_t size) override;
  5737. // The caller has just seen this socket become readable. Lets the next read
  5738. // skip its own readiness wait, which would otherwise ask the kernel a
  5739. // question that was answered a moment ago. Consumed by that read.
  5740. void set_readable_hint() { readable_hint_ = true; }
  5741. private:
  5742. bool ensure_readable();
  5743. socket_t sock_;
  5744. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5745. // thread while a read is in flight -- that is the point of it, for a caller
  5746. // holding one connection and wanting control back to send on it.
  5747. std::atomic<time_t> read_timeout_sec_;
  5748. std::atomic<time_t> read_timeout_usec_;
  5749. time_t write_timeout_sec_;
  5750. time_t write_timeout_usec_;
  5751. time_t max_timeout_msec_;
  5752. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5753. std::function<bool()> read_interrupted_;
  5754. std::vector<char> read_buff_;
  5755. size_t read_buff_off_ = 0;
  5756. size_t read_buff_content_size_ = 0;
  5757. bool readable_hint_ = false;
  5758. static const size_t read_buff_size_ = 1024l * 4;
  5759. };
  5760. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5761. time_t keep_alive_timeout_sec) {
  5762. using namespace std::chrono;
  5763. const auto interval_usec =
  5764. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5765. // Avoid expensive `steady_clock::now()` call for the first time
  5766. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5767. const auto start = steady_clock::now() - microseconds{interval_usec};
  5768. const auto timeout = seconds{keep_alive_timeout_sec};
  5769. while (true) {
  5770. if (svr_sock == INVALID_SOCKET) {
  5771. break; // Server socket is closed
  5772. }
  5773. auto val = select_read(sock, 0, interval_usec);
  5774. if (val < 0) {
  5775. break; // Ssocket error
  5776. } else if (val == 0) {
  5777. if (steady_clock::now() - start > timeout) {
  5778. break; // Timeout
  5779. }
  5780. } else {
  5781. return true; // Ready for read
  5782. }
  5783. }
  5784. return false;
  5785. }
  5786. // `has_buffered_request` reports whether the connection's stream already holds
  5787. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5788. // 9.3.2), so reading one request can pull the start of the next one into the
  5789. // stream's buffer; that request must be served without waiting for the socket
  5790. // to become readable again, since its bytes are no longer on the socket.
  5791. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5792. template <typename P, typename T>
  5793. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5794. socket_t sock,
  5795. size_t keep_alive_max_count,
  5796. time_t keep_alive_timeout_sec,
  5797. P has_buffered_request, T callback) {
  5798. auto ret = false;
  5799. // A keep_alive_max_count of 0 sets no limit.
  5800. for (size_t served = 0;
  5801. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5802. auto socket_readable = false;
  5803. if (!has_buffered_request()) {
  5804. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5805. socket_readable = true;
  5806. }
  5807. auto close_connection = served + 1 == keep_alive_max_count;
  5808. auto connection_closed = false;
  5809. ret = callback(socket_readable, close_connection, connection_closed);
  5810. if (!ret || connection_closed) { break; }
  5811. }
  5812. return ret;
  5813. }
  5814. template <typename T>
  5815. inline bool
  5816. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5817. size_t keep_alive_max_count,
  5818. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5819. time_t read_timeout_usec, time_t write_timeout_sec,
  5820. time_t write_timeout_usec, T callback) {
  5821. // One stream per connection: its read buffer can already hold the start of
  5822. // the next, pipelined request.
  5823. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5824. write_timeout_sec, write_timeout_usec);
  5825. return process_server_socket_core(
  5826. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5827. [&]() { return strm.is_readable(); },
  5828. [&](bool socket_readable, bool close_connection,
  5829. bool &connection_closed) {
  5830. if (socket_readable) { strm.set_readable_hint(); }
  5831. return callback(strm, close_connection, connection_closed);
  5832. });
  5833. }
  5834. inline bool process_client_socket(
  5835. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5836. time_t write_timeout_sec, time_t write_timeout_usec,
  5837. time_t max_timeout_msec,
  5838. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5839. std::function<bool(Stream &)> callback) {
  5840. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5841. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5842. start_time);
  5843. return callback(strm);
  5844. }
  5845. inline int shutdown_socket(socket_t sock) noexcept {
  5846. #ifdef _WIN32
  5847. return shutdown(sock, SD_BOTH);
  5848. #else
  5849. return shutdown(sock, SHUT_RDWR);
  5850. #endif
  5851. }
  5852. // Half-closes the write side and drains any in-flight/queued bytes before
  5853. // the final shutdown+close. Closing with unread data in the receive queue
  5854. // (or bytes arriving after the receive side is closed) makes the stack send
  5855. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5856. // response as a failed read even though it was fully written.
  5857. inline void drain_and_close_socket(socket_t sock) noexcept {
  5858. #ifdef _WIN32
  5859. shutdown(sock, SD_SEND);
  5860. #else
  5861. shutdown(sock, SHUT_WR);
  5862. #endif
  5863. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5864. size_t total = 0;
  5865. const auto deadline = std::chrono::steady_clock::now() +
  5866. std::chrono::milliseconds(100); // bound #1
  5867. while (total < size_t(1024u * 1024u)) { // bound #2
  5868. const auto remaining =
  5869. std::chrono::duration_cast<std::chrono::microseconds>(
  5870. deadline - std::chrono::steady_clock::now())
  5871. .count();
  5872. if (remaining <= 0) { break; }
  5873. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5874. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5875. if (n <= 0) { break; }
  5876. total += static_cast<size_t>(n);
  5877. }
  5878. shutdown_socket(sock);
  5879. close_socket(sock);
  5880. }
  5881. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5882. if (s.size() > 1 && s[0] == '\0') {
  5883. auto ret = s;
  5884. ret[0] = '@';
  5885. return ret;
  5886. }
  5887. return s;
  5888. }
  5889. inline std::string
  5890. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5891. if (s.size() > 1 && s[0] == '@') {
  5892. auto ret = s;
  5893. ret[0] = '\0';
  5894. return ret;
  5895. }
  5896. return s;
  5897. }
  5898. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5899. const struct addrinfo *hints,
  5900. struct addrinfo **res, time_t timeout_sec) {
  5901. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5902. if (timeout_sec <= 0) {
  5903. // No timeout specified, use standard getaddrinfo
  5904. return getaddrinfo(node, service, hints, res);
  5905. }
  5906. #ifdef _WIN32
  5907. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5908. OVERLAPPED overlapped = {};
  5909. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5910. if (!event) { return EAI_FAIL; }
  5911. overlapped.hEvent = event;
  5912. PADDRINFOEXW result_addrinfo = nullptr;
  5913. HANDLE cancel_handle = nullptr;
  5914. ADDRINFOEXW hints_ex = {};
  5915. if (hints) {
  5916. hints_ex.ai_flags = hints->ai_flags;
  5917. hints_ex.ai_family = hints->ai_family;
  5918. hints_ex.ai_socktype = hints->ai_socktype;
  5919. hints_ex.ai_protocol = hints->ai_protocol;
  5920. }
  5921. auto wnode = u8string_to_wstring(node);
  5922. auto wservice = u8string_to_wstring(service);
  5923. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5924. hints ? &hints_ex : nullptr, &result_addrinfo,
  5925. nullptr, &overlapped, nullptr, &cancel_handle);
  5926. if (ret == WSA_IO_PENDING) {
  5927. auto wait_result =
  5928. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5929. if (wait_result == WAIT_TIMEOUT) {
  5930. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5931. ::CloseHandle(event);
  5932. return EAI_AGAIN;
  5933. }
  5934. DWORD bytes_returned;
  5935. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5936. &bytes_returned, FALSE)) {
  5937. ::CloseHandle(event);
  5938. return ::WSAGetLastError();
  5939. }
  5940. }
  5941. ::CloseHandle(event);
  5942. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5943. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5944. return 0;
  5945. }
  5946. return ret;
  5947. #elif TARGET_OS_MAC && defined(__clang__)
  5948. if (!node) { return EAI_NONAME; }
  5949. // macOS implementation using CFHost API for asynchronous DNS resolution
  5950. CFStringRef hostname_ref = CFStringCreateWithCString(
  5951. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5952. if (!hostname_ref) { return EAI_MEMORY; }
  5953. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5954. CFRelease(hostname_ref);
  5955. if (!host_ref) { return EAI_MEMORY; }
  5956. // Set up context for callback
  5957. struct CFHostContext {
  5958. bool completed = false;
  5959. bool success = false;
  5960. CFArrayRef addresses = nullptr;
  5961. std::mutex mutex;
  5962. std::condition_variable cv;
  5963. } context;
  5964. CFHostClientContext client_context;
  5965. memset(&client_context, 0, sizeof(client_context));
  5966. client_context.info = &context;
  5967. // Set callback
  5968. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5969. const CFStreamError *error, void *info) {
  5970. auto ctx = static_cast<CFHostContext *>(info);
  5971. std::lock_guard<std::mutex> lock(ctx->mutex);
  5972. if (error && error->error != 0) {
  5973. ctx->success = false;
  5974. } else {
  5975. Boolean hasBeenResolved;
  5976. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5977. if (ctx->addresses && hasBeenResolved) {
  5978. CFRetain(ctx->addresses);
  5979. ctx->success = true;
  5980. } else {
  5981. ctx->success = false;
  5982. }
  5983. }
  5984. ctx->completed = true;
  5985. ctx->cv.notify_one();
  5986. };
  5987. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5988. CFRelease(host_ref);
  5989. return EAI_SYSTEM;
  5990. }
  5991. // Schedule on run loop
  5992. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5993. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5994. // Start resolution
  5995. CFStreamError stream_error;
  5996. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5997. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5998. CFRelease(host_ref);
  5999. return EAI_FAIL;
  6000. }
  6001. // Wait for completion with timeout
  6002. auto timeout_time =
  6003. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  6004. bool timed_out = false;
  6005. {
  6006. std::unique_lock<std::mutex> lock(context.mutex);
  6007. while (!context.completed) {
  6008. auto now = std::chrono::steady_clock::now();
  6009. if (now >= timeout_time) {
  6010. timed_out = true;
  6011. break;
  6012. }
  6013. // Run the runloop for a short time
  6014. lock.unlock();
  6015. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  6016. lock.lock();
  6017. }
  6018. }
  6019. // Clean up
  6020. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6021. CFHostSetClient(host_ref, nullptr, nullptr);
  6022. if (timed_out || !context.completed) {
  6023. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  6024. CFRelease(host_ref);
  6025. return EAI_AGAIN;
  6026. }
  6027. if (!context.success || !context.addresses) {
  6028. CFRelease(host_ref);
  6029. return EAI_NODATA;
  6030. }
  6031. // Convert CFArray to addrinfo
  6032. CFIndex count = CFArrayGetCount(context.addresses);
  6033. if (count == 0) {
  6034. CFRelease(context.addresses);
  6035. CFRelease(host_ref);
  6036. return EAI_NODATA;
  6037. }
  6038. struct addrinfo *result_addrinfo = nullptr;
  6039. struct addrinfo **current = &result_addrinfo;
  6040. for (CFIndex i = 0; i < count; i++) {
  6041. CFDataRef addr_data =
  6042. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6043. if (!addr_data) continue;
  6044. const struct sockaddr *sockaddr_ptr =
  6045. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6046. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6047. // Allocate addrinfo structure
  6048. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6049. if (!*current) {
  6050. freeaddrinfo(result_addrinfo);
  6051. CFRelease(context.addresses);
  6052. CFRelease(host_ref);
  6053. return EAI_MEMORY;
  6054. }
  6055. memset(*current, 0, sizeof(struct addrinfo));
  6056. // Set up addrinfo fields
  6057. (*current)->ai_family = sockaddr_ptr->sa_family;
  6058. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6059. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6060. (*current)->ai_addrlen = sockaddr_len;
  6061. // Copy sockaddr
  6062. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6063. if (!(*current)->ai_addr) {
  6064. freeaddrinfo(result_addrinfo);
  6065. CFRelease(context.addresses);
  6066. CFRelease(host_ref);
  6067. return EAI_MEMORY;
  6068. }
  6069. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6070. // Set port if service is specified
  6071. if (service && *service) {
  6072. int port = 0;
  6073. if (parse_port(service, strlen(service), port)) {
  6074. if (sockaddr_ptr->sa_family == AF_INET) {
  6075. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6076. ->sin_port = htons(static_cast<uint16_t>(port));
  6077. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6078. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6079. ->sin6_port = htons(static_cast<uint16_t>(port));
  6080. }
  6081. }
  6082. }
  6083. current = &((*current)->ai_next);
  6084. }
  6085. CFRelease(context.addresses);
  6086. CFRelease(host_ref);
  6087. *res = result_addrinfo;
  6088. return 0;
  6089. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6090. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6091. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6092. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6093. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6094. // the resolver worker still references the stack-local gaicb. The cancel
  6095. // path therefore waits (gai_suspend with no timeout) for the worker to
  6096. // actually finish before letting the stack frame go. The trade-off is that
  6097. // a wedged DNS server can hold this thread for the system resolver timeout
  6098. // (~30s by default) past the caller's connection timeout.
  6099. struct gaicb request{};
  6100. struct gaicb *requests[1] = {&request};
  6101. struct sigevent sevp{};
  6102. struct timespec timeout{timeout_sec, 0};
  6103. request.ar_name = node;
  6104. request.ar_service = service;
  6105. request.ar_request = hints;
  6106. sevp.sigev_notify = SIGEV_NONE;
  6107. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6108. if (rc != 0) { return rc; }
  6109. auto cleanup = scope_exit([&] {
  6110. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6111. });
  6112. int wait_result = gai_suspend(requests, 1, &timeout);
  6113. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6114. int gai_result = gai_error(&request);
  6115. if (gai_result == 0) {
  6116. *res = request.ar_result;
  6117. request.ar_result = nullptr;
  6118. return 0;
  6119. }
  6120. return gai_result;
  6121. }
  6122. gai_cancel(&request);
  6123. while (gai_error(&request) == EAI_INPROGRESS) {
  6124. gai_suspend(requests, 1, nullptr);
  6125. }
  6126. return wait_result;
  6127. #else
  6128. // Fallback implementation using thread-based timeout for other Unix systems.
  6129. struct GetAddrInfoState {
  6130. ~GetAddrInfoState() {
  6131. if (info) { freeaddrinfo(info); }
  6132. }
  6133. std::mutex mutex;
  6134. std::condition_variable result_cv;
  6135. bool completed = false;
  6136. int result = EAI_SYSTEM;
  6137. std::string node;
  6138. std::string service;
  6139. struct addrinfo hints;
  6140. struct addrinfo *info = nullptr;
  6141. };
  6142. // Allocate on the heap, so the resolver thread can keep using the data.
  6143. auto state = std::make_shared<GetAddrInfoState>();
  6144. if (node) { state->node = node; }
  6145. state->service = service;
  6146. state->hints = *hints;
  6147. std::thread resolve_thread([state]() {
  6148. auto thread_result =
  6149. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6150. &state->info);
  6151. std::lock_guard<std::mutex> lock(state->mutex);
  6152. state->result = thread_result;
  6153. state->completed = true;
  6154. state->result_cv.notify_one();
  6155. });
  6156. // Wait for completion or timeout
  6157. std::unique_lock<std::mutex> lock(state->mutex);
  6158. auto finished =
  6159. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6160. [&] { return state->completed; });
  6161. if (finished) {
  6162. // Operation completed within timeout
  6163. resolve_thread.join();
  6164. *res = state->info;
  6165. state->info = nullptr; // Pass ownership to caller
  6166. return state->result;
  6167. } else {
  6168. // Timeout occurred
  6169. resolve_thread.detach(); // Let the thread finish in background
  6170. return EAI_AGAIN; // Return timeout error
  6171. }
  6172. #endif
  6173. #else
  6174. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6175. return getaddrinfo(node, service, hints, res);
  6176. #endif
  6177. }
  6178. template <typename BindOrConnect>
  6179. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6180. int address_family, int socket_flags, bool tcp_nodelay,
  6181. bool ipv6_v6only, SocketOptions socket_options,
  6182. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6183. // Get address info
  6184. const char *node = nullptr;
  6185. struct addrinfo hints;
  6186. struct addrinfo *result;
  6187. memset(&hints, 0, sizeof(struct addrinfo));
  6188. hints.ai_socktype = SOCK_STREAM;
  6189. hints.ai_protocol = IPPROTO_IP;
  6190. if (!ip.empty()) {
  6191. node = ip.c_str();
  6192. // Ask getaddrinfo to convert IP in c-string to address
  6193. hints.ai_family = AF_UNSPEC;
  6194. hints.ai_flags = AI_NUMERICHOST;
  6195. } else {
  6196. if (!host.empty()) { node = host.c_str(); }
  6197. hints.ai_family = address_family;
  6198. hints.ai_flags = socket_flags;
  6199. }
  6200. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6201. if (hints.ai_family == AF_UNIX) {
  6202. const auto addrlen = host.length();
  6203. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6204. #ifdef SOCK_CLOEXEC
  6205. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6206. hints.ai_protocol);
  6207. #else
  6208. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6209. #endif
  6210. if (sock != INVALID_SOCKET) {
  6211. sockaddr_un addr{};
  6212. addr.sun_family = AF_UNIX;
  6213. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6214. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6215. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6216. hints.ai_addrlen = static_cast<socklen_t>(
  6217. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6218. #ifndef SOCK_CLOEXEC
  6219. #ifndef _WIN32
  6220. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6221. #endif
  6222. #endif
  6223. if (socket_options) { socket_options(sock); }
  6224. #ifdef _WIN32
  6225. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6226. // remove the option.
  6227. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6228. #endif
  6229. bool dummy;
  6230. if (!bind_or_connect(sock, hints, dummy)) {
  6231. close_socket(sock);
  6232. sock = INVALID_SOCKET;
  6233. }
  6234. }
  6235. return sock;
  6236. }
  6237. #endif
  6238. auto service = std::to_string(port);
  6239. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6240. timeout_sec)) {
  6241. #if defined __linux__ && !defined __ANDROID__
  6242. res_init();
  6243. #endif
  6244. return INVALID_SOCKET;
  6245. }
  6246. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6247. for (auto rp = result; rp; rp = rp->ai_next) {
  6248. // Create a socket
  6249. #ifdef _WIN32
  6250. auto sock =
  6251. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6252. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6253. /**
  6254. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6255. * and above the socket creation fails on older Windows Systems.
  6256. *
  6257. * Let's try to create a socket the old way in this case.
  6258. *
  6259. * Reference:
  6260. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6261. *
  6262. * WSA_FLAG_NO_HANDLE_INHERIT:
  6263. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6264. * SP1, and later
  6265. *
  6266. */
  6267. if (sock == INVALID_SOCKET) {
  6268. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6269. }
  6270. #else
  6271. #ifdef SOCK_CLOEXEC
  6272. auto sock =
  6273. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6274. #else
  6275. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6276. #endif
  6277. #endif
  6278. if (sock == INVALID_SOCKET) { continue; }
  6279. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6280. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6281. close_socket(sock);
  6282. continue;
  6283. }
  6284. #endif
  6285. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6286. if (rp->ai_family == AF_INET6) {
  6287. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6288. }
  6289. if (socket_options) { socket_options(sock); }
  6290. // bind or connect
  6291. auto quit = false;
  6292. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6293. close_socket(sock);
  6294. if (quit) { break; }
  6295. }
  6296. return INVALID_SOCKET;
  6297. }
  6298. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6299. #ifdef _WIN32
  6300. auto flags = nonblocking ? 1UL : 0UL;
  6301. ioctlsocket(sock, FIONBIO, &flags);
  6302. #else
  6303. auto flags = fcntl(sock, F_GETFL, 0);
  6304. fcntl(sock, F_SETFL,
  6305. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6306. #endif
  6307. }
  6308. inline bool is_connection_error() {
  6309. #ifdef _WIN32
  6310. return WSAGetLastError() != WSAEWOULDBLOCK;
  6311. #else
  6312. return errno != EINPROGRESS;
  6313. #endif
  6314. }
  6315. // accept() failed because the process or the network stack is temporarily out
  6316. // of resources. The listening socket is still usable, so back off briefly and
  6317. // try again.
  6318. inline bool is_accept_resource_error() {
  6319. #ifdef _WIN32
  6320. auto err = WSAGetLastError();
  6321. return err == WSAEMFILE || err == WSAENOBUFS;
  6322. #else
  6323. auto err = errno;
  6324. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6325. #endif
  6326. }
  6327. // accept() failed for a reason that says nothing about the listening socket:
  6328. // the pending connection went away before it could be accepted, or the call
  6329. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6330. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6331. // connection that way.
  6332. inline bool is_accept_transient_error() {
  6333. #ifdef _WIN32
  6334. auto err = WSAGetLastError();
  6335. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6336. err == WSAECONNABORTED;
  6337. #else
  6338. auto err = errno;
  6339. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6340. err == ECONNABORTED;
  6341. #endif
  6342. }
  6343. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6344. struct addrinfo hints;
  6345. struct addrinfo *result;
  6346. memset(&hints, 0, sizeof(struct addrinfo));
  6347. hints.ai_family = AF_UNSPEC;
  6348. hints.ai_socktype = SOCK_STREAM;
  6349. hints.ai_protocol = 0;
  6350. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6351. return false;
  6352. }
  6353. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6354. auto ret = false;
  6355. for (auto rp = result; rp; rp = rp->ai_next) {
  6356. const auto &ai = *rp;
  6357. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6358. ret = true;
  6359. break;
  6360. }
  6361. }
  6362. return ret;
  6363. }
  6364. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6365. #define USE_IF2IP
  6366. #endif
  6367. #ifdef USE_IF2IP
  6368. inline std::string if2ip(int address_family, const std::string &ifn) {
  6369. struct ifaddrs *ifap;
  6370. getifaddrs(&ifap);
  6371. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6372. std::string addr_candidate;
  6373. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6374. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6375. (AF_UNSPEC == address_family ||
  6376. ifa->ifa_addr->sa_family == address_family)) {
  6377. if (ifa->ifa_addr->sa_family == AF_INET) {
  6378. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6379. char buf[INET_ADDRSTRLEN];
  6380. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6381. return std::string(buf, INET_ADDRSTRLEN);
  6382. }
  6383. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6384. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6385. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6386. char buf[INET6_ADDRSTRLEN] = {};
  6387. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6388. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6389. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6390. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6391. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6392. } else {
  6393. return std::string(buf, INET6_ADDRSTRLEN);
  6394. }
  6395. }
  6396. }
  6397. }
  6398. }
  6399. }
  6400. return addr_candidate;
  6401. }
  6402. #endif
  6403. inline socket_t create_client_socket(
  6404. const std::string &host, const std::string &ip, int port,
  6405. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6406. SocketOptions socket_options, time_t connection_timeout_sec,
  6407. time_t connection_timeout_usec, time_t read_timeout_sec,
  6408. time_t read_timeout_usec, time_t write_timeout_sec,
  6409. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6410. auto sock = create_socket(
  6411. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6412. std::move(socket_options),
  6413. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6414. if (!intf.empty()) {
  6415. #ifdef USE_IF2IP
  6416. auto ip_from_if = if2ip(address_family, intf);
  6417. if (ip_from_if.empty()) { ip_from_if = intf; }
  6418. if (!bind_ip_address(sock2, ip_from_if)) {
  6419. error = Error::BindIPAddress;
  6420. return false;
  6421. }
  6422. #endif
  6423. }
  6424. set_nonblocking(sock2, true);
  6425. auto ret =
  6426. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6427. if (ret < 0) {
  6428. if (is_connection_error()) {
  6429. error = Error::Connection;
  6430. return false;
  6431. }
  6432. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6433. connection_timeout_usec);
  6434. if (error != Error::Success) {
  6435. if (error == Error::ConnectionTimeout) { quit = true; }
  6436. return false;
  6437. }
  6438. }
  6439. set_nonblocking(sock2, false);
  6440. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6441. read_timeout_usec);
  6442. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6443. write_timeout_usec);
  6444. error = Error::Success;
  6445. return true;
  6446. },
  6447. connection_timeout_sec); // Pass DNS timeout
  6448. if (sock != INVALID_SOCKET) {
  6449. error = Error::Success;
  6450. } else {
  6451. if (error == Error::Success) { error = Error::Connection; }
  6452. }
  6453. return sock;
  6454. }
  6455. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6456. socklen_t addr_len, std::string &ip, int &port) {
  6457. if (addr.ss_family == AF_INET) {
  6458. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6459. } else if (addr.ss_family == AF_INET6) {
  6460. port =
  6461. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6462. } else {
  6463. return false;
  6464. }
  6465. std::array<char, NI_MAXHOST> ipstr{};
  6466. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6467. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6468. 0, NI_NUMERICHOST)) {
  6469. return false;
  6470. }
  6471. ip = ipstr.data();
  6472. return true;
  6473. }
  6474. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6475. struct sockaddr_storage addr;
  6476. socklen_t addr_len = sizeof(addr);
  6477. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6478. &addr_len)) {
  6479. get_ip_and_port(addr, addr_len, ip, port);
  6480. }
  6481. }
  6482. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6483. struct sockaddr_storage addr;
  6484. socklen_t addr_len = sizeof(addr);
  6485. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6486. &addr_len)) {
  6487. #ifndef _WIN32
  6488. if (addr.ss_family == AF_UNIX) {
  6489. #if defined(__linux__)
  6490. struct ucred ucred;
  6491. socklen_t len = sizeof(ucred);
  6492. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6493. port = ucred.pid;
  6494. }
  6495. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6496. pid_t pid;
  6497. socklen_t len = sizeof(pid);
  6498. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6499. port = pid;
  6500. }
  6501. #endif
  6502. return;
  6503. }
  6504. #endif
  6505. get_ip_and_port(addr, addr_len, ip, port);
  6506. }
  6507. }
  6508. inline std::string
  6509. find_content_type(const std::string &path,
  6510. const std::map<std::string, std::string> &user_data,
  6511. const std::string &default_content_type) {
  6512. // Extensions are matched regardless of case, as web servers do
  6513. auto ext = case_ignore::to_lower(file_extension(path));
  6514. auto it = user_data.find(ext);
  6515. if (it != user_data.end()) { return it->second; }
  6516. static const struct {
  6517. const char *ext;
  6518. const char *type;
  6519. } types[] = {
  6520. {"css", "text/css"},
  6521. {"csv", "text/csv"},
  6522. {"htm", "text/html"},
  6523. {"html", "text/html"},
  6524. {"js", "text/javascript"},
  6525. {"mjs", "text/javascript"},
  6526. {"txt", "text/plain"},
  6527. {"vtt", "text/vtt"},
  6528. {"apng", "image/apng"},
  6529. {"avif", "image/avif"},
  6530. {"bmp", "image/bmp"},
  6531. {"gif", "image/gif"},
  6532. {"png", "image/png"},
  6533. {"svg", "image/svg+xml"},
  6534. {"webp", "image/webp"},
  6535. {"ico", "image/x-icon"},
  6536. {"tif", "image/tiff"},
  6537. {"tiff", "image/tiff"},
  6538. {"jpg", "image/jpeg"},
  6539. {"jpeg", "image/jpeg"},
  6540. {"mp4", "video/mp4"},
  6541. {"mpeg", "video/mpeg"},
  6542. {"webm", "video/webm"},
  6543. {"mp3", "audio/mp3"},
  6544. {"mpga", "audio/mpeg"},
  6545. {"weba", "audio/webm"},
  6546. {"wav", "audio/wave"},
  6547. {"otf", "font/otf"},
  6548. {"ttf", "font/ttf"},
  6549. {"woff", "font/woff"},
  6550. {"woff2", "font/woff2"},
  6551. {"7z", "application/x-7z-compressed"},
  6552. {"atom", "application/atom+xml"},
  6553. {"pdf", "application/pdf"},
  6554. {"json", "application/json"},
  6555. {"rss", "application/rss+xml"},
  6556. {"tar", "application/x-tar"},
  6557. {"xht", "application/xhtml+xml"},
  6558. {"xhtml", "application/xhtml+xml"},
  6559. {"xslt", "application/xslt+xml"},
  6560. {"xml", "application/xml"},
  6561. {"gz", "application/gzip"},
  6562. {"zip", "application/zip"},
  6563. {"wasm", "application/wasm"},
  6564. };
  6565. for (const auto &t : types) {
  6566. if (ext == t.ext) { return t.type; }
  6567. }
  6568. return default_content_type;
  6569. }
  6570. inline std::string
  6571. extract_media_type(const std::string &content_type,
  6572. std::map<std::string, std::string> *params = nullptr) {
  6573. // Extract type/subtype from Content-Type value (RFC 2045)
  6574. // e.g. "application/json; charset=utf-8" -> "application/json"
  6575. auto media_type = content_type;
  6576. auto semicolon_pos = media_type.find(';');
  6577. if (semicolon_pos != std::string::npos) {
  6578. auto param_str = media_type.substr(semicolon_pos + 1);
  6579. media_type = media_type.substr(0, semicolon_pos);
  6580. if (params) {
  6581. // Parse parameters: key=value pairs separated by ';'
  6582. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6583. [&](const char *b, const char *e) {
  6584. std::string key;
  6585. std::string val;
  6586. divide_param_pair(b, e, key, val);
  6587. // Parameter names are case-insensitive (RFC 9110
  6588. // §5.6.6)
  6589. if (!key.empty()) {
  6590. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6591. unquote_param(val));
  6592. }
  6593. });
  6594. }
  6595. }
  6596. // Trim whitespace from media type
  6597. return trim_copy(media_type);
  6598. }
  6599. inline bool can_compress_content_type(const std::string &content_type) {
  6600. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6601. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6602. static const char *const compressible[] = {
  6603. "image/svg+xml",
  6604. "application/javascript",
  6605. "application/x-javascript",
  6606. "application/json",
  6607. "application/ld+json",
  6608. "application/xml",
  6609. "application/xhtml+xml",
  6610. "application/rss+xml",
  6611. "application/atom+xml",
  6612. "application/xslt+xml",
  6613. "application/protobuf",
  6614. };
  6615. for (auto type : compressible) {
  6616. if (mime_type == type) { return true; }
  6617. }
  6618. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6619. }
  6620. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6621. double &quality) {
  6622. quality = 1.0;
  6623. token.clear();
  6624. // Split on first ';': left = token name, right = parameters
  6625. const char *params_b = nullptr;
  6626. std::size_t params_len = 0;
  6627. divide(
  6628. b, static_cast<std::size_t>(e - b), ';',
  6629. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6630. auto r = trim(lb, lb + llen, 0, llen);
  6631. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6632. params_b = rb;
  6633. params_len = rlen;
  6634. });
  6635. if (token.empty()) { return false; }
  6636. if (params_len == 0) { return true; }
  6637. // Scan parameters for q= (stops on first match)
  6638. bool invalid = false;
  6639. split_find(params_b, params_b + params_len, ';',
  6640. (std::numeric_limits<size_t>::max)(),
  6641. [&](const char *pb, const char *pe) -> bool {
  6642. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6643. auto len = static_cast<size_t>(pe - pb);
  6644. if (len < 2) { return false; }
  6645. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6646. return false;
  6647. }
  6648. // Trim the value portion
  6649. auto r = trim(pb, pe, 2, len);
  6650. if (r.first >= r.second) {
  6651. invalid = true;
  6652. return true;
  6653. }
  6654. double v = 0.0;
  6655. auto res = from_chars(pb + r.first, pb + r.second, v);
  6656. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6657. v < 0.0 || v > 1.0) {
  6658. invalid = true;
  6659. return true;
  6660. }
  6661. quality = v;
  6662. return true;
  6663. });
  6664. return !invalid;
  6665. }
  6666. inline EncodingType encoding_type(const Request &req,
  6667. const std::string &content_type) {
  6668. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6669. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6670. if (s.empty()) { return EncodingType::None; }
  6671. // Single-pass: iterate tokens and track the best supported encoding.
  6672. // Server preference breaks ties (br > gzip > zstd).
  6673. EncodingType best = EncodingType::None;
  6674. double best_q = 0.0; // q=0 means "not acceptable"
  6675. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6676. auto priority = [](EncodingType t) -> int {
  6677. switch (t) {
  6678. case EncodingType::Brotli: return 0;
  6679. case EncodingType::Gzip: return 1;
  6680. case EncodingType::Zstd: return 2;
  6681. default: return 3;
  6682. }
  6683. };
  6684. std::string name;
  6685. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6686. double quality = 1.0;
  6687. if (!parse_quality(b, e, name, quality)) { return; }
  6688. if (quality <= 0.0) { return; }
  6689. EncodingType type = EncodingType::None;
  6690. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6691. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6692. #endif
  6693. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6694. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6695. type = EncodingType::Gzip;
  6696. }
  6697. #endif
  6698. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6699. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6700. type = EncodingType::Zstd;
  6701. }
  6702. #endif
  6703. if (type == EncodingType::None) { return; }
  6704. // Higher q-value wins; for equal q, server preference breaks ties
  6705. if (quality > best_q ||
  6706. (quality == best_q && priority(type) < priority(best))) {
  6707. best_q = quality;
  6708. best = type;
  6709. }
  6710. });
  6711. return best;
  6712. }
  6713. // `content_type` is taken separately because a file-backed response has not
  6714. // been given one yet when its coding has to be decided.
  6715. inline EncodingType encoding_type(const Request &req, const Response &res,
  6716. const std::string &content_type) {
  6717. // The response already names a content coding of its own: a handler serving
  6718. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6719. // point whose headers name the coding its files are stored in. Applying one
  6720. // on top of that would double-encode the body and append a second
  6721. // `Content-Encoding` field line.
  6722. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6723. return encoding_type(req, content_type);
  6724. }
  6725. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6726. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6727. }
  6728. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6729. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6730. if (type == EncodingType::Gzip) {
  6731. return detail::make_unique<gzip_compressor>();
  6732. }
  6733. #endif
  6734. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6735. if (type == EncodingType::Brotli) {
  6736. return detail::make_unique<brotli_compressor>();
  6737. }
  6738. #endif
  6739. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6740. if (type == EncodingType::Zstd) {
  6741. return detail::make_unique<zstd_compressor>();
  6742. }
  6743. #endif
  6744. (void)type;
  6745. return nullptr;
  6746. }
  6747. inline const char *encoding_name(EncodingType type) {
  6748. switch (type) {
  6749. case EncodingType::Gzip: return "gzip";
  6750. case EncodingType::Brotli: return "br";
  6751. case EncodingType::Zstd: return "zstd";
  6752. default: return "";
  6753. }
  6754. }
  6755. inline bool nocompressor::compress(const char *data, size_t data_length,
  6756. bool /*last*/, Callback callback) {
  6757. if (!data_length) { return true; }
  6758. return callback(data, data_length);
  6759. }
  6760. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6761. inline gzip_compressor::gzip_compressor() {
  6762. std::memset(&strm_, 0, sizeof(strm_));
  6763. strm_.zalloc = Z_NULL;
  6764. strm_.zfree = Z_NULL;
  6765. strm_.opaque = Z_NULL;
  6766. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6767. Z_DEFAULT_STRATEGY) == Z_OK;
  6768. }
  6769. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6770. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6771. bool last, Callback callback) {
  6772. assert(is_valid_);
  6773. do {
  6774. constexpr size_t max_avail_in =
  6775. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6776. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6777. (std::min)(data_length, max_avail_in));
  6778. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6779. data_length -= strm_.avail_in;
  6780. data += strm_.avail_in;
  6781. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6782. auto ret = Z_OK;
  6783. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6784. do {
  6785. strm_.avail_out = static_cast<uInt>(buff.size());
  6786. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6787. ret = deflate(&strm_, flush);
  6788. if (ret == Z_STREAM_ERROR) { return false; }
  6789. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6790. return false;
  6791. }
  6792. } while (strm_.avail_out == 0);
  6793. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6794. (flush == Z_NO_FLUSH && ret == Z_OK));
  6795. assert(strm_.avail_in == 0);
  6796. } while (data_length > 0);
  6797. return true;
  6798. }
  6799. inline gzip_decompressor::gzip_decompressor() {
  6800. std::memset(&strm_, 0, sizeof(strm_));
  6801. strm_.zalloc = Z_NULL;
  6802. strm_.zfree = Z_NULL;
  6803. strm_.opaque = Z_NULL;
  6804. // 15 is the value of wbits, which should be at the maximum possible value
  6805. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6806. // that the stream type should be automatically detected either gzip or
  6807. // deflate.
  6808. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6809. }
  6810. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6811. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6812. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6813. Callback callback) {
  6814. assert(is_valid_);
  6815. auto ret = Z_OK;
  6816. do {
  6817. constexpr size_t max_avail_in =
  6818. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6819. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6820. (std::min)(data_length, max_avail_in));
  6821. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6822. data_length -= strm_.avail_in;
  6823. data += strm_.avail_in;
  6824. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6825. while (strm_.avail_in > 0 && ret == Z_OK) {
  6826. strm_.avail_out = static_cast<uInt>(buff.size());
  6827. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6828. ret = inflate(&strm_, Z_NO_FLUSH);
  6829. assert(ret != Z_STREAM_ERROR);
  6830. switch (ret) {
  6831. case Z_NEED_DICT:
  6832. case Z_DATA_ERROR:
  6833. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6834. }
  6835. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6836. return false;
  6837. }
  6838. }
  6839. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6840. } while (data_length > 0);
  6841. return true;
  6842. }
  6843. #endif
  6844. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6845. inline brotli_compressor::brotli_compressor() {
  6846. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6847. }
  6848. inline brotli_compressor::~brotli_compressor() {
  6849. BrotliEncoderDestroyInstance(state_);
  6850. }
  6851. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6852. bool last, Callback callback) {
  6853. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6854. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6855. auto available_in = data_length;
  6856. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6857. for (;;) {
  6858. if (last) {
  6859. if (BrotliEncoderIsFinished(state_)) { break; }
  6860. } else {
  6861. if (!available_in) { break; }
  6862. }
  6863. auto available_out = buff.size();
  6864. auto next_out = buff.data();
  6865. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6866. &available_out, &next_out, nullptr)) {
  6867. return false;
  6868. }
  6869. auto output_bytes = buff.size() - available_out;
  6870. if (output_bytes) {
  6871. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6872. }
  6873. }
  6874. return true;
  6875. }
  6876. inline brotli_decompressor::brotli_decompressor() {
  6877. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6878. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6879. : BROTLI_DECODER_RESULT_ERROR;
  6880. }
  6881. inline brotli_decompressor::~brotli_decompressor() {
  6882. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6883. }
  6884. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6885. inline bool brotli_decompressor::decompress(const char *data,
  6886. size_t data_length,
  6887. Callback callback) {
  6888. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6889. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6890. return 0;
  6891. }
  6892. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6893. size_t avail_in = data_length;
  6894. size_t total_out;
  6895. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6896. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6897. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6898. char *next_out = buff.data();
  6899. size_t avail_out = buff.size();
  6900. decoder_r = BrotliDecoderDecompressStream(
  6901. decoder_s, &avail_in, &next_in, &avail_out,
  6902. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6903. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6904. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6905. }
  6906. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6907. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6908. }
  6909. #endif
  6910. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6911. inline zstd_compressor::zstd_compressor() {
  6912. ctx_ = ZSTD_createCCtx();
  6913. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6914. }
  6915. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6916. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6917. bool last, Callback callback) {
  6918. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6919. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6920. ZSTD_inBuffer input = {data, data_length, 0};
  6921. bool finished;
  6922. do {
  6923. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6924. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6925. if (ZSTD_isError(remaining)) { return false; }
  6926. if (!callback(buff.data(), output.pos)) { return false; }
  6927. finished = last ? (remaining == 0) : (input.pos == input.size);
  6928. } while (!finished);
  6929. return true;
  6930. }
  6931. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6932. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6933. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6934. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6935. Callback callback) {
  6936. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6937. ZSTD_inBuffer input = {data, data_length, 0};
  6938. while (input.pos < input.size) {
  6939. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6940. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6941. if (ZSTD_isError(remaining)) { return false; }
  6942. if (!callback(buff.data(), output.pos)) { return false; }
  6943. }
  6944. return true;
  6945. }
  6946. #endif
  6947. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6948. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6949. // unknown coding, and its payload would be handed back still compressed.
  6950. inline bool is_zlib_encoding(const std::string &encoding) {
  6951. return case_ignore::equal(encoding, "gzip") ||
  6952. case_ignore::equal(encoding, "deflate");
  6953. }
  6954. inline bool is_brotli_encoding(const std::string &encoding) {
  6955. return case_ignore::equal(encoding, "br");
  6956. }
  6957. inline bool is_zstd_encoding(const std::string &encoding) {
  6958. return case_ignore::equal(encoding, "zstd");
  6959. }
  6960. // Returns true if the content coding is one cpp-httplib is able to decompress
  6961. // when the corresponding support is compiled in.
  6962. inline bool is_known_content_encoding(const std::string &encoding) {
  6963. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6964. is_zstd_encoding(encoding);
  6965. }
  6966. inline std::unique_ptr<decompressor>
  6967. create_decompressor(const std::string &encoding) {
  6968. std::unique_ptr<decompressor> decompressor;
  6969. if (is_zlib_encoding(encoding)) {
  6970. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6971. decompressor = detail::make_unique<gzip_decompressor>();
  6972. #endif
  6973. } else if (is_brotli_encoding(encoding)) {
  6974. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6975. decompressor = detail::make_unique<brotli_decompressor>();
  6976. #endif
  6977. } else if (is_zstd_encoding(encoding)) {
  6978. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6979. decompressor = detail::make_unique<zstd_decompressor>();
  6980. #endif
  6981. }
  6982. return decompressor;
  6983. }
  6984. // Returns the best available compressor and its Content-Encoding name.
  6985. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6986. inline std::pair<std::unique_ptr<compressor>, const char *>
  6987. create_compressor() {
  6988. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6989. return {detail::make_unique<brotli_compressor>(), "br"};
  6990. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6991. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6992. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6993. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6994. #else
  6995. return {nullptr, nullptr};
  6996. #endif
  6997. }
  6998. inline bool is_prohibited_header_name(const std::string &name) {
  6999. // Field names are case-insensitive (RFC 9110 §5.1)
  7000. return case_ignore::equal(name, "REMOTE_ADDR") ||
  7001. case_ignore::equal(name, "REMOTE_PORT") ||
  7002. case_ignore::equal(name, "LOCAL_ADDR") ||
  7003. case_ignore::equal(name, "LOCAL_PORT");
  7004. }
  7005. inline bool has_header(const Headers &headers, const std::string &key) {
  7006. if (is_prohibited_header_name(key)) { return false; }
  7007. return headers.find(key) != headers.end();
  7008. }
  7009. inline const char *get_header_value(const Headers &headers,
  7010. const std::string &key, const char *def,
  7011. size_t id) {
  7012. if (is_prohibited_header_name(key)) {
  7013. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  7014. std::string msg = "Prohibited header name '" + key + "' is specified.";
  7015. throw std::invalid_argument(msg);
  7016. #else
  7017. return "";
  7018. #endif
  7019. }
  7020. auto rng = headers.equal_range(key);
  7021. auto it = bounded_next(rng.first, id, rng.second);
  7022. if (it != rng.second) { return it->second.c_str(); }
  7023. return def;
  7024. }
  7025. inline size_t get_header_value_count(const Headers &headers,
  7026. const std::string &key) {
  7027. return headers.count(key);
  7028. }
  7029. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  7030. // list may be sent as several field lines, and the combined field value is
  7031. // those values joined by commas in the order they were received. Callers that
  7032. // parse such a list must work on the combined value; reading only the first
  7033. // occurrence silently drops whatever the later field lines carry.
  7034. inline std::string get_combined_header_value(const Headers &headers,
  7035. const std::string &key) {
  7036. std::string combined;
  7037. auto rng = headers.equal_range(key);
  7038. for (auto it = rng.first; it != rng.second; ++it) {
  7039. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7040. // elements, so an empty field line must not contribute a bare comma to the
  7041. // combined value.
  7042. if (it->second.empty()) { continue; }
  7043. if (!combined.empty()) { combined += ", "; }
  7044. combined += it->second;
  7045. }
  7046. return combined;
  7047. }
  7048. inline bool has_header_token(const Headers &headers, const std::string &key,
  7049. const std::string &token) {
  7050. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7051. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7052. // several lines. Match complete tokens rather than searching the raw value,
  7053. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7054. auto rng = headers.equal_range(key);
  7055. for (auto it = rng.first; it != rng.second; ++it) {
  7056. const auto &value = it->second;
  7057. if (split_find(value.data(), value.data() + value.size(), ',',
  7058. [&](const char *b, const char *e) {
  7059. return case_ignore::equal(std::string(b, e), token);
  7060. })) {
  7061. return true;
  7062. }
  7063. }
  7064. return false;
  7065. }
  7066. template <typename Map>
  7067. inline typename Map::mapped_type
  7068. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7069. auto rng = m.equal_range(key);
  7070. auto it = bounded_next(rng.first, id, rng.second);
  7071. if (it != rng.second) { return it->second; }
  7072. return typename Map::mapped_type();
  7073. }
  7074. inline void set_header(Headers &headers, const std::string &key,
  7075. const std::string &val) {
  7076. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7077. }
  7078. // Drops the fields set_header() would refuse, from headers an application can
  7079. // fill directly: CR/LF in one would split the message.
  7080. inline void erase_invalid_fields(Headers &headers) {
  7081. for (auto it = headers.begin(); it != headers.end();) {
  7082. if (fields::is_field_valid(it->first, it->second)) {
  7083. ++it;
  7084. } else {
  7085. it = headers.erase(it);
  7086. }
  7087. }
  7088. }
  7089. inline bool read_headers(Stream &strm, Headers &headers) {
  7090. const auto bufsiz = 2048;
  7091. char buf[bufsiz];
  7092. stream_line_reader line_reader(strm, buf, bufsiz);
  7093. size_t header_count = 0;
  7094. for (;;) {
  7095. if (!line_reader.getline()) { return false; }
  7096. // Check if the line ends with CRLF.
  7097. auto line_terminator_len = 2;
  7098. if (line_reader.end_with_crlf()) {
  7099. // Blank line indicates end of headers.
  7100. if (line_reader.size() == 2) { break; }
  7101. } else {
  7102. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7103. // Blank line indicates end of headers.
  7104. if (line_reader.size() == 1) { break; }
  7105. line_terminator_len = 1;
  7106. #else
  7107. continue; // Skip invalid line.
  7108. #endif
  7109. }
  7110. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7111. // Check header count limit
  7112. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7113. // Exclude line terminator
  7114. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7115. if (!parse_header(line_reader.ptr(), end,
  7116. [&](const std::string &key, const std::string &val) {
  7117. headers.emplace(key, val);
  7118. })) {
  7119. return false;
  7120. }
  7121. header_count++;
  7122. }
  7123. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7124. // headers that have different values to prevent request smuggling.
  7125. auto cl_range = headers.equal_range("Content-Length");
  7126. if (cl_range.first != cl_range.second) {
  7127. const auto &first_val = cl_range.first->second;
  7128. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7129. if (it->second != first_val) { return false; }
  7130. }
  7131. }
  7132. return true;
  7133. }
  7134. // Parsed by hand: std::regex_match recurses once per character of the reason
  7135. // phrase, which a server can make as long as a whole line.
  7136. inline bool parse_status_line(const char *line, std::string &version,
  7137. int &status, std::string &reason) {
  7138. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7139. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7140. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7141. !is_ascii_digit(line[11])) {
  7142. return false;
  7143. }
  7144. auto p = line + 12;
  7145. auto reason_begin = p;
  7146. if (*p == ' ') {
  7147. reason_begin = ++p;
  7148. p += std::strcspn(p, "\r\n");
  7149. }
  7150. auto reason_end = p;
  7151. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7152. if (*p == '\r') { p++; }
  7153. #else
  7154. if (*p++ != '\r') { return false; }
  7155. #endif
  7156. if (*p++ != '\n' || *p != '\0') { return false; }
  7157. version.assign(line, 8);
  7158. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7159. reason.assign(reason_begin, reason_end);
  7160. return true;
  7161. }
  7162. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7163. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7164. struct WebSocketUpgradeResponse {
  7165. Error error = Error::Success;
  7166. int status = -1;
  7167. Headers headers;
  7168. std::string selected_subprotocol;
  7169. };
  7170. // Reads a response's status line and headers, leaving any body unread. An
  7171. // unparsable status line is no stream error; it just leaves `status` as is.
  7172. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7173. const auto bufsiz = 2048;
  7174. char buf[bufsiz];
  7175. stream_line_reader line_reader(strm, buf, bufsiz);
  7176. if (!line_reader.getline()) { return false; }
  7177. std::string version;
  7178. std::string reason;
  7179. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7180. return true;
  7181. }
  7182. return read_headers(strm, headers);
  7183. }
  7184. inline bool
  7185. read_websocket_upgrade_response(Stream &strm,
  7186. const std::string &expected_accept,
  7187. const std::string &offered_subprotocols,
  7188. WebSocketUpgradeResponse &upgrade) {
  7189. // The headers of a rejection are kept so the caller can see why the server
  7190. // refused the upgrade.
  7191. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7192. upgrade.error = Error::Read;
  7193. return false;
  7194. }
  7195. const auto &headers = upgrade.headers;
  7196. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7197. upgrade.error = Error::WebSocketHandshake;
  7198. return false;
  7199. }
  7200. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7201. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7202. upgrade.error = Error::WebSocketHandshake;
  7203. return false;
  7204. }
  7205. // Verify Connection: Upgrade
  7206. if (!has_header_token(headers, "Connection", "upgrade")) {
  7207. upgrade.error = Error::WebSocketHandshake;
  7208. return false;
  7209. }
  7210. // Verify Sec-WebSocket-Accept header value
  7211. auto it = headers.find("Sec-WebSocket-Accept");
  7212. if (it == headers.end() || it->second != expected_accept) {
  7213. upgrade.error = Error::WebSocketHandshake;
  7214. return false;
  7215. }
  7216. // Extract negotiated subprotocol
  7217. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7218. if (proto_it != headers.end()) {
  7219. upgrade.selected_subprotocol = proto_it->second;
  7220. }
  7221. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7222. if (!upgrade.selected_subprotocol.empty()) {
  7223. auto was_offered = false;
  7224. split(offered_subprotocols.data(),
  7225. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7226. [&](const char *b, const char *e) {
  7227. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7228. was_offered = true;
  7229. }
  7230. });
  7231. if (!was_offered) {
  7232. upgrade.error = Error::WebSocketHandshake;
  7233. return false;
  7234. }
  7235. }
  7236. return true;
  7237. }
  7238. enum class ReadContentResult {
  7239. Success, // Successfully read the content
  7240. PayloadTooLarge, // The content exceeds the specified payload limit
  7241. Error // An error occurred while reading the content
  7242. };
  7243. inline ReadContentResult read_content_with_length(
  7244. Stream &strm, size_t len, DownloadProgress progress,
  7245. ContentReceiverWithProgress out,
  7246. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7247. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7248. detail::BodyReader br;
  7249. br.stream = &strm;
  7250. br.has_content_length = true;
  7251. br.content_length = len;
  7252. br.payload_max_length = payload_max_length;
  7253. br.chunked = false;
  7254. br.bytes_read = 0;
  7255. br.last_error = Error::Success;
  7256. size_t r = 0;
  7257. while (r < len) {
  7258. auto read_len = static_cast<size_t>(len - r);
  7259. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7260. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7261. if (n <= 0) {
  7262. // Check if it was a payload size error
  7263. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7264. return ReadContentResult::PayloadTooLarge;
  7265. }
  7266. return ReadContentResult::Error;
  7267. }
  7268. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7269. return ReadContentResult::Error;
  7270. }
  7271. r += static_cast<size_t>(n);
  7272. if (progress) {
  7273. if (!progress(r, len)) { return ReadContentResult::Error; }
  7274. }
  7275. }
  7276. return ReadContentResult::Success;
  7277. }
  7278. inline ReadContentResult
  7279. read_content_without_length(Stream &strm, size_t payload_max_length,
  7280. ContentReceiverWithProgress out) {
  7281. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7282. size_t r = 0;
  7283. for (;;) {
  7284. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7285. if (n == 0) { return ReadContentResult::Success; }
  7286. if (n < 0) { return ReadContentResult::Error; }
  7287. // Check if adding this data would exceed the payload limit
  7288. if (payload_max_length > 0 &&
  7289. (r > payload_max_length ||
  7290. payload_max_length - r < static_cast<size_t>(n))) {
  7291. return ReadContentResult::PayloadTooLarge;
  7292. }
  7293. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7294. return ReadContentResult::Error;
  7295. }
  7296. r += static_cast<size_t>(n);
  7297. }
  7298. return ReadContentResult::Success;
  7299. }
  7300. template <typename T>
  7301. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7302. size_t payload_max_length,
  7303. ContentReceiverWithProgress out) {
  7304. detail::ChunkedDecoder dec(strm);
  7305. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7306. size_t total_len = 0;
  7307. for (;;) {
  7308. size_t chunk_offset = 0;
  7309. size_t chunk_total = 0;
  7310. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7311. if (n < 0) { return ReadContentResult::Error; }
  7312. if (n == 0) {
  7313. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7314. return ReadContentResult::Error;
  7315. }
  7316. return ReadContentResult::Success;
  7317. }
  7318. if (payload_max_length > 0 &&
  7319. (total_len > payload_max_length ||
  7320. payload_max_length - total_len < static_cast<size_t>(n))) {
  7321. return ReadContentResult::PayloadTooLarge;
  7322. }
  7323. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7324. return ReadContentResult::Error;
  7325. }
  7326. total_len += static_cast<size_t>(n);
  7327. }
  7328. }
  7329. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7330. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7331. // is the final transfer coding. A single field value may list several
  7332. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7333. // several Transfer-Encoding lines, which combine into one comma-separated
  7334. // list in the order the lines were received. Headers preserves that order,
  7335. // so the final coding is the last token of the last line. Match it
  7336. // case-insensitively rather than comparing the whole value against
  7337. // "chunked".
  7338. //
  7339. // Security: reading a chunked message as unframed leaves its body in the
  7340. // socket, where a keep-alive connection parses it as a smuggled request.
  7341. // Server::process_request() answers 400 and closes when the final coding is
  7342. // not chunked, so a request whose framing cannot be determined never
  7343. // reaches the "no body" path.
  7344. auto rng = headers.equal_range("Transfer-Encoding");
  7345. if (rng.first == rng.second) { return false; }
  7346. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7347. // combined list ending in nothing rather than inheriting the line before it.
  7348. std::string last_coding;
  7349. for (auto it = rng.first; it != rng.second; ++it) {
  7350. const auto &value = it->second;
  7351. last_coding.clear();
  7352. split(value.data(), value.data() + value.size(), ',',
  7353. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7354. }
  7355. return case_ignore::equal(last_coding, "chunked");
  7356. }
  7357. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7358. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7359. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7360. return msg.has_header("Transfer-Encoding") &&
  7361. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7362. }
  7363. inline bool has_conflicting_content_length(const Headers &headers) {
  7364. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7365. // Content-Length is framed ambiguously. The body readers here delimit it by
  7366. // the transfer coding and drop Content-Length, while an intermediary may do
  7367. // the reverse, so the two disagree on where the body ends and a reused
  7368. // connection is desynchronised (request/response smuggling). Content-Length:
  7369. // 0 is tolerated for compatibility with existing peers.
  7370. return has_header(headers, "Transfer-Encoding") &&
  7371. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7372. }
  7373. template <typename T, typename U>
  7374. bool prepare_content_receiver(T &x, int &status,
  7375. ContentReceiverWithProgress receiver,
  7376. bool decompress, size_t payload_max_length,
  7377. bool &exceed_payload_max_length, U callback) {
  7378. if (decompress) {
  7379. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7380. std::unique_ptr<decompressor> decompressor;
  7381. if (!encoding.empty()) {
  7382. // A coding we know about but were not built with is an error. An
  7383. // unrecognized coding (including "identity") is left alone and the
  7384. // payload is passed through as-is, since some servers misuse the header,
  7385. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7386. decompressor = detail::create_decompressor(encoding);
  7387. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7388. status = StatusCode::UnsupportedMediaType_415;
  7389. return false;
  7390. }
  7391. }
  7392. if (decompressor) {
  7393. if (decompressor->is_valid()) {
  7394. size_t decompressed_size = 0;
  7395. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7396. size_t off, size_t len) {
  7397. return decompressor->decompress(
  7398. buf, n, [&](const char *buf2, size_t n2) {
  7399. // Guard against zip-bomb: check
  7400. // decompressed size against limit.
  7401. if (payload_max_length > 0 &&
  7402. (decompressed_size >= payload_max_length ||
  7403. n2 > payload_max_length - decompressed_size)) {
  7404. exceed_payload_max_length = true;
  7405. return false;
  7406. }
  7407. decompressed_size += n2;
  7408. return receiver(buf2, n2, off, len);
  7409. });
  7410. };
  7411. return callback(std::move(out));
  7412. } else {
  7413. status = StatusCode::InternalServerError_500;
  7414. return false;
  7415. }
  7416. }
  7417. }
  7418. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7419. size_t len) {
  7420. return receiver(buf, n, off, len);
  7421. };
  7422. return callback(std::move(out));
  7423. }
  7424. template <typename T>
  7425. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7426. DownloadProgress progress,
  7427. ContentReceiverWithProgress receiver, bool decompress) {
  7428. bool exceed_payload_max_length = false;
  7429. return prepare_content_receiver(
  7430. x, status, std::move(receiver), decompress, payload_max_length,
  7431. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7432. auto ret = true;
  7433. // Note: exceed_payload_max_length may also be set by the decompressor
  7434. // wrapper in prepare_content_receiver when the decompressed payload
  7435. // size exceeds the limit.
  7436. if (is_chunked_transfer_encoding(x.headers)) {
  7437. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7438. if (result == ReadContentResult::Success) {
  7439. ret = true;
  7440. } else if (result == ReadContentResult::PayloadTooLarge) {
  7441. exceed_payload_max_length = true;
  7442. ret = false;
  7443. } else {
  7444. ret = false;
  7445. }
  7446. } else if (!has_header(x.headers, "Content-Length")) {
  7447. auto result =
  7448. read_content_without_length(strm, payload_max_length, out);
  7449. if (result == ReadContentResult::Success) {
  7450. ret = true;
  7451. } else if (result == ReadContentResult::PayloadTooLarge) {
  7452. exceed_payload_max_length = true;
  7453. ret = false;
  7454. } else {
  7455. ret = false;
  7456. }
  7457. } else {
  7458. auto is_invalid_value = false;
  7459. auto len = get_header_value_u64(x.headers, "Content-Length",
  7460. (std::numeric_limits<size_t>::max)(),
  7461. 0, is_invalid_value);
  7462. if (is_invalid_value) {
  7463. ret = false;
  7464. } else if (len > 0) {
  7465. auto result = read_content_with_length(
  7466. strm, len, std::move(progress), out, payload_max_length);
  7467. ret = (result == ReadContentResult::Success);
  7468. if (result == ReadContentResult::PayloadTooLarge) {
  7469. exceed_payload_max_length = true;
  7470. }
  7471. }
  7472. }
  7473. if (!ret) {
  7474. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7475. : StatusCode::BadRequest_400;
  7476. }
  7477. return ret;
  7478. });
  7479. }
  7480. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7481. const std::string &path) {
  7482. // Neither the method nor the request target may carry CR/LF, SP or other
  7483. // control octets; otherwise a value smuggled into either splits the request
  7484. // line and injects headers or a whole request.
  7485. if (!fields::is_token(method)) { return -1; }
  7486. if (!fields::is_request_target(path)) { return -1; }
  7487. std::string s = method;
  7488. s += ' ';
  7489. s += path;
  7490. s += " HTTP/1.1\r\n";
  7491. return strm.write(s.data(), s.size());
  7492. }
  7493. inline ssize_t write_response_line(Stream &strm, int status) {
  7494. std::string s = "HTTP/1.1 ";
  7495. s += std::to_string(status);
  7496. s += ' ';
  7497. s += httplib::status_message(status);
  7498. s += "\r\n";
  7499. return strm.write(s.data(), s.size());
  7500. }
  7501. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7502. ssize_t write_len = 0;
  7503. for (const auto &x : headers) {
  7504. std::string s;
  7505. s = x.first;
  7506. s += ": ";
  7507. s += x.second;
  7508. s += "\r\n";
  7509. auto len = strm.write(s.data(), s.size());
  7510. if (len < 0) { return len; }
  7511. write_len += len;
  7512. }
  7513. auto len = strm.write("\r\n");
  7514. if (len < 0) { return len; }
  7515. write_len += len;
  7516. return write_len;
  7517. }
  7518. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7519. size_t offset = 0;
  7520. while (offset < l) {
  7521. auto length = strm.write(d + offset, l - offset);
  7522. if (length < 0) { return false; }
  7523. offset += static_cast<size_t>(length);
  7524. }
  7525. return true;
  7526. }
  7527. template <typename T>
  7528. inline bool write_content_with_progress(Stream &strm,
  7529. const ContentProvider &content_provider,
  7530. size_t offset, size_t length,
  7531. T is_shutting_down,
  7532. const UploadProgress &upload_progress,
  7533. Error &error) {
  7534. size_t end_offset = offset + length;
  7535. size_t start_offset = offset;
  7536. auto ok = true;
  7537. auto finished = false;
  7538. DataSink data_sink;
  7539. data_sink.write = [&](const char *d, size_t l) -> bool {
  7540. if (ok) {
  7541. // Bytes past `length` would follow the framed body, where the peer reads
  7542. // them as the next message. Write only what fits and fail the rest.
  7543. if (l > end_offset - offset) {
  7544. l = end_offset - offset;
  7545. ok = false;
  7546. }
  7547. if (write_data(strm, d, l)) {
  7548. offset += l;
  7549. if (upload_progress && length > 0) {
  7550. size_t current_written = offset - start_offset;
  7551. if (!upload_progress(current_written, length)) {
  7552. ok = false;
  7553. return false;
  7554. }
  7555. }
  7556. } else {
  7557. ok = false;
  7558. }
  7559. }
  7560. return ok;
  7561. };
  7562. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7563. // The body is framed by `length`, so a provider that reports itself done
  7564. // early has truncated it. Record that and let the short-body check below
  7565. // fail the write, rather than calling the provider again forever.
  7566. data_sink.done = [&]() { finished = true; };
  7567. while (offset < end_offset && !finished && !is_shutting_down()) {
  7568. auto last_offset = offset;
  7569. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7570. error = Error::Write;
  7571. return false;
  7572. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7573. error = Error::Canceled;
  7574. return false;
  7575. } else if (!ok) {
  7576. error = Error::Write;
  7577. return false;
  7578. }
  7579. // A provider that reports success without writing anything and without
  7580. // reporting itself done gets handed the same offset and length again on
  7581. // the next pass, so it would spin here for as long as the peer stays
  7582. // connected. Treat making no progress as a short body, like done() early.
  7583. if (!finished && offset == last_offset) {
  7584. error = Error::Write;
  7585. return false;
  7586. }
  7587. }
  7588. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7589. error = Error::Write;
  7590. return false;
  7591. }
  7592. error = Error::Success;
  7593. return true;
  7594. }
  7595. template <typename T>
  7596. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7597. size_t offset, size_t length, T is_shutting_down,
  7598. Error &error) {
  7599. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7600. is_shutting_down, nullptr, error);
  7601. }
  7602. template <typename T>
  7603. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7604. size_t offset, size_t length,
  7605. const T &is_shutting_down) {
  7606. auto error = Error::Success;
  7607. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7608. error);
  7609. }
  7610. template <typename T>
  7611. inline bool
  7612. write_content_without_length(Stream &strm,
  7613. const ContentProvider &content_provider,
  7614. const T &is_shutting_down) {
  7615. size_t offset = 0;
  7616. auto data_available = true;
  7617. auto ok = true;
  7618. DataSink data_sink;
  7619. data_sink.write = [&](const char *d, size_t l) -> bool {
  7620. if (ok) {
  7621. offset += l;
  7622. if (!write_data(strm, d, l)) { ok = false; }
  7623. }
  7624. return ok;
  7625. };
  7626. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7627. data_sink.done = [&](void) { data_available = false; };
  7628. while (data_available && !is_shutting_down()) {
  7629. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7630. return false;
  7631. } else if (!content_provider(offset, 0, data_sink)) {
  7632. return false;
  7633. } else if (!ok) {
  7634. return false;
  7635. }
  7636. }
  7637. return !data_available; // true only if done() was called, false if shutting
  7638. // down
  7639. }
  7640. // Runs a known-length content provider to completion and compresses what it
  7641. // writes into `out`, chunk by chunk, without holding the identity form.
  7642. inline bool compress_content_provider(const ContentProvider &content_provider,
  7643. size_t length, compressor &cmp,
  7644. std::string &out) {
  7645. size_t offset = 0;
  7646. auto ok = true;
  7647. auto finished = false;
  7648. DataSink data_sink;
  7649. auto append = [&](const char *data, size_t data_len) {
  7650. out.append(data, data_len);
  7651. return true;
  7652. };
  7653. data_sink.write = [&](const char *d, size_t l) -> bool {
  7654. if (!ok) { return false; }
  7655. offset += l;
  7656. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7657. return ok;
  7658. };
  7659. // The body is framed by `length`, so a provider that reports itself done
  7660. // early has truncated it; the short-body check below turns that into a
  7661. // failure rather than calling the provider again forever.
  7662. data_sink.done = [&]() { finished = true; };
  7663. while (offset < length && !finished) {
  7664. auto prev_offset = offset;
  7665. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7666. return false;
  7667. }
  7668. // No Stream to block on here, so a provider that keeps returning true
  7669. // without writing would spin. Treat a pass that made no progress as a
  7670. // failure.
  7671. if (offset == prev_offset) { return false; }
  7672. }
  7673. if (offset != length) { return false; }
  7674. return cmp.compress(nullptr, 0, true, append);
  7675. }
  7676. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7677. // and the file flag, so recording them has to come after; keeping all of it
  7678. // here means a third file-serving path cannot get that order wrong.
  7679. inline void set_file_content_provider(Response &res,
  7680. const std::shared_ptr<mmap> &m,
  7681. const std::string &content_type,
  7682. EncodingType encoding) {
  7683. // One read and one write move up to this much of the file at a time.
  7684. auto buf = std::make_shared<std::vector<char>>(
  7685. (std::min)(m->size(), size_t(256 * 1024)));
  7686. res.set_content_provider(
  7687. m->size(), content_type,
  7688. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7689. // Never read past the file, which ends the response early if it has
  7690. // shrunk since it was opened.
  7691. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7692. if (n == 0) { return false; }
  7693. sink.write(buf->data(), n);
  7694. return true;
  7695. });
  7696. res.is_file_content_provider_ = true;
  7697. res.content_coding_ = encoding;
  7698. }
  7699. template <typename T, typename U>
  7700. inline bool
  7701. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7702. const T &is_shutting_down, U &compressor, Error &error) {
  7703. size_t offset = 0;
  7704. auto data_available = true;
  7705. auto ok = true;
  7706. DataSink data_sink;
  7707. data_sink.write = [&](const char *d, size_t l) -> bool {
  7708. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7709. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7710. // zero-length chunk is the terminator, so it must not be emitted here.
  7711. if (ok && l > 0) {
  7712. offset += l;
  7713. std::string payload;
  7714. if (compressor.compress(d, l, false,
  7715. [&](const char *data, size_t data_len) {
  7716. payload.append(data, data_len);
  7717. return true;
  7718. })) {
  7719. if (!payload.empty()) {
  7720. // Emit chunked response header and footer for each chunk
  7721. auto chunk =
  7722. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7723. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7724. }
  7725. } else {
  7726. ok = false;
  7727. }
  7728. }
  7729. return ok;
  7730. };
  7731. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7732. auto done_with_trailer = [&](const Headers *trailer) {
  7733. if (!ok) { return; }
  7734. data_available = false;
  7735. std::string payload;
  7736. if (!compressor.compress(nullptr, 0, true,
  7737. [&](const char *data, size_t data_len) {
  7738. payload.append(data, data_len);
  7739. return true;
  7740. })) {
  7741. ok = false;
  7742. return;
  7743. }
  7744. if (!payload.empty()) {
  7745. // Emit chunked response header and footer for each chunk
  7746. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7747. if (!write_data(strm, chunk.data(), chunk.size())) {
  7748. ok = false;
  7749. return;
  7750. }
  7751. }
  7752. constexpr const char done_marker[] = "0\r\n";
  7753. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7754. // Trailer
  7755. if (trailer) {
  7756. for (const auto &kv : *trailer) {
  7757. // Skip fields with invalid names or values to prevent response
  7758. // splitting via CR/LF injection, matching set_header().
  7759. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7760. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7761. if (!write_data(strm, field_line.data(), field_line.size())) {
  7762. ok = false;
  7763. }
  7764. }
  7765. }
  7766. constexpr const char crlf[] = "\r\n";
  7767. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7768. };
  7769. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7770. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7771. done_with_trailer(&trailer);
  7772. };
  7773. while (data_available && !is_shutting_down()) {
  7774. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7775. error = Error::Write;
  7776. return false;
  7777. } else if (!content_provider(offset, 0, data_sink)) {
  7778. error = Error::Canceled;
  7779. return false;
  7780. } else if (!ok) {
  7781. error = Error::Write;
  7782. return false;
  7783. }
  7784. }
  7785. if (data_available) { // exited due to is_shutting_down(), not done()
  7786. error = Error::Write;
  7787. return false;
  7788. }
  7789. error = Error::Success;
  7790. return true;
  7791. }
  7792. template <typename T, typename U>
  7793. inline bool write_content_chunked(Stream &strm,
  7794. const ContentProvider &content_provider,
  7795. const T &is_shutting_down, U &compressor) {
  7796. auto error = Error::Success;
  7797. return write_content_chunked(strm, content_provider, is_shutting_down,
  7798. compressor, error);
  7799. }
  7800. template <typename T>
  7801. inline bool redirect(T &cli, Request &req, Response &res,
  7802. const std::string &path, const std::string &location,
  7803. Error &error) {
  7804. Request new_req = req;
  7805. new_req.path = path;
  7806. new_req.redirect_count_ -= 1;
  7807. if (res.status == StatusCode::SeeOther_303 &&
  7808. (req.method != "GET" && req.method != "HEAD")) {
  7809. new_req.method = "GET";
  7810. new_req.body.clear();
  7811. new_req.headers.clear();
  7812. new_req.content_length_ = 0;
  7813. new_req.content_provider_ = nullptr;
  7814. new_req.is_chunked_content_provider_ = false;
  7815. }
  7816. Response new_res;
  7817. auto ret = cli.send(new_req, new_res, error);
  7818. if (ret) {
  7819. req = std::move(new_req);
  7820. res = std::move(new_res);
  7821. if (res.location.empty()) { res.location = location; }
  7822. }
  7823. return ret;
  7824. }
  7825. inline std::string params_to_query_str(const Params &params) {
  7826. std::string query;
  7827. for (auto it = params.begin(); it != params.end(); ++it) {
  7828. if (it != params.begin()) { query += '&'; }
  7829. query += encode_query_component(it->first);
  7830. query += '=';
  7831. query += encode_query_component(it->second);
  7832. }
  7833. return query;
  7834. }
  7835. // Splits one "key=value" span of a query string at its first '='. A span with
  7836. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7837. // "?flag" keeps its name.
  7838. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7839. std::string &val) {
  7840. divide(b, static_cast<std::size_t>(e - b), '=',
  7841. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7842. std::size_t rhs_size) {
  7843. key.assign(lhs_data, lhs_size);
  7844. val.assign(rhs_data, rhs_size);
  7845. });
  7846. }
  7847. inline void parse_query_text(const char *data, std::size_t size,
  7848. Params &params) {
  7849. std::set<std::string> cache;
  7850. split(data, data + size, '&', [&](const char *b, const char *e) {
  7851. std::string kv(b, e);
  7852. if (cache.find(kv) != cache.end()) { return; }
  7853. cache.insert(std::move(kv));
  7854. std::string key;
  7855. std::string val;
  7856. divide_query_pair(b, e, key, val);
  7857. if (!key.empty()) {
  7858. params.emplace(decode_query_component(key), decode_query_component(val));
  7859. }
  7860. });
  7861. }
  7862. inline void parse_query_text(const std::string &s, Params &params) {
  7863. parse_query_text(s.data(), s.size(), params);
  7864. }
  7865. // Normalize a query string by decoding and re-encoding each key/value pair
  7866. // while preserving the original parameter order. This avoids double-encoding
  7867. // and ensures consistent encoding. It works on the raw string rather than
  7868. // parsing into Params and re-serializing, because that round trip cannot
  7869. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7870. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7871. // duplicated pairs.
  7872. inline std::string normalize_query_string(const std::string &query) {
  7873. std::string result;
  7874. split(query.data(), query.data() + query.size(), '&',
  7875. [&](const char *b, const char *e) {
  7876. std::string key;
  7877. std::string val;
  7878. divide_query_pair(b, e, key, val);
  7879. if (!key.empty()) {
  7880. auto dec_key = decode_query_component(key);
  7881. auto dec_val = decode_query_component(val);
  7882. if (!result.empty()) { result += '&'; }
  7883. result += encode_query_component(dec_key);
  7884. if (!val.empty() || std::find(b, e, '=') != e) {
  7885. result += '=';
  7886. result += encode_query_component(dec_val);
  7887. }
  7888. }
  7889. });
  7890. return result;
  7891. }
  7892. // The query of a client's path: what follows '?', up to the fragment.
  7893. inline std::string query_of(const std::string &path) {
  7894. auto fragment_pos = path.find('#');
  7895. auto query_pos = path.find('?');
  7896. return query_pos < fragment_pos
  7897. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  7898. : std::string();
  7899. }
  7900. // Build the request target that goes on the wire from a caller-supplied path.
  7901. // Shared by the buffered send path and the streaming API so that both put the
  7902. // same bytes in the request line for the same input.
  7903. inline std::string encode_request_target(const std::string &uri,
  7904. bool path_encode) {
  7905. // The fragment stays with the client (RFC 9110 §7.1).
  7906. auto target = uri.substr(0, uri.find('#'));
  7907. // `substr(0, npos)` yields the whole string, which is what the no-query
  7908. // case needs.
  7909. auto query_pos = target.find('?');
  7910. auto path_part = target.substr(0, query_pos);
  7911. std::string query_part;
  7912. if (query_pos != std::string::npos) {
  7913. query_part = target.substr(query_pos + 1);
  7914. }
  7915. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7916. if (!query_part.empty()) {
  7917. // When path encoding is disabled the caller has supplied an already-encoded
  7918. // target and expects the exact bytes to be sent on the wire, so skip
  7919. // normalization for the query too. Normalizing would decode-then-re-encode
  7920. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7921. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7922. if (path_encode) {
  7923. auto normalized = normalize_query_string(query_part);
  7924. if (!normalized.empty()) {
  7925. result += '?';
  7926. result += normalized;
  7927. }
  7928. } else {
  7929. result += '?';
  7930. result += query_part;
  7931. }
  7932. }
  7933. return result;
  7934. }
  7935. inline bool parse_multipart_boundary(const std::string &content_type,
  7936. std::string &boundary) {
  7937. std::map<std::string, std::string> params;
  7938. extract_media_type(content_type, &params);
  7939. auto it = params.find("boundary");
  7940. if (it == params.end()) { return false; }
  7941. boundary = it->second;
  7942. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7943. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7944. // bytes costs a nearly full comparison at nearly every position: the
  7945. // boundary's length multiplies the worst-case cost of scanning a body.
  7946. return !boundary.empty() && boundary.size() <= 70;
  7947. }
  7948. inline void parse_disposition_params(const std::string &s, Params &params) {
  7949. std::set<std::string> cache;
  7950. split_unquoted(
  7951. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  7952. std::string kv(b, e);
  7953. if (cache.find(kv) != cache.end()) { return; }
  7954. cache.insert(kv);
  7955. std::string key;
  7956. std::string val;
  7957. divide_param_pair(b, e, key, val);
  7958. if (!key.empty()) {
  7959. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  7960. }
  7961. });
  7962. }
  7963. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7964. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7965. #else
  7966. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7967. #endif
  7968. auto is_valid = [](const std::string &str) {
  7969. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7970. };
  7971. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7972. const auto pos = static_cast<size_t>(6);
  7973. const auto len = static_cast<size_t>(s.size() - 6);
  7974. auto all_valid_ranges = true;
  7975. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7976. if (!all_valid_ranges) { return; }
  7977. const auto it = std::find(b, e, '-');
  7978. if (it == e) {
  7979. all_valid_ranges = false;
  7980. return;
  7981. }
  7982. const auto lhs = std::string(b, it);
  7983. const auto rhs = std::string(it + 1, e);
  7984. if (!is_valid(lhs) || !is_valid(rhs)) {
  7985. all_valid_ranges = false;
  7986. return;
  7987. }
  7988. ssize_t first = -1;
  7989. if (!lhs.empty()) {
  7990. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7991. // would turn the range into a suffix range.
  7992. auto res =
  7993. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7994. if (res.ec != std::errc{}) {
  7995. all_valid_ranges = false;
  7996. return;
  7997. }
  7998. }
  7999. ssize_t last = -1;
  8000. if (!rhs.empty()) {
  8001. // An overflowing last-byte-pos is past any content length, so keeping
  8002. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  8003. ssize_t v;
  8004. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  8005. if (res.ec == std::errc{}) { last = v; }
  8006. }
  8007. if ((first == -1 && last == -1) ||
  8008. (first != -1 && last != -1 && first > last)) {
  8009. all_valid_ranges = false;
  8010. return;
  8011. }
  8012. ranges.emplace_back(first, last);
  8013. });
  8014. return all_valid_ranges && !ranges.empty();
  8015. }
  8016. return false;
  8017. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8018. }
  8019. #else
  8020. } catch (...) { return false; }
  8021. #endif
  8022. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  8023. inline std::string remove_quoted_strings(const std::string &s) {
  8024. std::string out;
  8025. auto in_quotes = false;
  8026. for (size_t i = 0; i < s.size(); i++) {
  8027. if (s[i] == '"') {
  8028. in_quotes = !in_quotes;
  8029. } else if (!in_quotes) {
  8030. out += s[i];
  8031. } else if (s[i] == '\\') {
  8032. i++;
  8033. }
  8034. }
  8035. return out;
  8036. }
  8037. inline bool parse_accept_header(const std::string &s,
  8038. std::vector<std::string> &content_types) {
  8039. // Parameter values are not used here, so a quoted-string is dropped rather
  8040. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8041. if (s.find('"') != std::string::npos) {
  8042. return parse_accept_header(remove_quoted_strings(s), content_types);
  8043. }
  8044. content_types.clear();
  8045. // Empty string is considered valid (no preference)
  8046. if (s.empty()) { return true; }
  8047. struct AcceptEntry {
  8048. std::string media_type;
  8049. double quality;
  8050. int order;
  8051. };
  8052. std::vector<AcceptEntry> entries;
  8053. int order = 0;
  8054. bool has_invalid_entry = false;
  8055. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8056. // has to parse and ignore empty list elements, so a leading, trailing or
  8057. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8058. // split() skips them, and the header length limit bounds how many a sender
  8059. // can send, so ignoring all of them cannot be used as a denial-of-service
  8060. // vector.
  8061. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8062. std::string entry(b, e);
  8063. entry = trim_copy(entry);
  8064. AcceptEntry accept_entry;
  8065. accept_entry.order = order++;
  8066. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8067. accept_entry.media_type, accept_entry.quality)) {
  8068. has_invalid_entry = true;
  8069. return;
  8070. }
  8071. // Remove additional parameters from media type
  8072. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8073. // Basic validation of media type format
  8074. if (accept_entry.media_type.empty()) {
  8075. has_invalid_entry = true;
  8076. return;
  8077. }
  8078. // Check for basic media type format (should contain '/' or be '*')
  8079. if (accept_entry.media_type != "*" &&
  8080. accept_entry.media_type.find('/') == std::string::npos) {
  8081. has_invalid_entry = true;
  8082. return;
  8083. }
  8084. entries.push_back(std::move(accept_entry));
  8085. });
  8086. // Return false if any invalid entry was found
  8087. if (has_invalid_entry) { return false; }
  8088. // Sort by quality (descending), then by original order (ascending)
  8089. std::sort(entries.begin(), entries.end(),
  8090. [](const AcceptEntry &a, const AcceptEntry &b) {
  8091. if (a.quality != b.quality) {
  8092. return a.quality > b.quality; // Higher quality first
  8093. }
  8094. return a.order < b.order; // Earlier order first for same quality
  8095. });
  8096. // Extract sorted media types
  8097. content_types.reserve(entries.size());
  8098. for (auto &entry : entries) {
  8099. content_types.push_back(std::move(entry.media_type));
  8100. }
  8101. return true;
  8102. }
  8103. class FormDataParser {
  8104. public:
  8105. FormDataParser() = default;
  8106. void set_boundary(std::string &&boundary) {
  8107. boundary_ = std::move(boundary);
  8108. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8109. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8110. }
  8111. bool is_valid() const { return is_valid_; }
  8112. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8113. const ContentReceiver &content_callback) {
  8114. // Once the close delimiter has been seen the rest of the body is epilogue
  8115. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8116. // spread across reads is not copied in only to be erased right away.
  8117. if (state_ == 5) { return true; }
  8118. buf_append(buf, n);
  8119. while (buf_size() > 0) {
  8120. switch (state_) {
  8121. case 0: { // Initial boundary
  8122. auto pos = buf_find(dash_boundary_crlf_);
  8123. if (pos == buf_size()) {
  8124. // Not found yet: keep only a possible partial boundary at the tail so
  8125. // that a body which never contains the boundary cannot grow the
  8126. // buffer (and get rescanned from the start) without bound.
  8127. auto keep = dash_boundary_crlf_.size() - 1;
  8128. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8129. return true;
  8130. }
  8131. buf_erase(pos + dash_boundary_crlf_.size());
  8132. state_ = 1;
  8133. break;
  8134. }
  8135. case 1: { // New entry
  8136. clear_file_info();
  8137. header_searched_ = 0;
  8138. state_ = 2;
  8139. break;
  8140. }
  8141. case 2: { // Headers
  8142. // Resume where the last call stopped looking, so that a line arriving
  8143. // a few bytes at a time is not searched from its start each time.
  8144. auto pos = buf_find(crlf_, header_searched_);
  8145. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8146. while (pos < buf_size()) {
  8147. // Empty line
  8148. if (pos == 0) {
  8149. if (!header_callback(file_)) {
  8150. is_valid_ = false;
  8151. return false;
  8152. }
  8153. buf_erase(crlf_.size());
  8154. state_ = 3;
  8155. break;
  8156. }
  8157. // Check header count limit
  8158. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8159. is_valid_ = false;
  8160. return false;
  8161. }
  8162. header_count_++;
  8163. const auto header = buf_head(pos);
  8164. if (!parse_header(header.data(), header.data() + header.size(),
  8165. [&](const std::string &, const std::string &) {})) {
  8166. is_valid_ = false;
  8167. return false;
  8168. }
  8169. // Parse and emplace space trimmed headers into a map
  8170. if (!parse_header(
  8171. header.data(), header.data() + header.size(),
  8172. [&](const std::string &key, const std::string &val) {
  8173. file_.headers.emplace(key, val);
  8174. })) {
  8175. is_valid_ = false;
  8176. return false;
  8177. }
  8178. constexpr const char header_content_type[] = "Content-Type:";
  8179. if (start_with_case_ignore(header, header_content_type)) {
  8180. file_.content_type =
  8181. trim_copy(header.substr(str_len(header_content_type)));
  8182. } else {
  8183. std::string disposition_params;
  8184. if (parse_content_disposition(header, disposition_params)) {
  8185. Params params;
  8186. parse_disposition_params(disposition_params, params);
  8187. auto it = params.find("name");
  8188. if (it != params.end()) {
  8189. file_.name = it->second;
  8190. } else {
  8191. is_valid_ = false;
  8192. return false;
  8193. }
  8194. it = params.find("filename");
  8195. if (it != params.end()) { file_.filename = it->second; }
  8196. it = params.find("filename*");
  8197. if (it != params.end()) {
  8198. // RFC 5987: only UTF-8 encoding is allowed
  8199. const auto &val = it->second;
  8200. constexpr const char utf8_prefix[] = "UTF-8''";
  8201. constexpr size_t prefix_len = str_len(utf8_prefix);
  8202. if (val.size() > prefix_len &&
  8203. start_with_case_ignore(val, utf8_prefix)) {
  8204. file_.filename = decode_path_component(
  8205. val.substr(prefix_len)); // override...
  8206. } else {
  8207. is_valid_ = false;
  8208. return false;
  8209. }
  8210. }
  8211. }
  8212. }
  8213. buf_erase(pos + crlf_.size());
  8214. pos = buf_find(crlf_);
  8215. }
  8216. if (state_ != 3) {
  8217. // The CR of the CRLF may be the last byte so far.
  8218. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8219. return true;
  8220. }
  8221. break;
  8222. }
  8223. case 3: { // Body
  8224. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8225. auto pos = buf_find(crlf_dash_boundary_);
  8226. if (pos < buf_size()) {
  8227. if (!content_callback(buf_data(), pos)) {
  8228. is_valid_ = false;
  8229. return false;
  8230. }
  8231. buf_erase(pos + crlf_dash_boundary_.size());
  8232. state_ = 4;
  8233. } else {
  8234. auto len = buf_size() - crlf_dash_boundary_.size();
  8235. if (len > 0) {
  8236. if (!content_callback(buf_data(), len)) {
  8237. is_valid_ = false;
  8238. return false;
  8239. }
  8240. buf_erase(len);
  8241. }
  8242. return true;
  8243. }
  8244. break;
  8245. }
  8246. case 4: { // Boundary
  8247. if (crlf_.size() > buf_size()) { return true; }
  8248. if (buf_start_with(crlf_)) {
  8249. buf_erase(crlf_.size());
  8250. state_ = 1;
  8251. } else if (buf_start_with(dash_)) {
  8252. buf_erase(dash_.size());
  8253. is_valid_ = true;
  8254. state_ = 5;
  8255. } else {
  8256. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8257. // accepted after a boundary; RFC 2046 allows transport-padding in
  8258. // between, but this parser has never supported it. Either way the
  8259. // body is already destined to be rejected, so fail now instead of
  8260. // buffering the rest of it. Both are two bytes, so the check above
  8261. // already guarantees enough buffered data to decide.
  8262. is_valid_ = false;
  8263. return false;
  8264. }
  8265. break;
  8266. }
  8267. case 5: { // Epilogue
  8268. buf_erase(buf_size());
  8269. break;
  8270. }
  8271. }
  8272. }
  8273. return true;
  8274. }
  8275. private:
  8276. void clear_file_info() {
  8277. file_.name.clear();
  8278. file_.filename.clear();
  8279. file_.content_type.clear();
  8280. file_.headers.clear();
  8281. header_count_ = 0;
  8282. }
  8283. bool start_with_case_ignore(const std::string &a, const char *b,
  8284. size_t offset = 0) const {
  8285. const auto b_len = strlen(b);
  8286. if (a.size() < offset + b_len) { return false; }
  8287. for (size_t i = 0; i < b_len; i++) {
  8288. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8289. return false;
  8290. }
  8291. }
  8292. return true;
  8293. }
  8294. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8295. // Returns true if header matches, with the params portion in `params_out`.
  8296. bool parse_content_disposition(const std::string &header,
  8297. std::string &params_out) const {
  8298. constexpr const char prefix[] = "Content-Disposition:";
  8299. constexpr size_t prefix_len = str_len(prefix);
  8300. if (!start_with_case_ignore(header, prefix)) { return false; }
  8301. // Skip whitespace after "Content-Disposition:"
  8302. auto pos = prefix_len;
  8303. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8304. pos++;
  8305. }
  8306. // Match "form-data;" (case-insensitive)
  8307. constexpr const char form_data[] = "form-data;";
  8308. constexpr size_t form_data_len = str_len(form_data);
  8309. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8310. pos += form_data_len;
  8311. // Skip whitespace after "form-data;"
  8312. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8313. pos++;
  8314. }
  8315. params_out = header.substr(pos);
  8316. return true;
  8317. }
  8318. const std::string dash_ = "--";
  8319. const std::string crlf_ = "\r\n";
  8320. std::string boundary_;
  8321. std::string dash_boundary_crlf_;
  8322. std::string crlf_dash_boundary_;
  8323. size_t state_ = 0;
  8324. bool is_valid_ = false;
  8325. FormData file_;
  8326. size_t header_count_ = 0;
  8327. size_t header_searched_ = 0;
  8328. // Buffer
  8329. bool start_with(const std::string &a, size_t spos, size_t epos,
  8330. const std::string &b) const {
  8331. if (epos - spos < b.size()) { return false; }
  8332. for (size_t i = 0; i < b.size(); i++) {
  8333. if (a[i + spos] != b[i]) { return false; }
  8334. }
  8335. return true;
  8336. }
  8337. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8338. const char *buf_data() const { return &buf_[buf_spos_]; }
  8339. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8340. bool buf_start_with(const std::string &s) const {
  8341. return start_with(buf_, buf_spos_, buf_epos_, s);
  8342. }
  8343. size_t buf_find(const std::string &s, size_t from = 0) const {
  8344. auto c = s.front();
  8345. size_t off = buf_spos_ + from;
  8346. while (off < buf_epos_) {
  8347. auto pos = off;
  8348. while (true) {
  8349. if (pos == buf_epos_) { return buf_size(); }
  8350. if (buf_[pos] == c) { break; }
  8351. pos++;
  8352. }
  8353. auto remaining_size = buf_epos_ - pos;
  8354. if (s.size() > remaining_size) { return buf_size(); }
  8355. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8356. off = pos + 1;
  8357. }
  8358. return buf_size();
  8359. }
  8360. void buf_append(const char *data, size_t n) {
  8361. auto remaining_size = buf_size();
  8362. if (remaining_size > 0 && buf_spos_ > 0) {
  8363. for (size_t i = 0; i < remaining_size; i++) {
  8364. buf_[i] = buf_[buf_spos_ + i];
  8365. }
  8366. }
  8367. buf_spos_ = 0;
  8368. buf_epos_ = remaining_size;
  8369. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8370. for (size_t i = 0; i < n; i++) {
  8371. buf_[buf_epos_ + i] = data[i];
  8372. }
  8373. buf_epos_ += n;
  8374. }
  8375. void buf_erase(size_t size) { buf_spos_ += size; }
  8376. std::string buf_;
  8377. size_t buf_spos_ = 0;
  8378. size_t buf_epos_ = 0;
  8379. };
  8380. inline std::string random_string(size_t length) {
  8381. constexpr const char data[] =
  8382. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8383. std::string result(length, '\0');
  8384. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8385. for (auto &c : result) {
  8386. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8387. }
  8388. return result;
  8389. }
  8390. inline std::string make_multipart_data_boundary() {
  8391. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8392. }
  8393. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8394. auto valid = true;
  8395. for (size_t i = 0; i < boundary.size(); i++) {
  8396. auto c = boundary[i];
  8397. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8398. valid = false;
  8399. break;
  8400. }
  8401. }
  8402. return valid;
  8403. }
  8404. // Escape a multipart field name/filename following the WHATWG HTML standard
  8405. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8406. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8407. // With quoted = false, only CR and LF are escaped; this is for header values
  8408. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8409. inline std::string escape_multipart_field(const std::string &s,
  8410. bool quoted = true) {
  8411. std::string result;
  8412. result.reserve(s.size());
  8413. for (auto c : s) {
  8414. switch (c) {
  8415. case '"':
  8416. if (quoted) {
  8417. result += "%22";
  8418. } else {
  8419. result += c;
  8420. }
  8421. break;
  8422. case '\\':
  8423. // A lone backslash would escape the character after it (RFC 9110
  8424. // 5.6.4).
  8425. if (quoted) { result += '\\'; }
  8426. result += c;
  8427. break;
  8428. case '\r': result += "%0D"; break;
  8429. case '\n': result += "%0A"; break;
  8430. default: result += c; break;
  8431. }
  8432. }
  8433. return result;
  8434. }
  8435. template <typename T>
  8436. inline std::string
  8437. serialize_multipart_formdata_item_begin(const T &item,
  8438. const std::string &boundary) {
  8439. std::string body = "--" + boundary + "\r\n";
  8440. body += "Content-Disposition: form-data; name=\"" +
  8441. escape_multipart_field(item.name) + "\"";
  8442. if (!item.filename.empty()) {
  8443. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8444. }
  8445. body += "\r\n";
  8446. if (!item.content_type.empty()) {
  8447. body +=
  8448. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8449. "\r\n";
  8450. }
  8451. body += "\r\n";
  8452. return body;
  8453. }
  8454. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8455. inline std::string
  8456. serialize_multipart_formdata_finish(const std::string &boundary) {
  8457. return "--" + boundary + "--\r\n";
  8458. }
  8459. inline std::string
  8460. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8461. return "multipart/form-data; boundary=" + boundary;
  8462. }
  8463. inline std::string
  8464. serialize_multipart_formdata(const UploadFormDataItems &items,
  8465. const std::string &boundary, bool finish = true) {
  8466. std::string body;
  8467. for (const auto &item : items) {
  8468. body += serialize_multipart_formdata_item_begin(item, boundary);
  8469. body += item.content + serialize_multipart_formdata_item_end();
  8470. }
  8471. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8472. return body;
  8473. }
  8474. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8475. const std::string &boundary) {
  8476. size_t total = 0;
  8477. for (const auto &item : items) {
  8478. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8479. total += item.content.size();
  8480. total += serialize_multipart_formdata_item_end().size();
  8481. }
  8482. total += serialize_multipart_formdata_finish(boundary).size();
  8483. return total;
  8484. }
  8485. struct MultipartSegment {
  8486. const char *data;
  8487. size_t size;
  8488. };
  8489. // NOTE: items must outlive the returned ContentProvider
  8490. // (safe for synchronous use inside Post/Put/Patch)
  8491. inline ContentProvider
  8492. make_multipart_content_provider(const UploadFormDataItems &items,
  8493. const std::string &boundary) {
  8494. // Own the per-item header strings and the finish string
  8495. std::vector<std::string> owned;
  8496. owned.reserve(items.size() + 1);
  8497. for (const auto &item : items)
  8498. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8499. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8500. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8501. std::vector<MultipartSegment> segs;
  8502. segs.reserve(items.size() * 3 + 1);
  8503. static const char crlf[] = "\r\n";
  8504. for (size_t i = 0; i < items.size(); i++) {
  8505. segs.push_back({owned[i].data(), owned[i].size()});
  8506. segs.push_back({items[i].content.data(), items[i].content.size()});
  8507. segs.push_back({crlf, 2});
  8508. }
  8509. segs.push_back({owned.back().data(), owned.back().size()});
  8510. struct MultipartState {
  8511. std::vector<std::string> owned;
  8512. std::vector<MultipartSegment> segs;
  8513. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8514. };
  8515. auto state = std::make_shared<MultipartState>();
  8516. state->owned = std::move(owned);
  8517. // `segs` holds raw pointers into owned strings; std::string move preserves
  8518. // the data pointer, so these pointers remain valid after the move above.
  8519. state->segs = std::move(segs);
  8520. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8521. // Buffer multiple small segments into fewer, larger writes to avoid
  8522. // excessive TCP packets when there are many form data items (#2410)
  8523. auto &buf = state->buf;
  8524. auto buf_size = buf.size();
  8525. size_t buf_len = 0;
  8526. size_t remaining = length;
  8527. // Find the first segment containing 'offset'
  8528. size_t pos = 0;
  8529. size_t seg_idx = 0;
  8530. for (; seg_idx < state->segs.size(); seg_idx++) {
  8531. const auto &seg = state->segs[seg_idx];
  8532. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8533. pos += seg.size;
  8534. }
  8535. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8536. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8537. const auto &seg = state->segs[seg_idx];
  8538. size_t available = seg.size - seg_offset;
  8539. size_t to_copy = (std::min)(available, remaining);
  8540. const char *src = seg.data + seg_offset;
  8541. seg_offset = 0; // only the first segment has a non-zero offset
  8542. while (to_copy > 0) {
  8543. size_t space = buf_size - buf_len;
  8544. size_t chunk = (std::min)(to_copy, space);
  8545. std::memcpy(buf.data() + buf_len, src, chunk);
  8546. buf_len += chunk;
  8547. src += chunk;
  8548. to_copy -= chunk;
  8549. remaining -= chunk;
  8550. if (buf_len == buf_size) {
  8551. if (!sink.write(buf.data(), buf_len)) { return false; }
  8552. buf_len = 0;
  8553. }
  8554. }
  8555. }
  8556. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8557. return true;
  8558. };
  8559. }
  8560. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8561. if (ranges.size() <= 1) return;
  8562. // Sort ranges by start position
  8563. std::sort(ranges.begin(), ranges.end(),
  8564. [](const Range &a, const Range &b) { return a.first < b.first; });
  8565. Ranges coalesced;
  8566. coalesced.reserve(ranges.size());
  8567. for (auto &r : ranges) {
  8568. auto first_pos = r.first;
  8569. auto last_pos = r.second;
  8570. // Handle special cases like in range_error
  8571. if (first_pos == -1 && last_pos == -1) {
  8572. first_pos = 0;
  8573. last_pos = static_cast<ssize_t>(content_length);
  8574. }
  8575. if (first_pos == -1) {
  8576. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8577. last_pos = static_cast<ssize_t>(content_length) - 1;
  8578. }
  8579. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8580. last_pos = static_cast<ssize_t>(content_length) - 1;
  8581. }
  8582. // Skip invalid ranges
  8583. if (!(0 <= first_pos && first_pos <= last_pos &&
  8584. last_pos < static_cast<ssize_t>(content_length))) {
  8585. continue;
  8586. }
  8587. // Coalesce with previous range if overlapping or adjacent (but not
  8588. // identical)
  8589. if (!coalesced.empty()) {
  8590. auto &prev = coalesced.back();
  8591. // Check if current range overlaps or is adjacent to previous range
  8592. // but don't coalesce identical ranges (allow duplicates)
  8593. if (first_pos <= prev.second + 1 &&
  8594. !(first_pos == prev.first && last_pos == prev.second)) {
  8595. // Extend the previous range
  8596. prev.second = (std::max)(prev.second, last_pos);
  8597. continue;
  8598. }
  8599. }
  8600. // Add new range
  8601. coalesced.emplace_back(first_pos, last_pos);
  8602. }
  8603. ranges = std::move(coalesced);
  8604. }
  8605. inline bool range_error(Request &req, Response &res) {
  8606. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8607. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8608. req.ranges.clear();
  8609. if (res.status == StatusCode::PartialContent_206) {
  8610. res.status = StatusCode::OK_200;
  8611. }
  8612. return false;
  8613. }
  8614. ssize_t content_len = static_cast<ssize_t>(
  8615. res.content_length_ ? res.content_length_ : res.body.size());
  8616. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8617. size_t overwrapping_count = 0;
  8618. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8619. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8620. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8621. // Too many ranges
  8622. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8623. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8624. return true;
  8625. }
  8626. for (auto &r : req.ranges) {
  8627. auto &first_pos = r.first;
  8628. auto &last_pos = r.second;
  8629. if (first_pos == -1 && last_pos == -1) {
  8630. first_pos = 0;
  8631. last_pos = content_len;
  8632. }
  8633. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8634. // selects the entire representation.
  8635. if (first_pos == -1) {
  8636. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8637. last_pos = content_len - 1;
  8638. }
  8639. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8640. // A client can limit the number of bytes requested without knowing the
  8641. // size of the selected representation. If the last-pos value is absent,
  8642. // or if the value is greater than or equal to the current length of the
  8643. // representation data, the byte range is interpreted as the remainder of
  8644. // the representation (i.e., the server replaces the value of last-pos
  8645. // with a value that is one less than the current length of the selected
  8646. // representation).
  8647. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8648. if (last_pos == -1 || last_pos >= content_len) {
  8649. last_pos = content_len - 1;
  8650. }
  8651. // Range must be within content length
  8652. if (!(0 <= first_pos && first_pos <= last_pos &&
  8653. last_pos <= content_len - 1)) {
  8654. return true;
  8655. }
  8656. // Request must not have more than two overlapping ranges
  8657. for (const auto &processed_range : processed_ranges) {
  8658. if (!(last_pos < processed_range.first ||
  8659. first_pos > processed_range.second)) {
  8660. overwrapping_count++;
  8661. if (overwrapping_count > 2) { return true; }
  8662. break; // Only count once per range
  8663. }
  8664. }
  8665. processed_ranges.emplace_back(first_pos, last_pos);
  8666. }
  8667. // After validation, coalesce overlapping ranges as per RFC 9110
  8668. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8669. }
  8670. return false;
  8671. }
  8672. inline std::pair<size_t, size_t>
  8673. get_range_offset_and_length(Range r, size_t content_length) {
  8674. assert(r.first != -1 && r.second != -1);
  8675. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8676. assert(r.first <= r.second &&
  8677. r.second < static_cast<ssize_t>(content_length));
  8678. (void)(content_length);
  8679. return std::make_pair(static_cast<size_t>(r.first),
  8680. static_cast<size_t>(r.second - r.first) + 1);
  8681. }
  8682. inline std::string make_content_range_header_field(
  8683. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8684. auto st = offset_and_length.first;
  8685. auto ed = st + offset_and_length.second - 1;
  8686. std::string field = "bytes ";
  8687. field += std::to_string(st);
  8688. field += '-';
  8689. field += std::to_string(ed);
  8690. field += '/';
  8691. field += std::to_string(content_length);
  8692. return field;
  8693. }
  8694. template <typename SToken, typename CToken, typename Content>
  8695. bool process_multipart_ranges_data(const Request &req,
  8696. const std::string &boundary,
  8697. const std::string &content_type,
  8698. size_t content_length, SToken stoken,
  8699. CToken ctoken, Content content) {
  8700. for (size_t i = 0; i < req.ranges.size(); i++) {
  8701. ctoken("--");
  8702. stoken(boundary);
  8703. ctoken("\r\n");
  8704. if (!content_type.empty()) {
  8705. ctoken("Content-Type: ");
  8706. stoken(content_type);
  8707. ctoken("\r\n");
  8708. }
  8709. auto offset_and_length =
  8710. get_range_offset_and_length(req.ranges[i], content_length);
  8711. ctoken("Content-Range: ");
  8712. stoken(make_content_range_header_field(offset_and_length, content_length));
  8713. ctoken("\r\n");
  8714. ctoken("\r\n");
  8715. if (!content(offset_and_length.first, offset_and_length.second)) {
  8716. return false;
  8717. }
  8718. ctoken("\r\n");
  8719. }
  8720. ctoken("--");
  8721. stoken(boundary);
  8722. ctoken("--");
  8723. return true;
  8724. }
  8725. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8726. const std::string &boundary,
  8727. const std::string &content_type,
  8728. size_t content_length,
  8729. std::string &data) {
  8730. process_multipart_ranges_data(
  8731. req, boundary, content_type, content_length,
  8732. [&](const std::string &token) { data += token; },
  8733. [&](const std::string &token) { data += token; },
  8734. [&](size_t offset, size_t length) {
  8735. assert(offset + length <= content_length);
  8736. data += res.body.substr(offset, length);
  8737. return true;
  8738. });
  8739. }
  8740. inline size_t get_multipart_ranges_data_length(const Request &req,
  8741. const std::string &boundary,
  8742. const std::string &content_type,
  8743. size_t content_length) {
  8744. size_t data_length = 0;
  8745. process_multipart_ranges_data(
  8746. req, boundary, content_type, content_length,
  8747. [&](const std::string &token) { data_length += token.size(); },
  8748. [&](const std::string &token) { data_length += token.size(); },
  8749. [&](size_t /*offset*/, size_t length) {
  8750. data_length += length;
  8751. return true;
  8752. });
  8753. return data_length;
  8754. }
  8755. template <typename T>
  8756. inline bool
  8757. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8758. const std::string &boundary,
  8759. const std::string &content_type,
  8760. size_t content_length, const T &is_shutting_down) {
  8761. return process_multipart_ranges_data(
  8762. req, boundary, content_type, content_length,
  8763. [&](const std::string &token) { strm.write(token); },
  8764. [&](const std::string &token) { strm.write(token); },
  8765. [&](size_t offset, size_t length) {
  8766. return write_content(strm, res.content_provider_, offset, length,
  8767. is_shutting_down);
  8768. });
  8769. }
  8770. inline bool has_framed_body(const Request &req) {
  8771. return is_chunked_transfer_encoding(req.headers) ||
  8772. req.get_header_value_u64("Content-Length") > 0;
  8773. }
  8774. inline bool expect_content(const Request &req) {
  8775. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8776. req.method == "DELETE") {
  8777. return true;
  8778. }
  8779. return has_framed_body(req);
  8780. }
  8781. #ifdef _WIN32
  8782. class WSInit {
  8783. public:
  8784. WSInit() {
  8785. WSADATA wsaData;
  8786. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8787. }
  8788. ~WSInit() {
  8789. if (is_valid_) WSACleanup();
  8790. }
  8791. bool is_valid_ = false;
  8792. };
  8793. static WSInit wsinit_;
  8794. #endif
  8795. inline std::string unescape_quoted_pairs(const std::string &s) {
  8796. std::string out;
  8797. out.reserve(s.size());
  8798. for (size_t i = 0; i < s.size(); i++) {
  8799. if (s[i] == '\\' && i + 1 < s.size()) {
  8800. out += s[++i];
  8801. } else {
  8802. out += s[i];
  8803. }
  8804. }
  8805. return out;
  8806. }
  8807. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8808. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8809. // quoted-pair, so the recipient recovers the original value.
  8810. inline std::string escape_quoted_pairs(const std::string &s) {
  8811. std::string out;
  8812. out.reserve(s.size());
  8813. for (auto c : s) {
  8814. if (c == '\\' || c == '"') { out += '\\'; }
  8815. out += c;
  8816. }
  8817. return out;
  8818. }
  8819. // RFC 9110 Section 11.6.1 defines a challenge list as
  8820. // WWW-Authenticate = #challenge
  8821. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8822. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8823. // so a server may offer several schemes, each with its own comma-separated
  8824. // auth-param list, in either order and either as separate field lines or
  8825. // packed into one. Splitting on every comma would break apart a challenge's
  8826. // own param list; splitting only on the first space would miss a Digest
  8827. // challenge that isn't first. Split on commas that aren't inside a
  8828. // quoted-string instead (split_unquoted), then track which scheme each
  8829. // resulting segment belongs to: a segment whose text before "=" contains
  8830. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8831. // leading token.
  8832. inline bool parse_www_authenticate(const Response &res,
  8833. std::map<std::string, std::string> &auth,
  8834. bool is_proxy) {
  8835. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8836. auto combined = get_combined_header_value(res.headers, auth_key);
  8837. if (combined.empty()) { return false; }
  8838. auto found_digest = false;
  8839. auto in_digest_challenge = false;
  8840. split_unquoted(
  8841. combined.data(), combined.data() + combined.size(), ',',
  8842. [&](const char *b, const char *e) {
  8843. std::string segment(b, e);
  8844. auto eq_pos = segment.find('=');
  8845. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8846. // for the first segment of a challenge, "<scheme> <key>") must be
  8847. // trimmed before its boundaries are inspected.
  8848. auto key_part = trim_copy(
  8849. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8850. auto space_pos = key_part.find_last_of(" \t");
  8851. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8852. // "<scheme>[ <key>]" starts a new challenge.
  8853. auto scheme_end =
  8854. space_pos == std::string::npos ? key_part.size() : space_pos;
  8855. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8856. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8857. // from one challenge is never paired with another's algorithm.
  8858. in_digest_challenge =
  8859. !found_digest &&
  8860. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8861. if (in_digest_challenge) { found_digest = true; }
  8862. if (space_pos == std::string::npos) {
  8863. // Bare scheme (or a token68), no auth-param on this segment.
  8864. return;
  8865. }
  8866. key_part = key_part.substr(space_pos + 1);
  8867. }
  8868. if (!in_digest_challenge) { return; }
  8869. auto val = trim_copy(segment.substr(eq_pos + 1));
  8870. auto unquoted = trim_double_quotes_copy(val);
  8871. if (unquoted.size() != val.size()) {
  8872. unquoted = unescape_quoted_pairs(unquoted);
  8873. }
  8874. auth[std::move(key_part)] = std::move(unquoted);
  8875. });
  8876. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8877. // make_digest_authentication_header() dereferences both unconditionally, so
  8878. // a challenge missing either can't produce a usable Authorization header.
  8879. // Treat it the same as no Digest challenge at all.
  8880. return found_digest && auth.find("realm") != auth.end() &&
  8881. auth.find("nonce") != auth.end();
  8882. }
  8883. class ContentProviderAdapter {
  8884. public:
  8885. explicit ContentProviderAdapter(
  8886. ContentProviderWithoutLength &&content_provider)
  8887. : content_provider_(std::move(content_provider)) {}
  8888. bool operator()(size_t offset, size_t, DataSink &sink) {
  8889. return content_provider_(offset, sink);
  8890. }
  8891. private:
  8892. ContentProviderWithoutLength content_provider_;
  8893. };
  8894. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8895. namespace fields {
  8896. inline bool is_token_char(char c) {
  8897. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8898. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8899. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8900. }
  8901. inline bool is_token(const std::string &s) {
  8902. if (s.empty()) { return false; }
  8903. for (auto c : s) {
  8904. if (!is_token_char(c)) { return false; }
  8905. }
  8906. return true;
  8907. }
  8908. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8909. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8910. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8911. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8912. inline bool is_field_content(const std::string &s) {
  8913. if (s.empty()) { return true; }
  8914. if (s.size() == 1) {
  8915. return is_field_vchar(s[0]);
  8916. } else if (s.size() == 2) {
  8917. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8918. } else {
  8919. size_t i = 0;
  8920. if (!is_field_vchar(s[i])) { return false; }
  8921. i++;
  8922. while (i < s.size() - 1) {
  8923. auto c = s[i++];
  8924. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8925. } else {
  8926. return false;
  8927. }
  8928. }
  8929. return is_field_vchar(s[i]);
  8930. }
  8931. }
  8932. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8933. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8934. return is_field_name(name) && is_field_value(value);
  8935. }
  8936. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8937. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8938. inline bool is_request_target(const std::string &s) {
  8939. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8940. }
  8941. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8942. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8943. inline bool is_host(const std::string &s) {
  8944. return std::all_of(s.begin(), s.end(), [](char c) {
  8945. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8946. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8947. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8948. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8949. });
  8950. }
  8951. } // namespace fields
  8952. // Built in memory first, like ClientImpl::write_request, so a rejected header
  8953. // never leaves a partial request on the wire.
  8954. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  8955. BufferStream bstrm;
  8956. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8957. error = Error::Write;
  8958. return false;
  8959. }
  8960. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8961. return false;
  8962. }
  8963. const auto &data = bstrm.get_buffer();
  8964. if (!write_data(strm, data.data(), data.size())) {
  8965. error = Error::Write;
  8966. return false;
  8967. }
  8968. return true;
  8969. }
  8970. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8971. WebSocketUpgradeResponse &upgrade) {
  8972. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8973. std::string key_bytes(16, '\0');
  8974. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8975. key_bytes.size());
  8976. auto client_key = base64_encode(key_bytes);
  8977. req.headers.erase("Upgrade");
  8978. req.headers.erase("Connection");
  8979. req.headers.erase("Sec-WebSocket-Key");
  8980. req.headers.erase("Sec-WebSocket-Version");
  8981. req.headers.emplace("Upgrade", "websocket");
  8982. req.headers.emplace("Connection", "Upgrade");
  8983. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8984. req.headers.emplace("Sec-WebSocket-Version", "13");
  8985. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  8986. // Verify 101 response and Sec-WebSocket-Accept header
  8987. auto expected_accept = websocket_accept_key(client_key);
  8988. auto offered_subprotocols =
  8989. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8990. return read_websocket_upgrade_response(strm, expected_accept,
  8991. offered_subprotocols, upgrade);
  8992. }
  8993. inline bool is_ip_address(const std::string &host) {
  8994. struct in_addr addr4;
  8995. struct in6_addr addr6;
  8996. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8997. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8998. }
  8999. // One spelling for an IPv6 address, and the IPv4 one for an IPv4-mapped IPv6
  9000. // address, which is how a dual-stack socket reports an IPv4 peer. Anything
  9001. // else, including an address with a zone ID, is returned as it is.
  9002. inline std::string canonical_ip(const std::string &addr) {
  9003. struct in6_addr addr6;
  9004. if (addr.find('%') != std::string::npos ||
  9005. inet_pton(AF_INET6, addr.c_str(), &addr6) != 1) {
  9006. return addr;
  9007. }
  9008. char buf[INET6_ADDRSTRLEN];
  9009. if (IN6_IS_ADDR_V4MAPPED(&addr6)) {
  9010. return inet_ntop(AF_INET, &addr6.s6_addr[12], buf, sizeof(buf)) ? buf
  9011. : addr;
  9012. }
  9013. return inet_ntop(AF_INET6, &addr6, buf, sizeof(buf)) ? buf : addr;
  9014. }
  9015. // `trusted_proxies` holds canonical_ip() spellings.
  9016. inline bool is_trusted_proxy(const std::string &addr,
  9017. const std::vector<std::string> &trusted_proxies) {
  9018. if (trusted_proxies.empty()) { return false; }
  9019. return std::find(trusted_proxies.begin(), trusted_proxies.end(),
  9020. canonical_ip(addr)) != trusted_proxies.end();
  9021. }
  9022. // Resolve where a client should connect for `host`, honoring a user-supplied
  9023. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  9024. // supplying the Host header and SNI; only the connection target changes.
  9025. //
  9026. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  9027. // path. Anything else goes to `connect_host`, which create_socket resolves as
  9028. // a name, or uses as the socket path when the address family is AF_UNIX. An
  9029. // absent or empty mapping leaves `host` as the connection target; without the
  9030. // empty check the value would reach getaddrinfo as a null node and silently
  9031. // resolve to loopback.
  9032. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  9033. const std::string &host, std::string &connect_host,
  9034. std::string &ip) {
  9035. connect_host = host;
  9036. ip.clear();
  9037. auto it = addr_map.find(host);
  9038. if (it == addr_map.end() || it->second.empty()) { return; }
  9039. if (is_ip_address(it->second)) {
  9040. ip = it->second;
  9041. } else {
  9042. connect_host = it->second;
  9043. }
  9044. }
  9045. } // namespace detail
  9046. /*
  9047. * Group 2: detail namespace - SSL common utilities
  9048. */
  9049. #ifdef CPPHTTPLIB_SSL_ENABLED
  9050. namespace detail {
  9051. class SSLSocketStream final : public Stream {
  9052. public:
  9053. SSLSocketStream(
  9054. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9055. time_t read_timeout_usec, time_t write_timeout_sec,
  9056. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9057. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9058. (std::chrono::steady_clock::time_point::min)());
  9059. ~SSLSocketStream() override;
  9060. bool is_readable() const override;
  9061. bool wait_readable() const override;
  9062. bool wait_writable() const override;
  9063. bool is_peer_alive() const override;
  9064. ssize_t read(char *ptr, size_t size) override;
  9065. ssize_t write(const char *ptr, size_t size) override;
  9066. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9067. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9068. socket_t socket() const override;
  9069. time_t duration() const override;
  9070. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9071. void set_max_timeout(time_t msec) override;
  9072. void set_read_interrupt(std::function<bool()> interrupted) override;
  9073. // See SocketStream::set_readable_hint().
  9074. void set_readable_hint() { readable_hint_ = true; }
  9075. // The error from the last read() or write() that failed in the TLS layer,
  9076. // with code Success if none did
  9077. const tls::TlsError &tls_error() const { return tls_error_; }
  9078. private:
  9079. bool ensure_readable();
  9080. socket_t sock_;
  9081. tls::session_t session_;
  9082. time_t read_timeout_sec_;
  9083. time_t read_timeout_usec_;
  9084. time_t write_timeout_sec_;
  9085. time_t write_timeout_usec_;
  9086. time_t max_timeout_msec_;
  9087. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9088. std::function<bool()> read_interrupted_;
  9089. bool readable_hint_ = false;
  9090. tls::TlsError tls_error_;
  9091. };
  9092. // A TLS stream for WebSocket connections, where the receive path and the
  9093. // send path (application send() plus the heartbeat ping thread) run on
  9094. // different threads. A single TLS session must never be entered
  9095. // concurrently, so every call into the session is serialized by one mutex.
  9096. //
  9097. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9098. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9099. // call under the lock, then waits for readiness with select() outside the
  9100. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9101. // blocked waiting for data never stalls a concurrent sender.
  9102. //
  9103. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9104. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9105. class WebSocketSSLStream final : public Stream {
  9106. public:
  9107. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9108. time_t read_timeout_sec, time_t read_timeout_usec,
  9109. time_t write_timeout_sec, time_t write_timeout_usec);
  9110. ~WebSocketSSLStream() override;
  9111. bool is_readable() const override;
  9112. bool wait_readable() const override;
  9113. bool wait_writable() const override;
  9114. ssize_t read(char *ptr, size_t size) override;
  9115. ssize_t write(const char *ptr, size_t size) override;
  9116. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9117. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9118. socket_t socket() const override;
  9119. time_t duration() const override;
  9120. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9121. void set_read_interrupt(std::function<bool()> interrupted) override;
  9122. private:
  9123. mutable std::mutex session_mutex_;
  9124. socket_t sock_;
  9125. tls::session_t session_;
  9126. // WebSocket::close() shortens the read timeout from the closing thread
  9127. // while the receive thread is inside wait_readable(), so these two are read
  9128. // and written concurrently. The write timeouts are never mutated.
  9129. std::atomic<time_t> read_timeout_sec_;
  9130. std::atomic<time_t> read_timeout_usec_;
  9131. time_t write_timeout_sec_;
  9132. time_t write_timeout_usec_;
  9133. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9134. std::function<bool()> read_interrupted_;
  9135. };
  9136. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9137. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9138. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9139. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9140. unsigned int hash_length = 0;
  9141. unsigned char hash[EVP_MAX_MD_SIZE];
  9142. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9143. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9144. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9145. std::stringstream ss;
  9146. for (auto i = 0u; i < hash_length; ++i) {
  9147. ss << std::hex << std::setw(2) << std::setfill('0')
  9148. << static_cast<unsigned int>(hash[i]);
  9149. }
  9150. return ss.str();
  9151. }
  9152. inline std::string MD5(const std::string &s) {
  9153. return message_digest(s, EVP_md5());
  9154. }
  9155. inline std::string SHA_256(const std::string &s) {
  9156. return message_digest(s, EVP_sha256());
  9157. }
  9158. inline std::string SHA_512(const std::string &s) {
  9159. return message_digest(s, EVP_sha512());
  9160. }
  9161. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9162. namespace {
  9163. template <size_t N>
  9164. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9165. std::stringstream ss;
  9166. for (size_t i = 0; i < N; ++i) {
  9167. ss << std::hex << std::setw(2) << std::setfill('0')
  9168. << static_cast<unsigned int>(hash[i]);
  9169. }
  9170. return ss.str();
  9171. }
  9172. } // namespace
  9173. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9174. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9175. // initialized once. PSA state is process-global; do not free it.
  9176. inline bool ensure_mbedtls_psa_crypto() {
  9177. static std::once_flag once;
  9178. static bool ok = false;
  9179. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9180. return ok;
  9181. }
  9182. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9183. unsigned char *out, size_t out_size) {
  9184. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9185. size_t olen = 0;
  9186. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9187. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9188. olen == out_size;
  9189. }
  9190. #endif
  9191. inline std::string MD5(const std::string &s) {
  9192. unsigned char hash[16];
  9193. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9194. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9195. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9196. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9197. hash);
  9198. #else
  9199. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9200. hash);
  9201. #endif
  9202. return hash_to_hex(hash);
  9203. }
  9204. inline std::string SHA_256(const std::string &s) {
  9205. unsigned char hash[32];
  9206. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9207. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9208. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9209. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9210. hash, 0);
  9211. #else
  9212. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9213. s.size(), hash, 0);
  9214. #endif
  9215. return hash_to_hex(hash);
  9216. }
  9217. inline std::string SHA_512(const std::string &s) {
  9218. unsigned char hash[64];
  9219. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9220. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9221. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9222. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9223. hash, 0);
  9224. #else
  9225. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9226. s.size(), hash, 0);
  9227. #endif
  9228. return hash_to_hex(hash);
  9229. }
  9230. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9231. namespace {
  9232. template <size_t N>
  9233. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9234. std::stringstream ss;
  9235. for (size_t i = 0; i < N; ++i) {
  9236. ss << std::hex << std::setw(2) << std::setfill('0')
  9237. << static_cast<unsigned int>(hash[i]);
  9238. }
  9239. return ss.str();
  9240. }
  9241. } // namespace
  9242. inline std::string MD5(const std::string &s) {
  9243. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9244. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9245. static_cast<word32>(s.size()), hash);
  9246. return hash_to_hex(hash);
  9247. }
  9248. inline std::string SHA_256(const std::string &s) {
  9249. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9250. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9251. static_cast<word32>(s.size()), hash);
  9252. return hash_to_hex(hash);
  9253. }
  9254. inline std::string SHA_512(const std::string &s) {
  9255. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9256. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9257. static_cast<word32>(s.size()), hash);
  9258. return hash_to_hex(hash);
  9259. }
  9260. #endif
  9261. template <typename T>
  9262. inline bool process_server_socket_ssl(
  9263. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9264. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9265. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9266. time_t write_timeout_usec, T callback) {
  9267. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9268. // of a pipelined request, which keep_alive() cannot see on the socket.
  9269. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9270. write_timeout_sec, write_timeout_usec);
  9271. return process_server_socket_core(
  9272. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9273. [&]() { return strm.is_readable(); },
  9274. [&](bool socket_readable, bool close_connection,
  9275. bool &connection_closed) {
  9276. if (socket_readable) { strm.set_readable_hint(); }
  9277. return callback(strm, close_connection, connection_closed);
  9278. });
  9279. }
  9280. template <typename T>
  9281. inline bool process_client_socket_ssl(
  9282. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9283. time_t read_timeout_usec, time_t write_timeout_sec,
  9284. time_t write_timeout_usec, time_t max_timeout_msec,
  9285. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9286. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9287. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9288. start_time);
  9289. return callback(strm);
  9290. }
  9291. // `uri` is req's request-target in origin form, as curl sends it, also when
  9292. // the request line carries the absolute form for a proxy.
  9293. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9294. const Request &req, const std::string &uri,
  9295. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9296. const std::string &cnonce, const std::string &username,
  9297. const std::string &password, bool is_proxy = false) {
  9298. std::string nc;
  9299. {
  9300. std::stringstream ss;
  9301. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9302. nc = ss.str();
  9303. }
  9304. std::string qop;
  9305. if (auth.find("qop") != auth.end()) {
  9306. qop = auth.at("qop");
  9307. if (qop.find("auth-int") != std::string::npos) {
  9308. qop = "auth-int";
  9309. } else if (qop.find("auth") != std::string::npos) {
  9310. qop = "auth";
  9311. } else {
  9312. qop.clear();
  9313. }
  9314. }
  9315. std::string algo = "MD5";
  9316. if (auth.find("algorithm") != auth.end()) {
  9317. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9318. // not a token would otherwise be emitted verbatim and could carry commas
  9319. // or quotes that inject further auth-params into the header below.
  9320. const auto &a = auth.at("algorithm");
  9321. if (fields::is_token(a)) { algo = a; }
  9322. }
  9323. std::string response;
  9324. {
  9325. auto H = algo == "SHA-256" ? detail::SHA_256
  9326. : algo == "SHA-512" ? detail::SHA_512
  9327. : detail::MD5;
  9328. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9329. auto A2 = req.method + ":" + uri;
  9330. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9331. if (qop.empty()) {
  9332. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9333. } else {
  9334. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9335. ":" + qop + ":" + H(A2));
  9336. }
  9337. }
  9338. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9339. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9340. // close the string early. realm, nonce and opaque come straight from the
  9341. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9342. // without this a crafted challenge injects extra auth-params into the header.
  9343. auto field =
  9344. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9345. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9346. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9347. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9348. "\", algorithm=" + algo +
  9349. (qop.empty() ? ", response=\""
  9350. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9351. "\", response=\"") +
  9352. response + "\"" +
  9353. (opaque.empty()
  9354. ? ""
  9355. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9356. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9357. return std::make_pair(key, field);
  9358. }
  9359. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9360. // backend accepts the same names.
  9361. inline bool match_hostname(const std::string &pattern,
  9362. const std::string &hostname) {
  9363. // A trailing dot on the host is ignored
  9364. auto host = hostname;
  9365. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9366. // Exact match (case-insensitive)
  9367. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9368. // Split both pattern and hostname into components by '.', keeping any empty
  9369. // one, which no name may have
  9370. auto labels = [](const std::string &s) {
  9371. std::vector<std::string> v;
  9372. size_t b = 0;
  9373. while (true) {
  9374. auto e = s.find('.', b);
  9375. v.push_back(s.substr(b, e - b));
  9376. if (e == std::string::npos) { return v; }
  9377. b = e + 1;
  9378. }
  9379. };
  9380. auto pattern_components = labels(pattern);
  9381. auto host_components = labels(host);
  9382. auto has_empty_label = [](const std::vector<std::string> &v) {
  9383. return std::any_of(v.begin(), v.end(),
  9384. [](const std::string &l) { return l.empty(); });
  9385. };
  9386. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9387. return false;
  9388. }
  9389. // Component count must match
  9390. if (host_components.size() != pattern_components.size()) { return false; }
  9391. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9392. // and an IDNA label may not have one
  9393. const auto &leftmost = pattern_components.front();
  9394. if (leftmost.find('*') != std::string::npos &&
  9395. (pattern_components.size() < 3 ||
  9396. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9397. return false;
  9398. }
  9399. // Compare each component with wildcard support
  9400. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9401. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9402. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9403. auto itr = pattern_components.begin();
  9404. for (const auto &h : host_components) {
  9405. auto &p = *itr;
  9406. auto is_leftmost = itr == pattern_components.begin();
  9407. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9408. bool partial_match = false;
  9409. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9410. const auto prefix_length = p.size() - 1;
  9411. if (prefix_length == 0) {
  9412. partial_match = true;
  9413. } else if (h.size() >= prefix_length) {
  9414. partial_match =
  9415. std::equal(p.begin(),
  9416. p.begin() + static_cast<std::string::difference_type>(
  9417. prefix_length),
  9418. h.begin(), [](const char ca, const char cb) {
  9419. return detail::case_ignore::to_lower(ca) ==
  9420. detail::case_ignore::to_lower(cb);
  9421. });
  9422. }
  9423. }
  9424. if (!partial_match) { return false; }
  9425. }
  9426. ++itr;
  9427. }
  9428. return true;
  9429. }
  9430. #ifdef _WIN32
  9431. // Verify certificate using Windows CertGetCertificateChain API.
  9432. // This provides real-time certificate validation with Windows Update
  9433. // integration, independent of the TLS backend.
  9434. inline bool verify_cert_with_windows_schannel(
  9435. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9436. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9437. if (der_cert.empty()) { return false; }
  9438. out_error = 0;
  9439. // Create Windows certificate context from DER data
  9440. auto cert_context = CertCreateCertificateContext(
  9441. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9442. static_cast<DWORD>(der_cert.size()));
  9443. if (!cert_context) {
  9444. out_error = GetLastError();
  9445. return false;
  9446. }
  9447. auto cert_guard =
  9448. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9449. // Give CryptoAPI the certificates the server sent. Without them it follows
  9450. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9451. std::vector<tls::cert_t> peer_certs;
  9452. tls::get_peer_certs(session, peer_certs);
  9453. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9454. auto store_guard = scope_exit([&] {
  9455. for (auto cert : peer_certs) {
  9456. tls::free_cert(cert);
  9457. }
  9458. if (store) { CertCloseStore(store, 0); }
  9459. });
  9460. for (auto cert : peer_certs) {
  9461. std::vector<unsigned char> der;
  9462. if (store && tls::get_cert_der(cert, der)) {
  9463. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9464. static_cast<DWORD>(der.size()),
  9465. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9466. }
  9467. }
  9468. // Setup chain parameters
  9469. CERT_CHAIN_PARA chain_para = {};
  9470. chain_para.cbSize = sizeof(chain_para);
  9471. // Require the server authentication usage along the chain, which also
  9472. // rejects roots that Windows trusts only for other purposes.
  9473. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9474. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9475. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9476. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9477. // Build certificate chain with revocation checking
  9478. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9479. auto chain_result = CertGetCertificateChain(
  9480. nullptr, cert_context, nullptr, store, &chain_para,
  9481. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9482. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9483. nullptr, &chain_context);
  9484. if (!chain_result || !chain_context) {
  9485. out_error = GetLastError();
  9486. return false;
  9487. }
  9488. auto chain_guard =
  9489. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9490. // Verify SSL policy
  9491. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9492. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9493. #ifdef AUTHTYPE_SERVER
  9494. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9495. #endif
  9496. std::wstring whost;
  9497. if (verify_hostname) {
  9498. whost = u8string_to_wstring(hostname.c_str());
  9499. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9500. }
  9501. CERT_CHAIN_POLICY_PARA policy_para = {};
  9502. policy_para.cbSize = sizeof(policy_para);
  9503. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9504. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9505. #else
  9506. policy_para.dwFlags = 0;
  9507. #endif
  9508. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9509. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9510. policy_status.cbSize = sizeof(policy_status);
  9511. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9512. &policy_para, &policy_status)) {
  9513. out_error = GetLastError();
  9514. return false;
  9515. }
  9516. if (policy_status.dwError != 0) {
  9517. out_error = policy_status.dwError;
  9518. return false;
  9519. }
  9520. return true;
  9521. }
  9522. #endif // _WIN32
  9523. // Loads CA file/dir configuration and applies the system CA policy to a
  9524. // client TLS context. PEM data and native stores are applied to the context
  9525. // directly at set time; has_custom_store reflects them for the Auto policy
  9526. // decision.
  9527. inline bool load_client_ca_config(tls::ctx_t ctx,
  9528. const std::string &ca_cert_file_path,
  9529. const std::string &ca_cert_dir_path,
  9530. bool has_custom_store, SystemCAMode mode,
  9531. uint64_t &backend_error) {
  9532. auto ret = true;
  9533. if (!ca_cert_file_path.empty()) {
  9534. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9535. backend_error = tls::get_error();
  9536. ret = false;
  9537. }
  9538. } else if (!ca_cert_dir_path.empty()) {
  9539. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9540. backend_error = tls::get_error();
  9541. ret = false;
  9542. }
  9543. }
  9544. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9545. !ca_cert_dir_path.empty() || has_custom_store;
  9546. if (mode == SystemCAMode::Enabled ||
  9547. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9548. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9549. }
  9550. return ret;
  9551. }
  9552. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9553. // loaded into another context.
  9554. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9555. std::string pem;
  9556. std::vector<tls::cert_t> certs;
  9557. tls::get_ca_certs(ctx, certs);
  9558. for (auto cert : certs) {
  9559. std::vector<unsigned char> der;
  9560. if (tls::get_cert_der(cert, der)) {
  9561. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9562. pem += "-----BEGIN CERTIFICATE-----\n";
  9563. for (size_t i = 0; i < b64.size(); i += 64) {
  9564. pem += b64.substr(i, 64);
  9565. pem += '\n';
  9566. }
  9567. pem += "-----END CERTIFICATE-----\n";
  9568. }
  9569. tls::free_cert(cert);
  9570. }
  9571. return pem;
  9572. }
  9573. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9574. // copied to buf, or pem itself when len is 0.
  9575. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9576. if (!pem || len == 0) { return pem; }
  9577. buf.assign(pem, len);
  9578. return buf.c_str();
  9579. }
  9580. // The parts of session setup that only SSLClient needs, plus the handful
  9581. // WebSocketClient also exposes; everything else takes the defaults, which is
  9582. // what keeps the two clients on one implementation.
  9583. struct ClientTlsSessionOptions {
  9584. // Both SSLClient and WebSocketClient expose this independently of
  9585. // certificate verification.
  9586. bool server_hostname_verification = true;
  9587. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9588. // When non-null, guards session creation against concurrent use of the
  9589. // context. A WebSocketClient is not safe to use from several threads to
  9590. // begin with, so it passes nothing.
  9591. std::mutex *ctx_mutex = nullptr;
  9592. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9593. // The caller decides whether Schannel has anything to say about this
  9594. // connection; see SSLClient::initialize_ssl().
  9595. bool windows_cert_verification = false;
  9596. // A server certificate verifier works on the backend's chain verification,
  9597. // so the backend keeps deciding and Schannel only adds its own check.
  9598. bool server_certificate_verifier_set = false;
  9599. #endif
  9600. };
  9601. // Filled in on failure for callers that report error details.
  9602. struct ClientTlsSessionError {
  9603. Error error = Error::Success;
  9604. int ssl_error = 0;
  9605. uint64_t backend_error = 0;
  9606. };
  9607. // Establishes a client TLS session on an already connected socket. On failure
  9608. // the session is left for the caller to free: SSLClient frees it right away,
  9609. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9610. inline bool setup_client_tls_session(
  9611. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9612. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9613. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9614. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9615. using namespace tls;
  9616. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9617. if (out_error) {
  9618. out_error->error = error;
  9619. out_error->ssl_error = ssl_error;
  9620. out_error->backend_error = backend_error;
  9621. }
  9622. return false;
  9623. };
  9624. // A TLS failure, whose verification codes name the Error too
  9625. auto fail_tls = [&](ErrorCode code, uint64_t backend_error) {
  9626. auto error = Error::SSLConnection;
  9627. if (code == ErrorCode::CertVerifyFailed) {
  9628. error = Error::SSLServerVerification;
  9629. } else if (code == ErrorCode::HostnameMismatch) {
  9630. error = Error::SSLServerHostnameVerification;
  9631. }
  9632. return fail(error, static_cast<int>(code), backend_error);
  9633. };
  9634. if (!ctx) {
  9635. session = nullptr;
  9636. return fail(Error::SSLConnection, 0, 0);
  9637. }
  9638. // With Windows verification on and no server certificate verifier set,
  9639. // Schannel is the only chain verifier. The backend's trust store is a
  9640. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9641. // demand, so the backend's verdict is not used.
  9642. auto windows_verifies_chain = false;
  9643. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9644. windows_verifies_chain = options.windows_cert_verification &&
  9645. !options.server_certificate_verifier_set;
  9646. #endif
  9647. // The chain, and a host name, are verified during the handshake, so that a
  9648. // server failing them never gets to see a client certificate. Unless
  9649. // Schannel verifies the chain instead, this holds for IP hosts too, whose
  9650. // identity is checked after the handshake by verify_hostname().
  9651. auto verify_in_handshake =
  9652. server_certificate_verification && !windows_verifies_chain;
  9653. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9654. // A session verifier may accept a certificate the built-in check rejects,
  9655. // and runs only after the handshake
  9656. verify_in_handshake = verify_in_handshake && !options.session_verifier;
  9657. #endif
  9658. {
  9659. std::unique_lock<std::mutex> guard;
  9660. if (options.ctx_mutex) {
  9661. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9662. }
  9663. // The mode is set on the context, so under the same lock
  9664. set_verify_client(ctx, verify_in_handshake);
  9665. session = create_session(ctx, sock);
  9666. }
  9667. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9668. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9669. // their identity is checked post-handshake below instead.
  9670. if (!is_ip_address(host)) {
  9671. if (!set_sni(session, host.c_str(),
  9672. verify_in_handshake && options.server_hostname_verification)) {
  9673. return fail(Error::SSLConnection, 0, get_error());
  9674. }
  9675. }
  9676. TlsError tls_err;
  9677. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9678. &tls_err)) {
  9679. return fail_tls(tls_err.code, tls_err.backend_code);
  9680. }
  9681. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9682. if (options.session_verifier) {
  9683. verification_status = options.session_verifier(session);
  9684. }
  9685. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9686. return fail(Error::SSLServerVerification, 0, get_error());
  9687. }
  9688. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9689. server_certificate_verification) {
  9690. if (!windows_verifies_chain) {
  9691. auto verify_result = get_verify_result(session);
  9692. if (verify_result != 0) {
  9693. return fail_tls(ErrorCode::CertVerifyFailed,
  9694. static_cast<uint64_t>(verify_result));
  9695. }
  9696. }
  9697. auto server_cert = get_peer_cert(session);
  9698. if (!server_cert) {
  9699. return fail_tls(ErrorCode::CertVerifyFailed, get_error());
  9700. }
  9701. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9702. // Identity check against the peer certificate, post-handshake for all
  9703. // backends. For IP hosts this is the only identity verification, since no
  9704. // hostname is bound during the handshake.
  9705. if (options.server_hostname_verification) {
  9706. if (!verify_hostname(server_cert, host.c_str())) {
  9707. return fail_tls(ErrorCode::HostnameMismatch, hostname_mismatch_code());
  9708. }
  9709. }
  9710. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9711. // Windows Schannel verification, which lets Windows fetch missing roots
  9712. // and intermediates on demand. It must not be skipped: unless a server
  9713. // certificate verifier is set, it is the only chain check.
  9714. if (options.windows_cert_verification) {
  9715. std::vector<unsigned char> der;
  9716. uint64_t wincrypt_error = 0;
  9717. if (!get_cert_der(server_cert, der) ||
  9718. !verify_cert_with_windows_schannel(
  9719. der, host, options.server_hostname_verification, wincrypt_error,
  9720. session)) {
  9721. return fail_tls(ErrorCode::CertVerifyFailed, wincrypt_error);
  9722. }
  9723. }
  9724. #endif
  9725. }
  9726. return true;
  9727. }
  9728. } // namespace detail
  9729. #endif // CPPHTTPLIB_SSL_ENABLED
  9730. /*
  9731. * Group 3: httplib namespace - Non-SSL public API implementations
  9732. */
  9733. inline void default_socket_options(socket_t sock) {
  9734. set_socket_opt(sock, SOL_SOCKET,
  9735. #ifdef SO_REUSEPORT
  9736. SO_REUSEPORT,
  9737. #else
  9738. SO_REUSEADDR,
  9739. #endif
  9740. 1);
  9741. }
  9742. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9743. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9744. sizeof(optval));
  9745. }
  9746. inline std::string get_bearer_token_auth(const Request &req) {
  9747. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9748. // than the prefix carries no token.
  9749. constexpr const char bearer_prefix[] = "Bearer ";
  9750. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9751. auto value = req.get_header_value("Authorization");
  9752. if (value.size() >= bearer_prefix_len &&
  9753. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9754. bearer_prefix)) {
  9755. return value.substr(bearer_prefix_len);
  9756. }
  9757. return "";
  9758. }
  9759. inline const char *status_message(int status) {
  9760. switch (status) {
  9761. case StatusCode::Continue_100: return "Continue";
  9762. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9763. case StatusCode::Processing_102: return "Processing";
  9764. case StatusCode::EarlyHints_103: return "Early Hints";
  9765. case StatusCode::OK_200: return "OK";
  9766. case StatusCode::Created_201: return "Created";
  9767. case StatusCode::Accepted_202: return "Accepted";
  9768. case StatusCode::NonAuthoritativeInformation_203:
  9769. return "Non-Authoritative Information";
  9770. case StatusCode::NoContent_204: return "No Content";
  9771. case StatusCode::ResetContent_205: return "Reset Content";
  9772. case StatusCode::PartialContent_206: return "Partial Content";
  9773. case StatusCode::MultiStatus_207: return "Multi-Status";
  9774. case StatusCode::AlreadyReported_208: return "Already Reported";
  9775. case StatusCode::IMUsed_226: return "IM Used";
  9776. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9777. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9778. case StatusCode::Found_302: return "Found";
  9779. case StatusCode::SeeOther_303: return "See Other";
  9780. case StatusCode::NotModified_304: return "Not Modified";
  9781. case StatusCode::UseProxy_305: return "Use Proxy";
  9782. case StatusCode::unused_306: return "unused";
  9783. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9784. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9785. case StatusCode::BadRequest_400: return "Bad Request";
  9786. case StatusCode::Unauthorized_401: return "Unauthorized";
  9787. case StatusCode::PaymentRequired_402: return "Payment Required";
  9788. case StatusCode::Forbidden_403: return "Forbidden";
  9789. case StatusCode::NotFound_404: return "Not Found";
  9790. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9791. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9792. case StatusCode::ProxyAuthenticationRequired_407:
  9793. return "Proxy Authentication Required";
  9794. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9795. case StatusCode::Conflict_409: return "Conflict";
  9796. case StatusCode::Gone_410: return "Gone";
  9797. case StatusCode::LengthRequired_411: return "Length Required";
  9798. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9799. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9800. case StatusCode::UriTooLong_414: return "URI Too Long";
  9801. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9802. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9803. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9804. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9805. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9806. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9807. case StatusCode::Locked_423: return "Locked";
  9808. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9809. case StatusCode::TooEarly_425: return "Too Early";
  9810. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9811. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9812. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9813. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9814. return "Request Header Fields Too Large";
  9815. case StatusCode::UnavailableForLegalReasons_451:
  9816. return "Unavailable For Legal Reasons";
  9817. case StatusCode::NotImplemented_501: return "Not Implemented";
  9818. case StatusCode::BadGateway_502: return "Bad Gateway";
  9819. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9820. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9821. case StatusCode::HttpVersionNotSupported_505:
  9822. return "HTTP Version Not Supported";
  9823. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9824. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9825. case StatusCode::LoopDetected_508: return "Loop Detected";
  9826. case StatusCode::NotExtended_510: return "Not Extended";
  9827. case StatusCode::NetworkAuthenticationRequired_511:
  9828. return "Network Authentication Required";
  9829. default:
  9830. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9831. }
  9832. }
  9833. inline std::string to_string(const Error error) {
  9834. switch (error) {
  9835. case Error::Success: return "Success (no error)";
  9836. case Error::Unknown: return "Unknown";
  9837. case Error::Connection: return "Could not establish connection";
  9838. case Error::BindIPAddress: return "Failed to bind IP address";
  9839. case Error::Read: return "Failed to read connection";
  9840. case Error::Write: return "Failed to write connection";
  9841. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9842. case Error::Canceled: return "Connection handling canceled";
  9843. case Error::SSLConnection: return "SSL connection failed";
  9844. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9845. case Error::SSLServerVerification: return "SSL server verification failed";
  9846. case Error::SSLServerHostnameVerification:
  9847. return "SSL server hostname verification failed";
  9848. case Error::UnsupportedMultipartBoundaryChars:
  9849. return "Unsupported HTTP multipart boundary characters";
  9850. case Error::Compression: return "Compression failed";
  9851. case Error::ConnectionTimeout: return "Connection timed out";
  9852. case Error::ProxyConnection: return "Proxy connection failed";
  9853. case Error::ConnectionClosed: return "Connection closed by server";
  9854. case Error::Timeout: return "Read timeout";
  9855. case Error::ResourceExhaustion: return "Resource exhaustion";
  9856. case Error::TooManyFormDataFiles: return "Too many form data files";
  9857. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9858. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9859. case Error::ExceedMaxSocketDescriptorCount:
  9860. return "Exceeded maximum socket descriptor count";
  9861. case Error::InvalidRequestLine: return "Invalid request line";
  9862. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9863. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9864. case Error::InvalidHeaders: return "Invalid headers";
  9865. case Error::MultipartParsing: return "Multipart parsing failed";
  9866. case Error::OpenFile: return "Failed to open file";
  9867. case Error::Listen: return "Failed to listen on socket";
  9868. case Error::GetSockName: return "Failed to get socket name";
  9869. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9870. case Error::HTTPParsing: return "HTTP parsing failed";
  9871. case Error::InvalidRangeHeader: return "Invalid Range header";
  9872. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9873. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9874. case Error::UserCallbackException: return "User callback threw an exception";
  9875. default: break;
  9876. }
  9877. return "Invalid";
  9878. }
  9879. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9880. os << to_string(obj);
  9881. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9882. return os;
  9883. }
  9884. inline std::string hosted_at(const std::string &hostname) {
  9885. std::vector<std::string> addrs;
  9886. hosted_at(hostname, addrs);
  9887. if (addrs.empty()) { return std::string(); }
  9888. return addrs[0];
  9889. }
  9890. inline void hosted_at(const std::string &hostname,
  9891. std::vector<std::string> &addrs) {
  9892. struct addrinfo hints;
  9893. struct addrinfo *result;
  9894. memset(&hints, 0, sizeof(struct addrinfo));
  9895. hints.ai_family = AF_UNSPEC;
  9896. hints.ai_socktype = SOCK_STREAM;
  9897. hints.ai_protocol = 0;
  9898. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9899. &result, 0)) {
  9900. #if defined __linux__ && !defined __ANDROID__
  9901. res_init();
  9902. #endif
  9903. return;
  9904. }
  9905. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9906. for (auto rp = result; rp; rp = rp->ai_next) {
  9907. const auto &addr =
  9908. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9909. std::string ip;
  9910. auto dummy = -1;
  9911. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9912. dummy)) {
  9913. addrs.emplace_back(std::move(ip));
  9914. }
  9915. }
  9916. }
  9917. inline std::string encode_uri_component(const std::string &value) {
  9918. std::ostringstream escaped;
  9919. escaped.fill('0');
  9920. escaped << std::hex;
  9921. for (auto c : value) {
  9922. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9923. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9924. escaped << c;
  9925. } else {
  9926. escaped << std::uppercase;
  9927. escaped << '%' << std::setw(2)
  9928. << static_cast<int>(static_cast<unsigned char>(c));
  9929. escaped << std::nouppercase;
  9930. }
  9931. }
  9932. return escaped.str();
  9933. }
  9934. inline std::string encode_uri(const std::string &value) {
  9935. std::ostringstream escaped;
  9936. escaped.fill('0');
  9937. escaped << std::hex;
  9938. for (auto c : value) {
  9939. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9940. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9941. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9942. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9943. escaped << c;
  9944. } else {
  9945. escaped << std::uppercase;
  9946. escaped << '%' << std::setw(2)
  9947. << static_cast<int>(static_cast<unsigned char>(c));
  9948. escaped << std::nouppercase;
  9949. }
  9950. }
  9951. return escaped.str();
  9952. }
  9953. inline std::string decode_uri_component(const std::string &value) {
  9954. std::string result;
  9955. for (size_t i = 0; i < value.size(); i++) {
  9956. if (value[i] == '%' && i + 2 < value.size()) {
  9957. auto val = 0;
  9958. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9959. result += static_cast<char>(val);
  9960. i += 2;
  9961. } else {
  9962. result += value[i];
  9963. }
  9964. } else {
  9965. result += value[i];
  9966. }
  9967. }
  9968. return result;
  9969. }
  9970. inline std::string decode_uri(const std::string &value) {
  9971. std::string result;
  9972. for (size_t i = 0; i < value.size(); i++) {
  9973. if (value[i] == '%' && i + 2 < value.size()) {
  9974. auto val = 0;
  9975. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9976. auto c = static_cast<char>(val);
  9977. // Keep escapes of the reserved characters that encode_uri leaves
  9978. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9979. // delimiter is not promoted into a real one (as with JS decodeURI).
  9980. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9981. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9982. c == '#') {
  9983. result += value[i];
  9984. result += value[i + 1];
  9985. result += value[i + 2];
  9986. } else {
  9987. result += c;
  9988. }
  9989. i += 2;
  9990. } else {
  9991. result += value[i];
  9992. }
  9993. } else {
  9994. result += value[i];
  9995. }
  9996. }
  9997. return result;
  9998. }
  9999. inline std::string encode_path_component(const std::string &component) {
  10000. std::string result;
  10001. result.reserve(component.size() * 3);
  10002. for (size_t i = 0; i < component.size(); i++) {
  10003. auto c = static_cast<unsigned char>(component[i]);
  10004. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  10005. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10006. c == '_' || c == '~') {
  10007. result += static_cast<char>(c);
  10008. }
  10009. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  10010. // "," / ";" / "="
  10011. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  10012. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  10013. c == '=') {
  10014. result += static_cast<char>(c);
  10015. }
  10016. // Colon is allowed in path segments except first segment
  10017. else if (c == ':') {
  10018. result += static_cast<char>(c);
  10019. }
  10020. // @ is allowed in path
  10021. else if (c == '@') {
  10022. result += static_cast<char>(c);
  10023. } else {
  10024. result += '%';
  10025. char hex[3];
  10026. snprintf(hex, sizeof(hex), "%02X", c);
  10027. result.append(hex, 2);
  10028. }
  10029. }
  10030. return result;
  10031. }
  10032. inline std::string decode_path_component(const std::string &component) {
  10033. std::string result;
  10034. result.reserve(component.size());
  10035. for (size_t i = 0; i < component.size(); i++) {
  10036. if (component[i] == '%' && i + 1 < component.size()) {
  10037. if (component[i + 1] == 'u') {
  10038. // Unicode %uXXXX encoding
  10039. auto val = 0;
  10040. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  10041. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  10042. char buff[4];
  10043. size_t len = 0;
  10044. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  10045. (len = detail::to_utf8(val, buff)) > 0) {
  10046. result.append(buff, len);
  10047. i += 5; // 'u0000'
  10048. } else {
  10049. // Not 4 hex digits, or a surrogate, which is no character: the
  10050. // escape is kept as it is rather than joining its neighbours
  10051. result += component[i];
  10052. }
  10053. } else {
  10054. // Standard %XX encoding
  10055. auto val = 0;
  10056. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10057. // 2 digits hex codes
  10058. result += static_cast<char>(val);
  10059. i += 2; // 'XX'
  10060. } else {
  10061. result += component[i];
  10062. }
  10063. }
  10064. } else {
  10065. result += component[i];
  10066. }
  10067. }
  10068. return result;
  10069. }
  10070. inline std::string encode_query_component(const std::string &component,
  10071. bool space_as_plus) {
  10072. std::string result;
  10073. result.reserve(component.size() * 3);
  10074. for (size_t i = 0; i < component.size(); i++) {
  10075. auto c = static_cast<unsigned char>(component[i]);
  10076. // Unreserved characters per RFC 3986
  10077. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10078. c == '_' || c == '~') {
  10079. result += static_cast<char>(c);
  10080. }
  10081. // Space handling
  10082. else if (c == ' ') {
  10083. if (space_as_plus) {
  10084. result += '+';
  10085. } else {
  10086. result += "%20";
  10087. }
  10088. }
  10089. // Plus sign handling
  10090. else if (c == '+') {
  10091. if (space_as_plus) {
  10092. result += "%2B";
  10093. } else {
  10094. result += static_cast<char>(c);
  10095. }
  10096. }
  10097. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10098. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10099. c == '*' || c == ',' || c == ';') {
  10100. result += static_cast<char>(c);
  10101. }
  10102. // Colon and @ are allowed in query
  10103. else if (c == ':' || c == '@') {
  10104. result += static_cast<char>(c);
  10105. }
  10106. // Forward slash is allowed in query values
  10107. else if (c == '/') {
  10108. result += static_cast<char>(c);
  10109. }
  10110. // Question mark is allowed in query values (after first ?)
  10111. else if (c == '?') {
  10112. result += static_cast<char>(c);
  10113. } else {
  10114. result += '%';
  10115. char hex[3];
  10116. snprintf(hex, sizeof(hex), "%02X", c);
  10117. result.append(hex, 2);
  10118. }
  10119. }
  10120. return result;
  10121. }
  10122. inline std::string decode_query_component(const std::string &component,
  10123. bool plus_as_space) {
  10124. std::string result;
  10125. result.reserve(component.size());
  10126. for (size_t i = 0; i < component.size(); i++) {
  10127. if (component[i] == '%' && i + 2 < component.size()) {
  10128. auto val = 0;
  10129. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10130. result += static_cast<char>(val);
  10131. i += 2;
  10132. } else {
  10133. result += component[i];
  10134. }
  10135. } else if (component[i] == '+' && plus_as_space) {
  10136. result += ' '; // + becomes space in form-urlencoded
  10137. } else {
  10138. result += component[i];
  10139. }
  10140. }
  10141. return result;
  10142. }
  10143. inline std::string sanitize_filename(const std::string &filename) {
  10144. // Extract basename: find the last path separator (/ or \)
  10145. auto pos = filename.find_last_of("/\\");
  10146. auto result =
  10147. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10148. // Strip null bytes
  10149. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10150. // Trim whitespace
  10151. {
  10152. auto start = result.find_first_not_of(" \t");
  10153. auto end = result.find_last_not_of(" \t");
  10154. result = (start == std::string::npos)
  10155. ? ""
  10156. : result.substr(start, end - start + 1);
  10157. }
  10158. // Reject . and ..
  10159. if (result == "." || result == "..") { return ""; }
  10160. return result;
  10161. }
  10162. inline std::string append_query_params(const std::string &path,
  10163. const Params &params) {
  10164. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10165. auto fragment_pos = path.find('#');
  10166. auto path_with_query = path.substr(0, fragment_pos);
  10167. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10168. path_with_query += detail::params_to_query_str(params);
  10169. if (fragment_pos != std::string::npos) {
  10170. path_with_query.append(path, fragment_pos, std::string::npos);
  10171. }
  10172. return path_with_query;
  10173. }
  10174. // Header utilities
  10175. inline std::pair<std::string, std::string>
  10176. make_range_header(const Ranges &ranges) {
  10177. std::string field = "bytes=";
  10178. auto i = 0;
  10179. for (const auto &r : ranges) {
  10180. if (i != 0) { field += ", "; }
  10181. if (r.first != -1) { field += std::to_string(r.first); }
  10182. field += '-';
  10183. if (r.second != -1) { field += std::to_string(r.second); }
  10184. i++;
  10185. }
  10186. return std::make_pair("Range", std::move(field));
  10187. }
  10188. inline std::pair<std::string, std::string>
  10189. make_basic_authentication_header(const std::string &username,
  10190. const std::string &password, bool is_proxy) {
  10191. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10192. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10193. return std::make_pair(key, std::move(field));
  10194. }
  10195. inline std::pair<std::string, std::string>
  10196. make_bearer_token_authentication_header(const std::string &token,
  10197. bool is_proxy = false) {
  10198. auto field = "Bearer " + token;
  10199. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10200. return std::make_pair(key, std::move(field));
  10201. }
  10202. namespace detail {
  10203. // Basic auth when a username or password is set, otherwise a bearer token,
  10204. // unless the request already carries the header.
  10205. inline void add_authorization_header(Request &req, const std::string &username,
  10206. const std::string &password,
  10207. const std::string &token, bool is_proxy) {
  10208. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10209. return;
  10210. }
  10211. if (!username.empty() || !password.empty()) {
  10212. req.headers.insert(
  10213. make_basic_authentication_header(username, password, is_proxy));
  10214. } else if (!token.empty()) {
  10215. req.headers.insert(
  10216. make_bearer_token_authentication_header(token, is_proxy));
  10217. }
  10218. }
  10219. } // namespace detail
  10220. // Request implementation
  10221. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10222. size_t id) const {
  10223. return detail::get_header_value_u64(headers, key, def, id);
  10224. }
  10225. inline bool Request::has_header(const std::string &key) const {
  10226. return detail::has_header(headers, key);
  10227. }
  10228. inline std::string Request::get_header_value(const std::string &key,
  10229. const char *def, size_t id) const {
  10230. return detail::get_header_value(headers, key, def, id);
  10231. }
  10232. inline size_t Request::get_header_value_count(const std::string &key) const {
  10233. return detail::get_header_value_count(headers, key);
  10234. }
  10235. inline void Request::set_header(const std::string &key,
  10236. const std::string &val) {
  10237. detail::set_header(headers, key, val);
  10238. }
  10239. inline bool Request::has_trailer(const std::string &key) const {
  10240. return trailers.find(key) != trailers.end();
  10241. }
  10242. inline std::string Request::get_trailer_value(const std::string &key,
  10243. size_t id) const {
  10244. return detail::get_multimap_value(trailers, key, id);
  10245. }
  10246. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10247. return trailers.count(key);
  10248. }
  10249. inline bool Request::has_param(const std::string &key) const {
  10250. return params.find(key) != params.end();
  10251. }
  10252. inline std::string Request::get_param_value(const std::string &key,
  10253. size_t id) const {
  10254. return detail::get_multimap_value(params, key, id);
  10255. }
  10256. inline std::vector<std::string>
  10257. Request::get_param_values(const std::string &key) const {
  10258. auto rng = params.equal_range(key);
  10259. std::vector<std::string> values;
  10260. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10261. for (auto it = rng.first; it != rng.second; ++it) {
  10262. values.push_back(it->second);
  10263. }
  10264. return values;
  10265. }
  10266. inline size_t Request::get_param_value_count(const std::string &key) const {
  10267. return params.count(key);
  10268. }
  10269. inline bool Request::is_multipart_form_data() const {
  10270. const auto &content_type = get_header_value("Content-Type");
  10271. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10272. "multipart/form-data");
  10273. }
  10274. // Multipart FormData implementation
  10275. inline std::string MultipartFormData::get_field(const std::string &key,
  10276. size_t id) const {
  10277. auto rng = fields.equal_range(key);
  10278. auto it = detail::bounded_next(rng.first, id, rng.second);
  10279. if (it != rng.second) { return it->second.content; }
  10280. return std::string();
  10281. }
  10282. inline std::vector<std::string>
  10283. MultipartFormData::get_fields(const std::string &key) const {
  10284. std::vector<std::string> values;
  10285. auto rng = fields.equal_range(key);
  10286. for (auto it = rng.first; it != rng.second; it++) {
  10287. values.push_back(it->second.content);
  10288. }
  10289. return values;
  10290. }
  10291. inline bool MultipartFormData::has_field(const std::string &key) const {
  10292. return fields.find(key) != fields.end();
  10293. }
  10294. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10295. return fields.count(key);
  10296. }
  10297. inline FormData MultipartFormData::get_file(const std::string &key,
  10298. size_t id) const {
  10299. return detail::get_multimap_value(files, key, id);
  10300. }
  10301. inline std::vector<FormData>
  10302. MultipartFormData::get_files(const std::string &key) const {
  10303. std::vector<FormData> values;
  10304. auto rng = files.equal_range(key);
  10305. for (auto it = rng.first; it != rng.second; it++) {
  10306. values.push_back(it->second);
  10307. }
  10308. return values;
  10309. }
  10310. inline bool MultipartFormData::has_file(const std::string &key) const {
  10311. return files.find(key) != files.end();
  10312. }
  10313. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10314. return files.count(key);
  10315. }
  10316. // Multipart FormData writer implementation
  10317. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10318. return detail::is_multipart_boundary_chars_valid(boundary);
  10319. }
  10320. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10321. : boundary_(detail::make_multipart_data_boundary()) {}
  10322. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10323. : boundary_(std::move(boundary)) {}
  10324. inline const std::string &MultipartFormDataWriter::boundary() const {
  10325. return boundary_;
  10326. }
  10327. inline std::string MultipartFormDataWriter::content_type() const {
  10328. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10329. }
  10330. inline std::string
  10331. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10332. return detail::serialize_multipart_formdata(items, boundary_);
  10333. }
  10334. inline size_t MultipartFormDataWriter::content_length(
  10335. const UploadFormDataItems &items) const {
  10336. return detail::get_multipart_content_length(items, boundary_);
  10337. }
  10338. inline std::string
  10339. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10340. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10341. }
  10342. inline std::string MultipartFormDataWriter::item_end() {
  10343. return detail::serialize_multipart_formdata_item_end();
  10344. }
  10345. inline std::string MultipartFormDataWriter::finish() const {
  10346. return detail::serialize_multipart_formdata_finish(boundary_);
  10347. }
  10348. // Response implementation
  10349. namespace detail {
  10350. // A response has one content source: `body`, a content provider, or a file.
  10351. // Each content setter calls this so that the one called last wins.
  10352. inline void clear_content_provider(Response &res) {
  10353. auto releaser = std::move(res.content_provider_resource_releaser_);
  10354. auto success = res.content_provider_success_;
  10355. res.content_length_ = 0;
  10356. res.content_provider_ = nullptr;
  10357. res.content_provider_resource_releaser_ = nullptr;
  10358. res.is_chunked_content_provider_ = false;
  10359. res.is_file_content_provider_ = false;
  10360. res.content_provider_success_ = false;
  10361. res.content_coding_ = EncodingType::None;
  10362. res.file_content_path_.clear();
  10363. res.file_content_content_type_.clear();
  10364. if (releaser) { releaser(success); }
  10365. }
  10366. inline void clear_content(Response &res) {
  10367. res.body.clear();
  10368. clear_content_provider(res);
  10369. }
  10370. // The Content-Type of the old content goes with it.
  10371. inline void set_content_type(Response &res, const std::string &content_type) {
  10372. res.headers.erase("Content-Type");
  10373. res.set_header("Content-Type", content_type);
  10374. }
  10375. // `body` is public, so it can be assigned directly after a provider or a file
  10376. // was set. It came last, so it wins.
  10377. inline void prefer_assigned_body(Response &res) {
  10378. if (!res.body.empty() &&
  10379. (res.content_provider_ || !res.file_content_path_.empty())) {
  10380. clear_content_provider(res);
  10381. }
  10382. }
  10383. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10384. inline bool body_allowed_for_status(int status) {
  10385. return status >= 200 && status != StatusCode::NoContent_204 &&
  10386. status != StatusCode::NotModified_304;
  10387. }
  10388. // Only a 206 response is served as a partial representation. range_error()
  10389. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10390. // status would start from an unchecked offset.
  10391. inline bool is_partial_content(const Request &req, const Response &res) {
  10392. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10393. }
  10394. // Sets the Content-Length or Transfer-Encoding framing the body that
  10395. // Server::write_response_core() writes, or closes the connection after a body
  10396. // that has neither. Only the library sets them: one from a handler would go
  10397. // out next to it, or describe some other body.
  10398. inline void set_framing_headers(const Request &req, Response &res,
  10399. const std::string &boundary,
  10400. const std::string &content_type) {
  10401. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10402. auto head_length = req.method == "HEAD"
  10403. ? res.get_header_value("Content-Length")
  10404. : std::string();
  10405. res.headers.erase("Content-Length");
  10406. res.headers.erase("Transfer-Encoding");
  10407. if (!body_allowed_for_status(res.status)) { return; }
  10408. if (res.content_provider_) {
  10409. if (res.content_length_ == 0) {
  10410. if (res.is_chunked_content_provider_) {
  10411. res.set_header("Transfer-Encoding", "chunked");
  10412. } else if (req.method != "HEAD") {
  10413. // RFC 9112 6.3: a body with neither ends where the connection does.
  10414. res.headers.erase("Keep-Alive");
  10415. if (!has_header_token(res.headers, "Connection", "close")) {
  10416. res.set_header("Connection", "close");
  10417. }
  10418. }
  10419. return;
  10420. }
  10421. // The part Server::write_content_with_provider() writes.
  10422. auto length = res.content_length_;
  10423. if (is_partial_content(req, res)) {
  10424. length = req.ranges.size() == 1
  10425. ? get_range_offset_and_length(req.ranges[0], length).second
  10426. : get_multipart_ranges_data_length(req, boundary,
  10427. content_type, length);
  10428. }
  10429. res.set_header("Content-Length", std::to_string(length));
  10430. } else if (!res.body.empty()) {
  10431. res.set_header("Content-Length", std::to_string(res.body.size()));
  10432. } else {
  10433. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10434. }
  10435. }
  10436. } // namespace detail
  10437. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10438. size_t id) const {
  10439. return detail::get_header_value_u64(headers, key, def, id);
  10440. }
  10441. inline bool Response::has_header(const std::string &key) const {
  10442. return headers.find(key) != headers.end();
  10443. }
  10444. inline std::string Response::get_header_value(const std::string &key,
  10445. const char *def,
  10446. size_t id) const {
  10447. return detail::get_header_value(headers, key, def, id);
  10448. }
  10449. inline size_t Response::get_header_value_count(const std::string &key) const {
  10450. return detail::get_header_value_count(headers, key);
  10451. }
  10452. inline void Response::set_header(const std::string &key,
  10453. const std::string &val) {
  10454. detail::set_header(headers, key, val);
  10455. }
  10456. inline bool Response::has_trailer(const std::string &key) const {
  10457. return trailers.find(key) != trailers.end();
  10458. }
  10459. inline std::string Response::get_trailer_value(const std::string &key,
  10460. size_t id) const {
  10461. return detail::get_multimap_value(trailers, key, id);
  10462. }
  10463. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10464. return trailers.count(key);
  10465. }
  10466. inline void Response::set_redirect(const std::string &url, int stat) {
  10467. if (detail::fields::is_field_value(url)) {
  10468. set_header("Location", url);
  10469. if (300 <= stat && stat < 400) {
  10470. this->status = stat;
  10471. } else {
  10472. this->status = StatusCode::Found_302;
  10473. }
  10474. }
  10475. }
  10476. inline void Response::set_content(const char *s, size_t n,
  10477. const std::string &content_type) {
  10478. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10479. detail::clear_content_provider(*this);
  10480. detail::set_content_type(*this, content_type);
  10481. }
  10482. inline void Response::set_content(const std::string &s,
  10483. const std::string &content_type) {
  10484. set_content(s.data(), s.size(), content_type);
  10485. }
  10486. inline void Response::set_content(std::string &&s,
  10487. const std::string &content_type) {
  10488. body = std::move(s);
  10489. detail::clear_content_provider(*this);
  10490. detail::set_content_type(*this, content_type);
  10491. }
  10492. inline void Response::set_content_provider(
  10493. size_t in_length, const std::string &content_type, ContentProvider provider,
  10494. ContentProviderResourceReleaser resource_releaser) {
  10495. detail::clear_content(*this);
  10496. detail::set_content_type(*this, content_type);
  10497. content_length_ = in_length;
  10498. if (in_length > 0) { content_provider_ = std::move(provider); }
  10499. content_provider_resource_releaser_ = std::move(resource_releaser);
  10500. }
  10501. inline void Response::set_content_provider(
  10502. const std::string &content_type, ContentProviderWithoutLength provider,
  10503. ContentProviderResourceReleaser resource_releaser) {
  10504. detail::clear_content(*this);
  10505. detail::set_content_type(*this, content_type);
  10506. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10507. content_provider_resource_releaser_ = std::move(resource_releaser);
  10508. }
  10509. inline void Response::set_chunked_content_provider(
  10510. const std::string &content_type, ContentProviderWithoutLength provider,
  10511. ContentProviderResourceReleaser resource_releaser) {
  10512. set_content_provider(content_type, std::move(provider),
  10513. std::move(resource_releaser));
  10514. is_chunked_content_provider_ = true;
  10515. }
  10516. inline void Response::set_file_content(const std::string &path,
  10517. const std::string &content_type) {
  10518. detail::clear_content(*this);
  10519. headers.erase("Content-Type");
  10520. file_content_path_ = path;
  10521. file_content_content_type_ = content_type;
  10522. }
  10523. inline void Response::set_file_content(const std::string &path) {
  10524. set_file_content(path, std::string());
  10525. }
  10526. // Result implementation
  10527. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10528. size_t def,
  10529. size_t id) const {
  10530. return detail::get_header_value_u64(request_headers_, key, def, id);
  10531. }
  10532. inline bool Result::has_request_header(const std::string &key) const {
  10533. return request_headers_.find(key) != request_headers_.end();
  10534. }
  10535. inline std::string Result::get_request_header_value(const std::string &key,
  10536. const char *def,
  10537. size_t id) const {
  10538. return detail::get_header_value(request_headers_, key, def, id);
  10539. }
  10540. inline size_t
  10541. Result::get_request_header_value_count(const std::string &key) const {
  10542. return request_headers_.count(key);
  10543. }
  10544. // Stream implementation
  10545. inline ssize_t Stream::write(const char *ptr) {
  10546. return write(ptr, strlen(ptr));
  10547. }
  10548. inline ssize_t Stream::write(const std::string &s) {
  10549. return write(s.data(), s.size());
  10550. }
  10551. // BodyReader implementation
  10552. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10553. if (!stream) {
  10554. last_error = Error::Connection;
  10555. return -1;
  10556. }
  10557. if (eof) { return 0; }
  10558. if (!chunked) {
  10559. // Content-Length based reading
  10560. if (has_content_length && bytes_read >= content_length) {
  10561. eof = true;
  10562. return 0;
  10563. }
  10564. auto to_read = len;
  10565. if (has_content_length) {
  10566. auto remaining = content_length - bytes_read;
  10567. to_read = (std::min)(len, remaining);
  10568. }
  10569. auto n = stream->read(buf, to_read);
  10570. // Without Content-Length the body ends when the connection closes
  10571. // (RFC 9112 §6.3); with one, an EOF here came too early
  10572. if (n < 0 || (n == 0 && has_content_length)) {
  10573. last_error = stream->get_error();
  10574. if (last_error == Error::Success) { last_error = Error::Read; }
  10575. }
  10576. if (n <= 0) {
  10577. eof = true;
  10578. return n;
  10579. }
  10580. bytes_read += static_cast<size_t>(n);
  10581. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10582. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10583. last_error = Error::ExceedMaxPayloadSize;
  10584. eof = true;
  10585. return -1;
  10586. }
  10587. return n;
  10588. }
  10589. // Chunked transfer encoding: delegate to shared decoder instance.
  10590. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10591. size_t chunk_offset = 0;
  10592. size_t chunk_total = 0;
  10593. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10594. if (n < 0) {
  10595. last_error = stream->get_error();
  10596. if (last_error == Error::Success) { last_error = Error::Read; }
  10597. eof = true;
  10598. return n;
  10599. }
  10600. if (n == 0) {
  10601. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10602. eof = true;
  10603. return 0;
  10604. }
  10605. bytes_read += static_cast<size_t>(n);
  10606. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10607. last_error = Error::ExceedMaxPayloadSize;
  10608. eof = true;
  10609. return -1;
  10610. }
  10611. return n;
  10612. }
  10613. // ThreadPool implementation
  10614. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10615. time_t idle_timeout_sec)
  10616. : base_thread_count_(n), max_queued_requests_(mqr),
  10617. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10618. shutdown_(false) {
  10619. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10620. if (max_n != 0 && max_n < n) {
  10621. std::string msg = "max_threads must be >= base_threads";
  10622. throw std::invalid_argument(msg);
  10623. }
  10624. #endif
  10625. max_thread_count_ = max_n == 0 ? n : max_n;
  10626. threads_.reserve(base_thread_count_);
  10627. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10628. try {
  10629. #endif
  10630. for (size_t i = 0; i < base_thread_count_; i++) {
  10631. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10632. }
  10633. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10634. } catch (...) {
  10635. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10636. // signal the workers we already spawned to exit and join them so the
  10637. // vector destructor does not see joinable threads (which would call
  10638. // std::terminate). Then rethrow so the caller learns of the failure.
  10639. {
  10640. std::unique_lock<std::mutex> lock(mutex_);
  10641. shutdown_ = true;
  10642. }
  10643. cond_.notify_all();
  10644. for (auto &t : threads_) {
  10645. if (t.joinable()) { t.join(); }
  10646. }
  10647. throw;
  10648. }
  10649. #endif
  10650. }
  10651. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10652. {
  10653. std::unique_lock<std::mutex> lock(mutex_);
  10654. if (shutdown_) { return false; }
  10655. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10656. return false;
  10657. }
  10658. jobs_.push_back(std::move(fn));
  10659. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10660. if (jobs_.size() > idle_thread_count_ &&
  10661. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10662. cleanup_finished_threads();
  10663. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10664. }
  10665. }
  10666. cond_.notify_one();
  10667. return true;
  10668. }
  10669. inline void ThreadPool::shutdown() {
  10670. {
  10671. std::unique_lock<std::mutex> lock(mutex_);
  10672. shutdown_ = true;
  10673. }
  10674. cond_.notify_all();
  10675. for (auto &t : threads_) {
  10676. if (t.joinable()) { t.join(); }
  10677. }
  10678. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10679. // with worker threads that call move_to_finished() concurrently.
  10680. std::list<std::thread> remaining_dynamic;
  10681. {
  10682. std::unique_lock<std::mutex> lock(mutex_);
  10683. remaining_dynamic = std::move(dynamic_threads_);
  10684. }
  10685. for (auto &t : remaining_dynamic) {
  10686. if (t.joinable()) { t.join(); }
  10687. }
  10688. std::unique_lock<std::mutex> lock(mutex_);
  10689. cleanup_finished_threads();
  10690. }
  10691. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10692. // Must be called with mutex_ held
  10693. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10694. if (it->get_id() == id) {
  10695. finished_threads_.push_back(std::move(*it));
  10696. dynamic_threads_.erase(it);
  10697. return;
  10698. }
  10699. }
  10700. }
  10701. inline void ThreadPool::cleanup_finished_threads() {
  10702. // Must be called with mutex_ held
  10703. for (auto &t : finished_threads_) {
  10704. if (t.joinable()) { t.join(); }
  10705. }
  10706. finished_threads_.clear();
  10707. }
  10708. inline void ThreadPool::worker(bool is_dynamic) {
  10709. for (;;) {
  10710. std::function<void()> fn;
  10711. {
  10712. std::unique_lock<std::mutex> lock(mutex_);
  10713. idle_thread_count_++;
  10714. if (is_dynamic) {
  10715. auto has_work =
  10716. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10717. [&] { return !jobs_.empty() || shutdown_; });
  10718. if (!has_work) {
  10719. // Timed out with no work - exit this dynamic thread
  10720. idle_thread_count_--;
  10721. move_to_finished(std::this_thread::get_id());
  10722. break;
  10723. }
  10724. } else {
  10725. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10726. }
  10727. idle_thread_count_--;
  10728. if (shutdown_ && jobs_.empty()) { break; }
  10729. fn = std::move(jobs_.front());
  10730. jobs_.pop_front();
  10731. }
  10732. assert(true == static_cast<bool>(fn));
  10733. fn();
  10734. }
  10735. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10736. !defined(LIBRESSL_VERSION_NUMBER)
  10737. OPENSSL_thread_stop();
  10738. #endif
  10739. }
  10740. /*
  10741. * Group 1 (continued): detail namespace - Stream implementations
  10742. */
  10743. namespace detail {
  10744. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10745. time_t timeout_sec, time_t timeout_usec,
  10746. time_t &actual_timeout_sec,
  10747. time_t &actual_timeout_usec) {
  10748. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10749. auto actual_timeout_msec =
  10750. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10751. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10752. actual_timeout_sec = actual_timeout_msec / 1000;
  10753. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10754. }
  10755. // Socket stream implementation
  10756. inline SocketStream::SocketStream(
  10757. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10758. time_t write_timeout_sec, time_t write_timeout_usec,
  10759. time_t max_timeout_msec,
  10760. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10761. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10762. read_timeout_usec_(read_timeout_usec),
  10763. write_timeout_sec_(write_timeout_sec),
  10764. write_timeout_usec_(write_timeout_usec),
  10765. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10766. read_buff_(read_buff_size_, 0) {}
  10767. inline SocketStream::~SocketStream() = default;
  10768. inline bool SocketStream::is_readable() const {
  10769. return read_buff_off_ < read_buff_content_size_;
  10770. }
  10771. inline bool SocketStream::wait_readable() const {
  10772. if (max_timeout_msec_ <= 0) {
  10773. return select_read_interruptible(sock_, read_timeout_sec_,
  10774. read_timeout_usec_, read_interrupted_) > 0;
  10775. }
  10776. time_t read_timeout_sec;
  10777. time_t read_timeout_usec;
  10778. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10779. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10780. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  10781. read_interrupted_) > 0;
  10782. }
  10783. inline bool SocketStream::wait_writable() const {
  10784. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10785. }
  10786. inline bool SocketStream::ensure_readable() {
  10787. if (readable_hint_) {
  10788. readable_hint_ = false;
  10789. return true;
  10790. }
  10791. return wait_readable();
  10792. }
  10793. inline const char *SocketStream::buffered_data(size_t &size) const {
  10794. size = read_buff_content_size_ - read_buff_off_;
  10795. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10796. }
  10797. inline void SocketStream::consume_buffered(size_t size) {
  10798. assert(size <= read_buff_content_size_ - read_buff_off_);
  10799. read_buff_off_ += size;
  10800. }
  10801. inline bool SocketStream::is_peer_alive() const {
  10802. return detail::is_socket_alive(sock_);
  10803. }
  10804. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10805. #ifdef _WIN32
  10806. size =
  10807. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10808. #else
  10809. size = (std::min)(size,
  10810. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10811. #endif
  10812. if (read_buff_off_ < read_buff_content_size_) {
  10813. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10814. if (size <= remaining_size) {
  10815. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10816. read_buff_off_ += size;
  10817. return static_cast<ssize_t>(size);
  10818. } else {
  10819. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10820. read_buff_off_ += remaining_size;
  10821. return static_cast<ssize_t>(remaining_size);
  10822. }
  10823. }
  10824. if (!ensure_readable()) {
  10825. error_ = Error::Timeout;
  10826. return -1;
  10827. }
  10828. read_buff_off_ = 0;
  10829. read_buff_content_size_ = 0;
  10830. if (size < read_buff_size_) {
  10831. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10832. CPPHTTPLIB_RECV_FLAGS);
  10833. if (n <= 0) {
  10834. if (n == 0) {
  10835. error_ = Error::ConnectionClosed;
  10836. } else {
  10837. error_ = Error::Read;
  10838. }
  10839. return n;
  10840. } else if (n <= static_cast<ssize_t>(size)) {
  10841. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10842. return n;
  10843. } else {
  10844. memcpy(ptr, read_buff_.data(), size);
  10845. read_buff_off_ = size;
  10846. read_buff_content_size_ = static_cast<size_t>(n);
  10847. return static_cast<ssize_t>(size);
  10848. }
  10849. } else {
  10850. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10851. if (n <= 0) {
  10852. if (n == 0) {
  10853. error_ = Error::ConnectionClosed;
  10854. } else {
  10855. error_ = Error::Read;
  10856. }
  10857. }
  10858. return n;
  10859. }
  10860. }
  10861. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10862. if (!wait_writable()) { return -1; }
  10863. #if defined(_WIN32) && !defined(_WIN64)
  10864. size =
  10865. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10866. #endif
  10867. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10868. }
  10869. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10870. int &port) const {
  10871. return detail::get_remote_ip_and_port(sock_, ip, port);
  10872. }
  10873. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10874. int &port) const {
  10875. return detail::get_local_ip_and_port(sock_, ip, port);
  10876. }
  10877. inline socket_t SocketStream::socket() const { return sock_; }
  10878. inline time_t SocketStream::duration() const {
  10879. return static_cast<time_t>(
  10880. std::chrono::duration_cast<std::chrono::milliseconds>(
  10881. std::chrono::steady_clock::now() - start_time_)
  10882. .count());
  10883. }
  10884. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10885. read_timeout_sec_ = sec;
  10886. read_timeout_usec_ = usec;
  10887. }
  10888. inline void SocketStream::set_max_timeout(time_t msec) {
  10889. max_timeout_msec_ = msec;
  10890. start_time_ = std::chrono::steady_clock::now();
  10891. }
  10892. inline void
  10893. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  10894. read_interrupted_ = std::move(interrupted);
  10895. }
  10896. // Buffer stream implementation
  10897. inline bool BufferStream::is_readable() const { return true; }
  10898. inline bool BufferStream::wait_readable() const { return true; }
  10899. inline bool BufferStream::wait_writable() const { return true; }
  10900. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10901. #if defined(_MSC_VER) && _MSC_VER < 1910
  10902. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10903. #else
  10904. auto len_read = buffer.copy(ptr, size, position);
  10905. #endif
  10906. position += static_cast<size_t>(len_read);
  10907. return static_cast<ssize_t>(len_read);
  10908. }
  10909. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10910. buffer.append(ptr, size);
  10911. return static_cast<ssize_t>(size);
  10912. }
  10913. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10914. int & /*port*/) const {}
  10915. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10916. int & /*port*/) const {}
  10917. inline socket_t BufferStream::socket() const { return 0; }
  10918. inline time_t BufferStream::duration() const { return 0; }
  10919. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10920. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10921. : MatcherBase(pattern) {
  10922. constexpr const char marker[] = "/:";
  10923. // One past the last ending position of a path param substring
  10924. std::size_t last_param_end = 0;
  10925. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10926. // Needed to ensure that parameter names are unique during matcher
  10927. // construction
  10928. // If exceptions are disabled, only last duplicate path
  10929. // parameter will be set
  10930. std::unordered_set<std::string> param_name_set;
  10931. #endif
  10932. while (true) {
  10933. const auto marker_pos = pattern.find(
  10934. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10935. if (marker_pos == std::string::npos) { break; }
  10936. static_fragments_.push_back(
  10937. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10938. const auto param_name_start = marker_pos + str_len(marker);
  10939. auto sep_pos = pattern.find(separator, param_name_start);
  10940. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10941. auto param_name =
  10942. pattern.substr(param_name_start, sep_pos - param_name_start);
  10943. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10944. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10945. std::string msg = "Encountered path parameter '" + param_name +
  10946. "' multiple times in route pattern '" + pattern + "'.";
  10947. throw std::invalid_argument(msg);
  10948. }
  10949. #endif
  10950. param_names_.push_back(std::move(param_name));
  10951. last_param_end = sep_pos + 1;
  10952. }
  10953. if (last_param_end < pattern.length()) {
  10954. static_fragments_.push_back(pattern.substr(last_param_end));
  10955. }
  10956. }
  10957. inline bool PathParamsMatcher::match(Request &request) const {
  10958. request.matches = std::smatch();
  10959. request.path_params.clear();
  10960. // A pattern without parameters is just a literal path to compare against
  10961. if (param_names_.empty()) { return request.path == pattern(); }
  10962. request.path_params.reserve(param_names_.size());
  10963. // One past the position at which the path matched the pattern last time
  10964. std::size_t starting_pos = 0;
  10965. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10966. const auto &fragment = static_fragments_[i];
  10967. if (starting_pos + fragment.length() > request.path.length()) {
  10968. return false;
  10969. }
  10970. // Avoid unnecessary allocation by using strncmp instead of substr +
  10971. // comparison
  10972. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10973. fragment.length()) != 0) {
  10974. return false;
  10975. }
  10976. starting_pos += fragment.length();
  10977. // Should only happen when we have a static fragment after a param
  10978. // Example: '/users/:id/subscriptions'
  10979. // The 'subscriptions' fragment here does not have a corresponding param
  10980. if (i >= param_names_.size()) { continue; }
  10981. auto sep_pos = request.path.find(separator, starting_pos);
  10982. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10983. const auto &param_name = param_names_[i];
  10984. request.path_params.emplace(
  10985. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10986. // Mark everything up to '/' as matched
  10987. starting_pos = sep_pos + 1;
  10988. }
  10989. // Returns false if the path is longer than the pattern
  10990. return starting_pos >= request.path.length();
  10991. }
  10992. inline bool RegexMatcher::match(Request &request) const {
  10993. request.path_params.clear();
  10994. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10995. // a non-match rather than risking a stack overflow in std::regex_match.
  10996. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10997. return false;
  10998. }
  10999. return std::regex_match(request.path, request.matches, regex_);
  11000. }
  11001. // Enclose IPv6 address in brackets if needed
  11002. inline std::string prepare_host_string(const std::string &host) {
  11003. // Enclose IPv6 address in brackets (but not if already enclosed)
  11004. if (host.find(':') == std::string::npos ||
  11005. (!host.empty() && host[0] == '[')) {
  11006. // IPv4, hostname, or already bracketed IPv6
  11007. return host;
  11008. } else {
  11009. // IPv6 address without brackets
  11010. return "[" + host + "]";
  11011. }
  11012. }
  11013. inline std::string make_host_and_port_string(const std::string &host, int port,
  11014. bool is_ssl) {
  11015. auto result = prepare_host_string(host);
  11016. // Append port if not default
  11017. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  11018. ; // do nothing
  11019. } else {
  11020. result += ":" + std::to_string(port);
  11021. }
  11022. return result;
  11023. }
  11024. // Create "host:port" string always including port number (for CONNECT method)
  11025. inline std::string
  11026. make_host_and_port_string_always_port(const std::string &host, int port) {
  11027. return prepare_host_string(host) + ":" + std::to_string(port);
  11028. }
  11029. // Value for the Host header a client sends when the caller supplied none.
  11030. // Only the value: callers decide where in their header list it goes.
  11031. inline std::string make_default_host_header_value(const std::string &host,
  11032. int port, bool is_ssl,
  11033. int address_family) {
  11034. if (address_family == AF_UNIX) { return "localhost"; }
  11035. return make_host_and_port_string(host, port, is_ssl);
  11036. }
  11037. inline void add_default_user_agent_header(Request &req) {
  11038. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  11039. if (!req.has_header("User-Agent")) {
  11040. req.set_header("User-Agent",
  11041. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  11042. }
  11043. #else
  11044. (void)req;
  11045. #endif
  11046. }
  11047. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  11048. NormalizedTarget normalize_target(const std::string &host);
  11049. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  11050. bool host_matches_no_proxy(const NormalizedTarget &target,
  11051. const std::vector<NoProxyEntry> &entries);
  11052. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  11053. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  11054. if (prefix_bits == 0) { return true; }
  11055. int full_bytes = prefix_bits / 8;
  11056. int rem_bits = prefix_bits % 8;
  11057. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  11058. static_cast<size_t>(full_bytes)) != 0) {
  11059. return false;
  11060. }
  11061. if (rem_bits == 0) { return true; }
  11062. auto i = static_cast<size_t>(full_bytes);
  11063. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11064. return (ip[i] & mask) == (net[i] & mask);
  11065. }
  11066. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11067. if (token.empty()) { return false; }
  11068. if (token == "*") {
  11069. out.kind = NoProxyKind::Wildcard;
  11070. return true;
  11071. }
  11072. auto slash = token.find('/');
  11073. std::string addr_part =
  11074. (slash == std::string::npos) ? token : token.substr(0, slash);
  11075. std::string prefix_part =
  11076. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11077. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11078. // don't silently treat it as a /32 (or /128).
  11079. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11080. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11081. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11082. // when brackets are present.
  11083. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11084. addr_part.back() == ']';
  11085. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11086. if (!bracketed) {
  11087. struct in_addr v4;
  11088. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11089. int prefix = 32;
  11090. if (!prefix_part.empty() &&
  11091. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11092. prefix)) {
  11093. return false;
  11094. }
  11095. out.kind = NoProxyKind::IPv4Cidr;
  11096. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11097. out.prefix_bits = prefix;
  11098. return true;
  11099. }
  11100. }
  11101. struct in6_addr v6;
  11102. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11103. int prefix = 128;
  11104. if (!prefix_part.empty() &&
  11105. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11106. prefix)) {
  11107. return false;
  11108. }
  11109. out.kind = NoProxyKind::IPv6Cidr;
  11110. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11111. out.prefix_bits = prefix;
  11112. return true;
  11113. }
  11114. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11115. // the entry is malformed — don't fall through to the hostname branch.
  11116. if (bracketed) { return false; }
  11117. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11118. if (slash != std::string::npos) { return false; }
  11119. // Port-specific entries (host:port) are not supported.
  11120. if (token.find(':') != std::string::npos) { return false; }
  11121. std::string hostname = case_ignore::to_lower(token);
  11122. while (!hostname.empty() && hostname.front() == '.') {
  11123. hostname.erase(hostname.begin());
  11124. }
  11125. while (!hostname.empty() && hostname.back() == '.') {
  11126. hostname.pop_back();
  11127. }
  11128. if (hostname.empty()) { return false; }
  11129. out.kind = NoProxyKind::HostnameSuffix;
  11130. out.hostname_pattern = std::move(hostname);
  11131. return true;
  11132. }
  11133. inline std::vector<NoProxyEntry>
  11134. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11135. std::vector<NoProxyEntry> entries;
  11136. entries.reserve(patterns.size());
  11137. for (const auto &p : patterns) {
  11138. auto trimmed = trim_copy(p);
  11139. if (trimmed.empty()) { continue; }
  11140. NoProxyEntry entry;
  11141. if (parse_no_proxy_entry(trimmed, entry)) {
  11142. entries.push_back(std::move(entry));
  11143. }
  11144. }
  11145. return entries;
  11146. }
  11147. inline NormalizedTarget normalize_target(const std::string &host) {
  11148. NormalizedTarget t;
  11149. std::string h = host;
  11150. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11151. h = h.substr(1, h.size() - 2);
  11152. }
  11153. // Strip a single trailing dot so "example.com." canonicalizes to
  11154. // "example.com".
  11155. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11156. t.hostname = case_ignore::to_lower(h);
  11157. if (!t.hostname.empty()) {
  11158. struct in_addr v4;
  11159. struct in6_addr v6;
  11160. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11161. t.is_ipv4 = true;
  11162. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11163. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11164. t.is_ipv6 = true;
  11165. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11166. }
  11167. }
  11168. return t;
  11169. }
  11170. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11171. const std::vector<NoProxyEntry> &entries) {
  11172. if (target.hostname.empty()) { return false; }
  11173. for (const auto &e : entries) {
  11174. switch (e.kind) {
  11175. case NoProxyKind::Wildcard: return true;
  11176. case NoProxyKind::IPv4Cidr:
  11177. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11178. return true;
  11179. }
  11180. break;
  11181. case NoProxyKind::IPv6Cidr:
  11182. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11183. return true;
  11184. }
  11185. break;
  11186. case NoProxyKind::HostnameSuffix:
  11187. if (target.is_ipv4 || target.is_ipv6) { break; }
  11188. if (target.hostname == e.hostname_pattern) { return true; }
  11189. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11190. // an entry of "example.com".
  11191. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11192. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11193. if (target.hostname[offset - 1] == '.' &&
  11194. target.hostname.compare(offset, e.hostname_pattern.size(),
  11195. e.hostname_pattern) == 0) {
  11196. return true;
  11197. }
  11198. }
  11199. break;
  11200. }
  11201. }
  11202. return false;
  11203. }
  11204. template <typename T>
  11205. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11206. T header_writer, Error &error) {
  11207. for (const auto &h : headers) {
  11208. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11209. error = Error::InvalidHeaders;
  11210. return false;
  11211. }
  11212. }
  11213. if (header_writer(strm, headers) <= 0) {
  11214. error = Error::Write;
  11215. return false;
  11216. }
  11217. return true;
  11218. }
  11219. } // namespace detail
  11220. /*
  11221. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11222. */
  11223. #ifdef CPPHTTPLIB_SSL_ENABLED
  11224. namespace detail {
  11225. // SSL socket stream implementation
  11226. inline SSLSocketStream::SSLSocketStream(
  11227. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11228. time_t read_timeout_usec, time_t write_timeout_sec,
  11229. time_t write_timeout_usec, time_t max_timeout_msec,
  11230. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11231. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11232. read_timeout_usec_(read_timeout_usec),
  11233. write_timeout_sec_(write_timeout_sec),
  11234. write_timeout_usec_(write_timeout_usec),
  11235. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11236. tls_error_.code = tls::ErrorCode::Success;
  11237. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11238. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11239. // Note: create_session() also clears this, but SSLClient currently
  11240. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11241. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11242. // SSL session was created.
  11243. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11244. #endif
  11245. }
  11246. inline SSLSocketStream::~SSLSocketStream() = default;
  11247. inline bool SSLSocketStream::is_readable() const {
  11248. return tls::pending(session_) > 0;
  11249. }
  11250. inline bool SSLSocketStream::wait_readable() const {
  11251. if (max_timeout_msec_ <= 0) {
  11252. return select_read_interruptible(sock_, read_timeout_sec_,
  11253. read_timeout_usec_, read_interrupted_) > 0;
  11254. }
  11255. time_t read_timeout_sec;
  11256. time_t read_timeout_usec;
  11257. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11258. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11259. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11260. read_interrupted_) > 0;
  11261. }
  11262. inline bool SSLSocketStream::wait_writable() const {
  11263. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11264. !tls::is_peer_closed(session_, sock_);
  11265. }
  11266. inline bool SSLSocketStream::ensure_readable() {
  11267. if (readable_hint_) {
  11268. readable_hint_ = false;
  11269. return true;
  11270. }
  11271. return wait_readable();
  11272. }
  11273. inline bool SSLSocketStream::is_peer_alive() const {
  11274. return !tls::is_peer_closed(session_, sock_);
  11275. }
  11276. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11277. if (tls::pending(session_) > 0) {
  11278. tls::TlsError err;
  11279. auto ret = tls::read(session_, ptr, size, err);
  11280. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11281. error_ = Error::ConnectionClosed;
  11282. } else if (ret < 0) {
  11283. tls_error_ = err;
  11284. }
  11285. return ret;
  11286. } else if (ensure_readable()) {
  11287. tls::TlsError err;
  11288. auto ret = tls::read(session_, ptr, size, err);
  11289. if (ret < 0) {
  11290. auto n = 1000;
  11291. #ifdef _WIN32
  11292. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11293. (err.code == tls::ErrorCode::SyscallError &&
  11294. WSAGetLastError() == WSAETIMEDOUT))) {
  11295. #else
  11296. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11297. #endif
  11298. if (tls::pending(session_) > 0) {
  11299. ret = tls::read(session_, ptr, size, err);
  11300. if (ret >= 0) { return ret; }
  11301. break;
  11302. } else if (wait_readable()) {
  11303. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11304. ret = tls::read(session_, ptr, size, err);
  11305. if (ret >= 0) { return ret; }
  11306. } else {
  11307. break;
  11308. }
  11309. }
  11310. assert(ret < 0);
  11311. tls_error_ = err;
  11312. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11313. error_ = Error::ConnectionClosed;
  11314. }
  11315. return ret;
  11316. } else {
  11317. error_ = Error::Timeout;
  11318. return -1;
  11319. }
  11320. }
  11321. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11322. if (wait_writable()) {
  11323. auto handle_size =
  11324. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11325. tls::TlsError err;
  11326. auto ret = tls::write(session_, ptr, handle_size, err);
  11327. if (ret < 0) {
  11328. auto n = 1000;
  11329. #ifdef _WIN32
  11330. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11331. (err.code == tls::ErrorCode::SyscallError &&
  11332. WSAGetLastError() == WSAETIMEDOUT))) {
  11333. #else
  11334. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11335. #endif
  11336. if (wait_writable()) {
  11337. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11338. ret = tls::write(session_, ptr, handle_size, err);
  11339. if (ret >= 0) { return ret; }
  11340. } else {
  11341. break;
  11342. }
  11343. }
  11344. assert(ret < 0);
  11345. tls_error_ = err;
  11346. }
  11347. return ret;
  11348. }
  11349. return -1;
  11350. }
  11351. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11352. int &port) const {
  11353. detail::get_remote_ip_and_port(sock_, ip, port);
  11354. }
  11355. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11356. int &port) const {
  11357. detail::get_local_ip_and_port(sock_, ip, port);
  11358. }
  11359. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11360. inline time_t SSLSocketStream::duration() const {
  11361. return static_cast<time_t>(
  11362. std::chrono::duration_cast<std::chrono::milliseconds>(
  11363. std::chrono::steady_clock::now() - start_time_)
  11364. .count());
  11365. }
  11366. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11367. read_timeout_sec_ = sec;
  11368. read_timeout_usec_ = usec;
  11369. }
  11370. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11371. max_timeout_msec_ = msec;
  11372. start_time_ = std::chrono::steady_clock::now();
  11373. }
  11374. inline void
  11375. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11376. read_interrupted_ = std::move(interrupted);
  11377. }
  11378. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11379. tls::session_t session,
  11380. time_t read_timeout_sec,
  11381. time_t read_timeout_usec,
  11382. time_t write_timeout_sec,
  11383. time_t write_timeout_usec)
  11384. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11385. read_timeout_usec_(read_timeout_usec),
  11386. write_timeout_sec_(write_timeout_sec),
  11387. write_timeout_usec_(write_timeout_usec),
  11388. start_time_(std::chrono::steady_clock::now()) {
  11389. // The receive and send paths run on different threads, so each TLS call is
  11390. // driven in non-blocking mode and readiness is awaited with select()
  11391. // outside the session lock. Set the socket non-blocking once here; it is
  11392. // never flipped back, so no thread races on the flag.
  11393. detail::set_nonblocking(sock_, true);
  11394. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11395. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11396. #endif
  11397. }
  11398. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11399. inline bool WebSocketSSLStream::is_readable() const {
  11400. std::lock_guard<std::mutex> guard(session_mutex_);
  11401. return tls::pending(session_) > 0;
  11402. }
  11403. inline bool WebSocketSSLStream::wait_readable() const {
  11404. return select_read_interruptible(sock_, read_timeout_sec_, read_timeout_usec_,
  11405. read_interrupted_) > 0;
  11406. }
  11407. inline bool WebSocketSSLStream::wait_writable() const {
  11408. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11409. // that probe toggles the socket's blocking flag, which would race with the
  11410. // concurrent reader on a permanently non-blocking socket.
  11411. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11412. }
  11413. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11414. tls::TlsError err;
  11415. auto n = 1000;
  11416. while (--n >= 0) {
  11417. {
  11418. std::lock_guard<std::mutex> guard(session_mutex_);
  11419. auto ret = tls::read(session_, ptr, size, err);
  11420. if (ret > 0) { return ret; }
  11421. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11422. error_ = Error::ConnectionClosed;
  11423. return ret;
  11424. }
  11425. }
  11426. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11427. // direction: the send path shares this session, so output it left pending
  11428. // has to be flushed before more input can be decrypted. Anything else is
  11429. // a hard error.
  11430. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11431. #ifdef _WIN32
  11432. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11433. needs_readable =
  11434. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11435. WSAGetLastError() == WSAETIMEDOUT);
  11436. #endif
  11437. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11438. error_ = Error::Read;
  11439. return -1;
  11440. }
  11441. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11442. error_ = Error::Timeout;
  11443. return -1;
  11444. }
  11445. }
  11446. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11447. // to tell a timeout from a close would otherwise see whatever the previous
  11448. // failure left behind (error_ is never cleared on success).
  11449. error_ = Error::Read;
  11450. return -1;
  11451. }
  11452. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11453. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11454. tls::TlsError err;
  11455. auto n = 1000;
  11456. while (--n >= 0) {
  11457. {
  11458. std::lock_guard<std::mutex> guard(session_mutex_);
  11459. auto ret = tls::write(session_, ptr, handle_size, err);
  11460. if (ret >= 0) { return ret; }
  11461. }
  11462. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11463. // or a post-handshake message must be consumed before the record goes
  11464. // out. Anything else is a hard error.
  11465. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11466. #ifdef _WIN32
  11467. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11468. needs_writable =
  11469. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11470. WSAGetLastError() == WSAETIMEDOUT);
  11471. #endif
  11472. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11473. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11474. }
  11475. return -1;
  11476. }
  11477. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11478. int &port) const {
  11479. detail::get_remote_ip_and_port(sock_, ip, port);
  11480. }
  11481. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11482. int &port) const {
  11483. detail::get_local_ip_and_port(sock_, ip, port);
  11484. }
  11485. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11486. inline time_t WebSocketSSLStream::duration() const {
  11487. return static_cast<time_t>(
  11488. std::chrono::duration_cast<std::chrono::milliseconds>(
  11489. std::chrono::steady_clock::now() - start_time_)
  11490. .count());
  11491. }
  11492. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11493. read_timeout_sec_ = sec;
  11494. read_timeout_usec_ = usec;
  11495. }
  11496. inline void
  11497. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  11498. read_interrupted_ = std::move(interrupted);
  11499. }
  11500. } // namespace detail
  11501. #endif // CPPHTTPLIB_SSL_ENABLED
  11502. /*
  11503. * Group 4: Server implementation
  11504. */
  11505. // HTTP server implementation
  11506. inline Server::Server()
  11507. : new_task_queue([] {
  11508. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11509. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11510. }) {
  11511. #ifndef _WIN32
  11512. signal(SIGPIPE, SIG_IGN);
  11513. #endif
  11514. }
  11515. inline Server::~Server() = default;
  11516. inline std::unique_ptr<detail::MatcherBase>
  11517. Server::make_matcher(const std::string &pattern) {
  11518. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11519. // a path params pattern
  11520. if (pattern.find("/:") != std::string::npos) {
  11521. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11522. }
  11523. // A pattern with no regex metacharacter only has to be compared literally,
  11524. // which is what PathParamsMatcher already does when it captures no
  11525. // parameter, so std::regex is only worth building for the patterns that
  11526. // actually need it
  11527. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11528. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11529. }
  11530. return detail::make_unique<detail::RegexMatcher>(pattern);
  11531. }
  11532. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11533. return add_handler(get_handlers_, pattern, std::move(handler));
  11534. }
  11535. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11536. return add_handler(post_handlers_, pattern, std::move(handler));
  11537. }
  11538. inline Server &Server::Post(const std::string &pattern,
  11539. HandlerWithContentReader handler) {
  11540. return add_handler(post_handlers_for_content_reader_, pattern,
  11541. std::move(handler));
  11542. }
  11543. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11544. return add_handler(put_handlers_, pattern, std::move(handler));
  11545. }
  11546. inline Server &Server::Put(const std::string &pattern,
  11547. HandlerWithContentReader handler) {
  11548. return add_handler(put_handlers_for_content_reader_, pattern,
  11549. std::move(handler));
  11550. }
  11551. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11552. return add_handler(patch_handlers_, pattern, std::move(handler));
  11553. }
  11554. inline Server &Server::Patch(const std::string &pattern,
  11555. HandlerWithContentReader handler) {
  11556. return add_handler(patch_handlers_for_content_reader_, pattern,
  11557. std::move(handler));
  11558. }
  11559. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11560. return add_handler(delete_handlers_, pattern, std::move(handler));
  11561. }
  11562. inline Server &Server::Delete(const std::string &pattern,
  11563. HandlerWithContentReader handler) {
  11564. return add_handler(delete_handlers_for_content_reader_, pattern,
  11565. std::move(handler));
  11566. }
  11567. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11568. return add_handler(options_handlers_, pattern, std::move(handler));
  11569. }
  11570. inline const std::set<std::string> &Server::builtin_methods() {
  11571. thread_local const std::set<std::string> methods{
  11572. "GET", "HEAD", "POST", "PUT", "DELETE",
  11573. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11574. return methods;
  11575. }
  11576. inline Server::CustomHandlerEntry *
  11577. Server::custom_entry_for_registration(const std::string &method) {
  11578. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11579. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11580. // routing() before the custom tables are consulted, so a route registered
  11581. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11582. // there and would be reachable, but they carry protocol-level meaning
  11583. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11584. // library does not route.
  11585. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11586. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11587. has_invalid_registration_ = true;
  11588. return nullptr;
  11589. }
  11590. return &custom_handlers_[method];
  11591. }
  11592. inline Server &Server::CustomRoute(const std::string &method,
  11593. const std::string &pattern,
  11594. Handler handler) {
  11595. auto *entry = custom_entry_for_registration(method);
  11596. if (!entry) { return *this; }
  11597. return add_handler(entry->handlers, pattern, std::move(handler));
  11598. }
  11599. inline Server &Server::CustomRoute(const std::string &method,
  11600. const std::string &pattern,
  11601. HandlerWithContentReader handler) {
  11602. auto *entry = custom_entry_for_registration(method);
  11603. if (!entry) { return *this; }
  11604. return add_handler(entry->handlers_for_content_reader, pattern,
  11605. std::move(handler));
  11606. }
  11607. inline const Server::CustomHandlerEntry *
  11608. Server::find_custom_entry(const std::string &method) const {
  11609. // find() alone would be correct here. The empty() check is what keeps the
  11610. // per-request cost off servers that never call CustomRoute(), which is the
  11611. // overwhelmingly common case; keep it rather than walking into the tree.
  11612. if (custom_handlers_.empty()) { return nullptr; }
  11613. auto it = custom_handlers_.find(method);
  11614. return it == custom_handlers_.end() ? nullptr : &it->second;
  11615. }
  11616. inline Server &Server::WebSocket(const std::string &pattern,
  11617. WebSocketHandler handler) {
  11618. websocket_handlers_.push_back(
  11619. {make_matcher(pattern), std::move(handler), nullptr});
  11620. return *this;
  11621. }
  11622. inline Server &Server::WebSocket(const std::string &pattern,
  11623. WebSocketHandler handler,
  11624. SubProtocolSelector sub_protocol_selector) {
  11625. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11626. std::move(sub_protocol_selector)});
  11627. return *this;
  11628. }
  11629. inline bool Server::set_base_dir(const std::string &dir,
  11630. const std::string &mount_point) {
  11631. return set_mount_point(mount_point, dir);
  11632. }
  11633. inline bool Server::set_mount_point(const std::string &mount_point,
  11634. const std::string &dir, Headers headers) {
  11635. detail::FileStat stat(dir);
  11636. if (stat.is_dir()) {
  11637. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11638. if (!mnt.empty() && mnt[0] == '/') {
  11639. // Without the resolved directory, a file could not be checked to be
  11640. // inside it.
  11641. std::string resolved_base;
  11642. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11643. return false;
  11644. }
  11645. #if defined(_WIN32)
  11646. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11647. resolved_base += '\\';
  11648. }
  11649. #else
  11650. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11651. #endif
  11652. base_dirs_.push_back(
  11653. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11654. return true;
  11655. }
  11656. }
  11657. return false;
  11658. }
  11659. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11660. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11661. if (it->mount_point == mount_point) {
  11662. base_dirs_.erase(it);
  11663. return true;
  11664. }
  11665. }
  11666. return false;
  11667. }
  11668. inline Server &
  11669. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11670. const std::string &mime) {
  11671. // Keyed as find_content_type() looks it up
  11672. auto key = detail::case_ignore::to_lower(ext);
  11673. if (!key.empty() && key[0] == '.') { key.erase(0, 1); }
  11674. file_extension_and_mimetype_map_[key] = mime;
  11675. return *this;
  11676. }
  11677. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11678. default_file_mimetype_ = mime;
  11679. return *this;
  11680. }
  11681. inline Server &Server::set_file_request_handler(Handler handler) {
  11682. file_request_handler_ = std::move(handler);
  11683. return *this;
  11684. }
  11685. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11686. std::true_type) {
  11687. error_handler_ = std::move(handler);
  11688. return *this;
  11689. }
  11690. inline Server &Server::set_error_handler_core(Handler handler,
  11691. std::false_type) {
  11692. error_handler_ = [handler](const Request &req, Response &res) {
  11693. handler(req, res);
  11694. return HandlerResponse::Handled;
  11695. };
  11696. return *this;
  11697. }
  11698. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11699. exception_handler_ = std::move(handler);
  11700. return *this;
  11701. }
  11702. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11703. pre_routing_handler_ = std::move(handler);
  11704. return *this;
  11705. }
  11706. inline Server &Server::set_post_routing_handler(Handler handler) {
  11707. post_routing_handler_ = std::move(handler);
  11708. return *this;
  11709. }
  11710. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11711. pre_request_handler_ = std::move(handler);
  11712. return *this;
  11713. }
  11714. inline Server &Server::set_logger(Logger logger) {
  11715. logger_ = std::move(logger);
  11716. return *this;
  11717. }
  11718. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11719. error_logger_ = std::move(error_logger);
  11720. return *this;
  11721. }
  11722. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11723. pre_compression_logger_ = std::move(logger);
  11724. return *this;
  11725. }
  11726. inline Server &
  11727. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11728. expect_100_continue_handler_ = std::move(handler);
  11729. return *this;
  11730. }
  11731. inline Server &Server::set_start_handler(StartHandler handler) {
  11732. start_handler_ = std::move(handler);
  11733. return *this;
  11734. }
  11735. inline Server &Server::set_address_family(int family) {
  11736. address_family_ = family;
  11737. return *this;
  11738. }
  11739. inline Server &Server::set_tcp_nodelay(bool on) {
  11740. tcp_nodelay_ = on;
  11741. return *this;
  11742. }
  11743. inline Server &Server::set_ipv6_v6only(bool on) {
  11744. ipv6_v6only_ = on;
  11745. return *this;
  11746. }
  11747. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11748. socket_options_ = std::move(socket_options);
  11749. return *this;
  11750. }
  11751. inline Server &Server::set_default_headers(Headers headers) {
  11752. default_headers_ = std::move(headers);
  11753. return *this;
  11754. }
  11755. inline Server &Server::set_header_writer(
  11756. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11757. header_writer_ = writer;
  11758. return *this;
  11759. }
  11760. inline Server &
  11761. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11762. trusted_proxies_.clear();
  11763. trusted_proxies_.reserve(proxies.size());
  11764. for (const auto &proxy : proxies) {
  11765. trusted_proxies_.push_back(detail::canonical_ip(proxy));
  11766. }
  11767. return *this;
  11768. }
  11769. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11770. keep_alive_max_count_ = count;
  11771. return *this;
  11772. }
  11773. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11774. keep_alive_timeout_sec_ = sec;
  11775. return *this;
  11776. }
  11777. template <class Rep, class Period>
  11778. inline Server &Server::set_keep_alive_timeout(
  11779. const std::chrono::duration<Rep, Period> &duration) {
  11780. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11781. set_keep_alive_timeout(sec);
  11782. });
  11783. return *this;
  11784. }
  11785. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11786. read_timeout_sec_ = sec;
  11787. read_timeout_usec_ = usec;
  11788. return *this;
  11789. }
  11790. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11791. write_timeout_sec_ = sec;
  11792. write_timeout_usec_ = usec;
  11793. return *this;
  11794. }
  11795. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11796. idle_interval_sec_ = sec;
  11797. idle_interval_usec_ = usec;
  11798. return *this;
  11799. }
  11800. inline Server &Server::set_payload_max_length(size_t length) {
  11801. payload_max_length_ = length;
  11802. return *this;
  11803. }
  11804. inline Server &Server::set_compress(bool on) {
  11805. compress_ = on;
  11806. return *this;
  11807. }
  11808. inline Server &Server::set_static_file_compression(bool on) {
  11809. static_file_compression_ = on;
  11810. return *this;
  11811. }
  11812. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11813. static_file_compression_min_length_ = length;
  11814. return *this;
  11815. }
  11816. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11817. static_file_compression_max_length_ = length;
  11818. return *this;
  11819. }
  11820. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11821. websocket_max_missed_pongs_ = count;
  11822. return *this;
  11823. }
  11824. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11825. websocket_ping_interval_sec_ = sec;
  11826. return *this;
  11827. }
  11828. template <class Rep, class Period>
  11829. inline Server &Server::set_websocket_ping_interval(
  11830. const std::chrono::duration<Rep, Period> &duration) {
  11831. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11832. set_websocket_ping_interval(sec);
  11833. });
  11834. return *this;
  11835. }
  11836. inline bool Server::bind_to_port(const std::string &host, int port,
  11837. int socket_flags) {
  11838. auto ret = bind_internal(host, port, socket_flags);
  11839. if (ret == -1) { is_decommissioned = true; }
  11840. return ret >= 0;
  11841. }
  11842. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11843. auto ret = bind_internal(host, 0, socket_flags);
  11844. if (ret == -1) { is_decommissioned = true; }
  11845. return ret;
  11846. }
  11847. inline bool Server::listen_after_bind() { return listen_internal(); }
  11848. inline bool Server::listen(const std::string &host, int port,
  11849. int socket_flags) {
  11850. return bind_to_port(host, port, socket_flags) && listen_internal();
  11851. }
  11852. inline bool Server::is_running() const { return is_running_; }
  11853. inline void Server::wait_until_ready() const {
  11854. while (!is_running_ && !is_decommissioned) {
  11855. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11856. }
  11857. }
  11858. inline void Server::stop() noexcept {
  11859. // Release the listening socket whether or not the accept loop is running:
  11860. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11861. // exchange is what makes this safe to call concurrently with the accept loop.
  11862. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11863. if (sock != INVALID_SOCKET) {
  11864. detail::shutdown_socket(sock);
  11865. detail::close_socket(sock);
  11866. }
  11867. is_decommissioned = false;
  11868. }
  11869. inline void Server::decommission() { is_decommissioned = true; }
  11870. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11871. auto len = strlen(s);
  11872. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11873. len -= 2;
  11874. {
  11875. // RFC 9112 §3: exactly one SP between the method, the target and the
  11876. // version. Taking other whitespace as a separator too lets recipients
  11877. // that parse more strictly see a different request.
  11878. auto end = s + len;
  11879. if (std::count(s, end, ' ') != 2) { return false; }
  11880. auto sp1 = std::find(s, end, ' ');
  11881. auto sp2 = std::find(sp1 + 1, end, ' ');
  11882. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11883. req.method.assign(s, sp1);
  11884. req.target.assign(sp1 + 1, sp2);
  11885. req.version.assign(sp2 + 1, end);
  11886. }
  11887. // A method outside the built-in set is accepted only when a handler has been
  11888. // registered for it with CustomRoute().
  11889. const auto &methods = builtin_methods();
  11890. if (methods.find(req.method) == methods.end() &&
  11891. !find_custom_entry(req.method)) {
  11892. output_error_log(Error::InvalidHTTPMethod, &req);
  11893. return false;
  11894. }
  11895. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11896. output_error_log(Error::InvalidHTTPVersion, &req);
  11897. return false;
  11898. }
  11899. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11900. // would leave this server routing a different path than a cache or a
  11901. // filter in front of it sees.
  11902. if (!detail::fields::is_request_target(req.target) ||
  11903. req.target.find('#') != std::string::npos) {
  11904. return false;
  11905. }
  11906. {
  11907. detail::divide(req.target, '?',
  11908. [&](const char *lhs_data, std::size_t lhs_size,
  11909. const char *rhs_data, std::size_t rhs_size) {
  11910. req.path =
  11911. decode_path_component(std::string(lhs_data, lhs_size));
  11912. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11913. });
  11914. }
  11915. return true;
  11916. }
  11917. inline bool Server::write_response(Stream &strm, bool close_connection,
  11918. Request &req, Response &res) {
  11919. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11920. // incorrectly to the error content.
  11921. req.ranges.clear();
  11922. return write_response_core(strm, close_connection, req, res, false);
  11923. }
  11924. inline bool Server::write_response_with_content(Stream &strm,
  11925. bool close_connection,
  11926. const Request &req,
  11927. Response &res) {
  11928. return write_response_core(strm, close_connection, req, res, true);
  11929. }
  11930. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11931. const Request &req, Response &res,
  11932. bool need_apply_ranges) {
  11933. assert(res.status != -1);
  11934. if (400 <= res.status && error_handler_ &&
  11935. error_handler_(req, res) == HandlerResponse::Handled) {
  11936. need_apply_ranges = true;
  11937. }
  11938. // Before anything below reads res.headers, which the handlers may have
  11939. // filled directly
  11940. detail::erase_invalid_fields(res.headers);
  11941. if (!detail::body_allowed_for_status(res.status)) {
  11942. detail::clear_content(res);
  11943. }
  11944. detail::prefer_assigned_body(res);
  11945. std::string content_type;
  11946. std::string boundary;
  11947. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11948. // Prepare additional headers
  11949. if (close_connection ||
  11950. detail::has_header_token(req.headers, "Connection", "close") ||
  11951. 400 <= res.status || // Don't leave connections open after errors
  11952. // The client withholds the body until `100 Continue`, which was never
  11953. // sent, so whether and when the body follows is unknown.
  11954. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11955. // The body was left partway, e.g. by a content receiver that returned
  11956. // false, so the rest of it cannot be told from the next request.
  11957. (req.body_read_started_ && !req.body_consumed_)) {
  11958. res.set_header("Connection", "close");
  11959. } else {
  11960. std::string s = "timeout=";
  11961. s += std::to_string(keep_alive_timeout_sec_);
  11962. if (keep_alive_max_count_ > 0) {
  11963. s += ", max=";
  11964. s += std::to_string(keep_alive_max_count_);
  11965. }
  11966. res.set_header("Keep-Alive", s);
  11967. }
  11968. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11969. !res.has_header("Content-Type")) {
  11970. res.set_header("Content-Type", "text/plain");
  11971. }
  11972. detail::set_framing_headers(req, res, boundary, content_type);
  11973. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11974. res.set_header("Accept-Ranges", "bytes");
  11975. }
  11976. if (post_routing_handler_) {
  11977. post_routing_handler_(req, res);
  11978. detail::erase_invalid_fields(res.headers);
  11979. // Again, for a body or framing headers the handler changed.
  11980. detail::set_framing_headers(req, res, boundary, content_type);
  11981. }
  11982. // Response line and headers
  11983. detail::BufferStream bstrm;
  11984. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11985. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11986. // Combine a small body with the headers so the whole response leaves in a
  11987. // single write. A large body is written on its own instead: a copy of it
  11988. // costs more than the extra write saves.
  11989. auto send_body =
  11990. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  11991. auto body_is_separate = false;
  11992. auto provider_done = false;
  11993. if (send_body && !res.body.empty() && !res.content_provider_) {
  11994. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11995. bstrm.write(res.body.data(), res.body.size());
  11996. } else {
  11997. body_is_separate = true;
  11998. }
  11999. } else if (send_body && res.content_provider_ &&
  12000. res.is_file_content_provider_ &&
  12001. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  12002. // A small file is read into the same buffer. Other providers may produce
  12003. // their data over time, so they are never held back.
  12004. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  12005. return false;
  12006. }
  12007. provider_done = true;
  12008. }
  12009. // Log before writing to avoid race condition with client-side code that
  12010. // accesses logger-captured data immediately after receiving the response.
  12011. output_log(req, res);
  12012. // Flush buffer
  12013. auto &data = bstrm.get_buffer();
  12014. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  12015. if (body_is_separate) {
  12016. return detail::write_data(strm, res.body.data(), res.body.size());
  12017. }
  12018. // Streaming body
  12019. if (send_body && res.content_provider_) {
  12020. if (!provider_done &&
  12021. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  12022. return false;
  12023. }
  12024. res.content_provider_success_ = true;
  12025. }
  12026. return true;
  12027. }
  12028. inline bool
  12029. Server::write_content_with_provider(Stream &strm, const Request &req,
  12030. Response &res, const std::string &boundary,
  12031. const std::string &content_type) {
  12032. auto is_shutting_down = [this]() {
  12033. return this->svr_sock_ == INVALID_SOCKET;
  12034. };
  12035. if (res.content_length_ > 0) {
  12036. if (!detail::is_partial_content(req, res)) {
  12037. return detail::write_content(strm, res.content_provider_, 0,
  12038. res.content_length_, is_shutting_down);
  12039. } else if (req.ranges.size() == 1) {
  12040. auto offset_and_length = detail::get_range_offset_and_length(
  12041. req.ranges[0], res.content_length_);
  12042. return detail::write_content(strm, res.content_provider_,
  12043. offset_and_length.first,
  12044. offset_and_length.second, is_shutting_down);
  12045. } else {
  12046. return detail::write_multipart_ranges_data(
  12047. strm, req, res, boundary, content_type, res.content_length_,
  12048. is_shutting_down);
  12049. }
  12050. } else {
  12051. if (res.is_chunked_content_provider_) {
  12052. // Use the coding `apply_ranges()` chose when it wrote the headers;
  12053. // re-negotiating here would disagree with them, e.g. once a handler's
  12054. // own Content-Encoding header suppresses the negotiation.
  12055. auto compressor = detail::make_compressor(res.content_coding_);
  12056. if (!compressor) {
  12057. compressor = detail::make_unique<detail::nocompressor>();
  12058. }
  12059. return detail::write_content_chunked(strm, res.content_provider_,
  12060. is_shutting_down, *compressor);
  12061. } else {
  12062. return detail::write_content_without_length(strm, res.content_provider_,
  12063. is_shutting_down);
  12064. }
  12065. }
  12066. }
  12067. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  12068. FormFields::iterator cur_field;
  12069. FormFiles::iterator cur_file;
  12070. auto is_text_field = false;
  12071. size_t count = 0;
  12072. if (read_content_core(
  12073. strm, req, res,
  12074. // Regular
  12075. [&](const char *buf, size_t n) {
  12076. // Prevent arithmetic overflow when checking sizes.
  12077. // Avoid computing (req.body.size() + n) directly because
  12078. // adding two unsigned `size_t` values can wrap around and
  12079. // produce a small result instead of indicating overflow.
  12080. // Instead, check using subtraction: ensure `n` does not
  12081. // exceed the remaining capacity `max_size() - size()`.
  12082. if (req.body.size() >= req.body.max_size() ||
  12083. n > req.body.max_size() - req.body.size()) {
  12084. return false;
  12085. }
  12086. // Limit decompressed body size to payload_max_length_ to protect
  12087. // against "zip bomb" attacks where a small compressed payload
  12088. // decompresses to a massive size.
  12089. if (payload_max_length_ > 0 &&
  12090. (req.body.size() >= payload_max_length_ ||
  12091. n > payload_max_length_ - req.body.size())) {
  12092. return false;
  12093. }
  12094. req.body.append(buf, n);
  12095. return true;
  12096. },
  12097. // Multipart FormData
  12098. [&](const FormData &file) {
  12099. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12100. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12101. output_error_log(Error::TooManyFormDataFiles, &req);
  12102. return false;
  12103. }
  12104. if (file.filename.empty()) {
  12105. cur_field = req.form.fields.emplace(
  12106. file.name, FormField{file.name, file.content, file.headers});
  12107. is_text_field = true;
  12108. } else {
  12109. cur_file = req.form.files.emplace(file.name, file);
  12110. is_text_field = false;
  12111. }
  12112. return true;
  12113. },
  12114. [&](const char *buf, size_t n) {
  12115. if (is_text_field) {
  12116. auto &content = cur_field->second.content;
  12117. if (content.size() + n > content.max_size()) { return false; }
  12118. content.append(buf, n);
  12119. } else {
  12120. auto &content = cur_file->second.content;
  12121. if (content.size() + n > content.max_size()) { return false; }
  12122. content.append(buf, n);
  12123. }
  12124. return true;
  12125. })) {
  12126. const auto &content_type = req.get_header_value("Content-Type");
  12127. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12128. "application/x-www-form-urlencoded")) {
  12129. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12130. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12131. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12132. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12133. return false;
  12134. }
  12135. detail::parse_query_text(req.body, req.params);
  12136. }
  12137. return true;
  12138. }
  12139. return false;
  12140. }
  12141. inline bool Server::read_content_with_content_receiver(
  12142. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12143. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12144. return read_content_core(strm, req, res, std::move(receiver),
  12145. std::move(multipart_header),
  12146. std::move(multipart_receiver));
  12147. }
  12148. inline bool Server::read_content_core(
  12149. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12150. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12151. detail::FormDataParser multipart_form_data_parser;
  12152. ContentReceiverWithProgress out;
  12153. if (req.is_multipart_form_data()) {
  12154. const auto &content_type = req.get_header_value("Content-Type");
  12155. std::string boundary;
  12156. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12157. res.status = StatusCode::BadRequest_400;
  12158. output_error_log(Error::MultipartParsing, &req);
  12159. return false;
  12160. }
  12161. multipart_form_data_parser.set_boundary(std::move(boundary));
  12162. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12163. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12164. multipart_receiver);
  12165. };
  12166. } else {
  12167. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12168. size_t /*len*/) { return receiver(buf, n); };
  12169. }
  12170. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12171. if (!req.has_header("Content-Length") &&
  12172. !detail::is_chunked_transfer_encoding(req.headers)) {
  12173. return true;
  12174. }
  12175. // A second read would start where the first one stopped, or in the next
  12176. // request.
  12177. if (req.body_read_started_) { return false; }
  12178. // The client is waiting for this before it sends the body.
  12179. if (req.expect_100_continue_pending_) {
  12180. req.expect_100_continue_pending_ = false;
  12181. detail::write_response_line(strm, StatusCode::Continue_100);
  12182. strm.write("\r\n");
  12183. }
  12184. // Set before reading, since a receiver may also stop by throwing.
  12185. req.body_read_started_ = true;
  12186. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12187. out, true)) {
  12188. return false;
  12189. }
  12190. req.body_consumed_ = true;
  12191. if (req.is_multipart_form_data()) {
  12192. if (!multipart_form_data_parser.is_valid()) {
  12193. res.status = StatusCode::BadRequest_400;
  12194. output_error_log(Error::MultipartParsing, &req);
  12195. return false;
  12196. }
  12197. }
  12198. return true;
  12199. }
  12200. inline bool Server::handle_file_request(Request &req, Response &res) {
  12201. if (!detail::is_valid_path(req.path)) { return false; }
  12202. for (const auto &entry : base_dirs_) {
  12203. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12204. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12205. // One that already ends in '/' (the root mount among them) carries its own
  12206. // boundary; set_mount_point() guarantees the mount point is not empty.
  12207. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12208. (entry.mount_point.back() == '/' ||
  12209. req.path.size() == entry.mount_point.size() ||
  12210. req.path[entry.mount_point.size()] == '/')) {
  12211. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12212. auto path = entry.base_dir + sub_path;
  12213. if (path.back() == '/') { path += "index.html"; }
  12214. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12215. // but symlinks/junctions can still escape the base directory. A path
  12216. // that cannot be resolved, which includes one that does not exist, is
  12217. // not served from here.
  12218. std::string resolved_path;
  12219. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  12220. if (!detail::is_path_within_base(resolved_path,
  12221. entry.resolved_base_dir)) {
  12222. res.status = StatusCode::Forbidden_403;
  12223. return true;
  12224. }
  12225. detail::FileStat stat(path);
  12226. if (stat.is_dir()) {
  12227. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12228. // in the name from reading as a scheme.
  12229. auto name = req.path.substr(req.path.rfind('/') + 1);
  12230. res.set_redirect("./" + encode_path_component(name) + "/",
  12231. StatusCode::MovedPermanently_301);
  12232. return true;
  12233. }
  12234. if (stat.is_file()) {
  12235. for (const auto &kv : entry.headers) {
  12236. res.set_header(kv.first, kv.second);
  12237. }
  12238. auto content_type = detail::find_content_type(
  12239. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12240. auto encoding = detail::EncodingType::None;
  12241. if (static_file_compression_) {
  12242. encoding = static_file_encoding(req, res, content_type, stat.size());
  12243. }
  12244. // The ETag names the representation actually sent, so a client that
  12245. // cached the compressed form revalidates against the compressed ETag
  12246. // and still gets a 304, while one that took identity keeps the plain
  12247. // ETag.
  12248. auto etag = detail::compute_etag(
  12249. stat, encoding == detail::EncodingType::None
  12250. ? std::string()
  12251. : std::string("-") + detail::encoding_name(encoding));
  12252. if (!etag.empty()) { res.set_header("ETag", etag); }
  12253. auto mtime = stat.mtime();
  12254. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12255. if (!last_modified.empty()) {
  12256. res.set_header("Last-Modified", last_modified);
  12257. }
  12258. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12259. check_if_range(req, etag, mtime);
  12260. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12261. if (!mm->is_open()) {
  12262. output_error_log(Error::OpenFile, &req);
  12263. return false;
  12264. }
  12265. detail::set_file_content_provider(res, mm, content_type, encoding);
  12266. if (req.method != "HEAD" && file_request_handler_) {
  12267. file_request_handler_(req, res);
  12268. }
  12269. return true;
  12270. } else {
  12271. output_error_log(Error::OpenFile, &req);
  12272. }
  12273. }
  12274. }
  12275. return false;
  12276. }
  12277. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12278. const std::string &etag,
  12279. time_t mtime) const {
  12280. // Handle conditional GET:
  12281. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12282. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12283. if (req.has_header("If-None-Match")) {
  12284. if (!etag.empty()) {
  12285. auto val =
  12286. detail::get_combined_header_value(req.headers, "If-None-Match");
  12287. // NOTE: We use exact string matching here. This works correctly
  12288. // because our server always generates weak ETags (W/"..."), and
  12289. // clients typically send back the same ETag they received.
  12290. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12291. // If-None-Match, where W/"x" and "x" would match, but this
  12292. // simplified implementation requires exact matches.
  12293. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12294. [&](const char *b, const char *e) {
  12295. auto seg_len = static_cast<size_t>(e - b);
  12296. return (seg_len == 1 && *b == '*') ||
  12297. (seg_len == etag.size() &&
  12298. std::equal(b, e, etag.begin()));
  12299. });
  12300. if (ret) {
  12301. res.status = StatusCode::NotModified_304;
  12302. return true;
  12303. }
  12304. }
  12305. } else if (req.has_header("If-Modified-Since")) {
  12306. auto val = req.get_header_value("If-Modified-Since");
  12307. auto t = detail::parse_http_date(val);
  12308. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12309. res.status = StatusCode::NotModified_304;
  12310. return true;
  12311. }
  12312. }
  12313. return false;
  12314. }
  12315. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12316. time_t mtime) const {
  12317. // Handle If-Range for partial content requests (RFC 9110
  12318. // Section 13.1.5). If-Range is only evaluated when Range header is
  12319. // present. If the validator matches, serve partial content; otherwise
  12320. // serve full content.
  12321. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12322. auto val = req.get_header_value("If-Range");
  12323. auto is_valid_range = [&]() {
  12324. if (detail::is_strong_etag(val)) {
  12325. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12326. // comparison.
  12327. return (!etag.empty() && val == etag);
  12328. } else if (detail::is_weak_etag(val)) {
  12329. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12330. return false;
  12331. } else {
  12332. // HTTP-date comparison
  12333. auto t = detail::parse_http_date(val);
  12334. return (t != static_cast<time_t>(-1) && mtime <= t);
  12335. }
  12336. };
  12337. if (!is_valid_range()) {
  12338. // Validator doesn't match: ignore Range and serve full content
  12339. req.ranges.clear();
  12340. return false;
  12341. }
  12342. }
  12343. return true;
  12344. }
  12345. inline socket_t
  12346. Server::create_server_socket(const std::string &host, int port,
  12347. int socket_flags,
  12348. SocketOptions socket_options) const {
  12349. return detail::create_socket(
  12350. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12351. ipv6_v6only_, std::move(socket_options),
  12352. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12353. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12354. output_error_log(Error::BindIPAddress, nullptr);
  12355. return false;
  12356. }
  12357. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12358. output_error_log(Error::Listen, nullptr);
  12359. return false;
  12360. }
  12361. return true;
  12362. });
  12363. }
  12364. inline int Server::bind_internal(const std::string &host, int port,
  12365. int socket_flags) {
  12366. if (is_decommissioned) { return -1; }
  12367. if (!is_valid()) { return -1; }
  12368. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12369. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12370. if (port == 0) {
  12371. struct sockaddr_storage addr;
  12372. socklen_t addr_len = sizeof(addr);
  12373. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12374. &addr_len) == -1) {
  12375. output_error_log(Error::GetSockName, nullptr);
  12376. return -1;
  12377. }
  12378. if (addr.ss_family == AF_INET) {
  12379. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12380. } else if (addr.ss_family == AF_INET6) {
  12381. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12382. } else {
  12383. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12384. return -1;
  12385. }
  12386. } else {
  12387. return port;
  12388. }
  12389. }
  12390. inline bool Server::listen_internal() {
  12391. // A stop() between bind and listen leaves nothing to accept on. Report
  12392. // failure instead of returning success without ever serving, and mark the
  12393. // server decommissioned the way any failed listen does so that a concurrent
  12394. // wait_until_ready() wakes up instead of spinning forever.
  12395. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12396. is_decommissioned = true;
  12397. return false;
  12398. }
  12399. auto ret = true;
  12400. is_running_ = true;
  12401. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12402. if (start_handler_) { start_handler_(); }
  12403. {
  12404. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12405. while (svr_sock_ != INVALID_SOCKET) {
  12406. #ifndef _WIN32
  12407. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12408. #endif
  12409. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12410. idle_interval_usec_);
  12411. if (val == 0) { // Timeout
  12412. task_queue->on_idle();
  12413. continue;
  12414. }
  12415. #ifndef _WIN32
  12416. }
  12417. #endif
  12418. #if defined _WIN32
  12419. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12420. // OVERLAPPED
  12421. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12422. #elif defined SOCK_CLOEXEC
  12423. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12424. #else
  12425. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12426. #endif
  12427. if (sock == INVALID_SOCKET) {
  12428. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12429. // touches the CRT errno, so the two have to be asked platform by
  12430. // platform rather than by testing errno here.
  12431. if (detail::is_accept_resource_error()) {
  12432. // The per-process descriptor limit or the network stack's buffer
  12433. // space has been reached. Try to accept new connections after a
  12434. // short sleep.
  12435. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12436. continue;
  12437. } else if (detail::is_accept_transient_error()) {
  12438. continue;
  12439. }
  12440. // Take the descriptor out of svr_sock_ before closing it: a later
  12441. // stop() would otherwise shutdown()/close() a value the OS may have
  12442. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12443. // gone. The exchange also settles the race with a concurrent stop(),
  12444. // since whichever side takes the descriptor closes it exactly once.
  12445. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12446. if (listen_sock != INVALID_SOCKET) {
  12447. detail::close_socket(listen_sock);
  12448. ret = false;
  12449. output_error_log(Error::Connection, nullptr);
  12450. } else {
  12451. ; // The server socket was closed by user.
  12452. }
  12453. break;
  12454. }
  12455. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12456. read_timeout_sec_, read_timeout_usec_);
  12457. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12458. write_timeout_sec_, write_timeout_usec_);
  12459. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12460. if (!task_queue->enqueue(
  12461. [this, sock]() { process_and_close_socket(sock); })) {
  12462. output_error_log(Error::ResourceExhaustion, nullptr);
  12463. detail::shutdown_socket(sock);
  12464. detail::close_socket(sock);
  12465. }
  12466. }
  12467. task_queue->shutdown();
  12468. }
  12469. is_decommissioned = !ret;
  12470. return ret;
  12471. }
  12472. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  12473. // Call from a catch block. The response is a 500 unless the exception handler
  12474. // sets another status. Returns whether the exception handler ran.
  12475. inline bool Server::handle_exception(Request &req, Response &res) {
  12476. res.status = StatusCode::InternalServerError_500;
  12477. if (!exception_handler_) { return false; }
  12478. exception_handler_(req, res, std::current_exception());
  12479. return true;
  12480. }
  12481. #endif
  12482. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  12483. bool skip_pre_routing) {
  12484. if (!skip_pre_routing && pre_routing_handler_ &&
  12485. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12486. return true;
  12487. }
  12488. // File handler
  12489. if ((req.method == "GET" || req.method == "HEAD") &&
  12490. handle_file_request(req, res)) {
  12491. return true;
  12492. }
  12493. const auto *custom = find_custom_entry(req.method);
  12494. // The second clause mirrors what expect_content() does unconditionally for
  12495. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12496. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12497. // `allprop`) would skip its handler and fall through to 404.
  12498. if (detail::expect_content(req) ||
  12499. (custom && !custom->handlers_for_content_reader.empty())) {
  12500. // Content reader handler
  12501. {
  12502. // Track whether the ContentReader was aborted due to the decompressed
  12503. // payload exceeding `payload_max_length_`.
  12504. // The user handler runs after the lambda returns, so we must restore the
  12505. // 413 status if the handler overwrites it.
  12506. bool content_reader_payload_too_large = false;
  12507. ContentReader reader(
  12508. [&](ContentReceiver receiver) {
  12509. auto result = read_content_with_content_receiver(
  12510. strm, req, res, std::move(receiver), nullptr, nullptr);
  12511. if (!result) {
  12512. output_error_log(Error::Read, &req);
  12513. if (res.status == StatusCode::PayloadTooLarge_413) {
  12514. content_reader_payload_too_large = true;
  12515. }
  12516. }
  12517. return result;
  12518. },
  12519. [&](FormDataHeader header, ContentReceiver receiver) {
  12520. auto result = read_content_with_content_receiver(
  12521. strm, req, res, nullptr, std::move(header),
  12522. std::move(receiver));
  12523. if (!result) {
  12524. output_error_log(Error::Read, &req);
  12525. if (res.status == StatusCode::PayloadTooLarge_413) {
  12526. content_reader_payload_too_large = true;
  12527. }
  12528. }
  12529. return result;
  12530. });
  12531. bool dispatched = false;
  12532. if (req.method == "POST") {
  12533. dispatched = dispatch_request_for_content_reader(
  12534. req, res, std::move(reader), post_handlers_for_content_reader_);
  12535. } else if (req.method == "PUT") {
  12536. dispatched = dispatch_request_for_content_reader(
  12537. req, res, std::move(reader), put_handlers_for_content_reader_);
  12538. } else if (req.method == "PATCH") {
  12539. dispatched = dispatch_request_for_content_reader(
  12540. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12541. } else if (req.method == "DELETE") {
  12542. dispatched = dispatch_request_for_content_reader(
  12543. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12544. } else if (custom) {
  12545. dispatched = dispatch_request_for_content_reader(
  12546. req, res, std::move(reader), custom->handlers_for_content_reader);
  12547. }
  12548. if (dispatched) {
  12549. if (content_reader_payload_too_large) {
  12550. // Enforce the limit: override any status the handler may have set
  12551. // and return false so the error path sends a plain 413 response.
  12552. res.status = StatusCode::PayloadTooLarge_413;
  12553. detail::clear_content(res);
  12554. return false;
  12555. }
  12556. return true;
  12557. }
  12558. }
  12559. // NOTE: `req.body` is not read here. For a regular handler the body is
  12560. // read inside dispatch_request(), after the route has matched and the
  12561. // pre-request handler has approved the request, so that a rejected
  12562. // request (e.g. failed authentication) never forces us to buffer a
  12563. // potentially large body.
  12564. }
  12565. // Regular handler
  12566. if (req.method == "GET" || req.method == "HEAD") {
  12567. return dispatch_request(req, res, get_handlers_, strm);
  12568. } else if (req.method == "POST") {
  12569. return dispatch_request(req, res, post_handlers_, strm);
  12570. } else if (req.method == "PUT") {
  12571. return dispatch_request(req, res, put_handlers_, strm);
  12572. } else if (req.method == "DELETE") {
  12573. return dispatch_request(req, res, delete_handlers_, strm);
  12574. } else if (req.method == "OPTIONS") {
  12575. return dispatch_request(req, res, options_handlers_, strm);
  12576. } else if (req.method == "PATCH") {
  12577. return dispatch_request(req, res, patch_handlers_, strm);
  12578. } else if (custom) {
  12579. return dispatch_request(req, res, custom->handlers, strm);
  12580. }
  12581. res.status = StatusCode::BadRequest_400;
  12582. return false;
  12583. }
  12584. inline bool Server::dispatch_request(Request &req, Response &res,
  12585. const Handlers &handlers, Stream &strm) {
  12586. for (const auto &x : handlers) {
  12587. const auto &matcher = x.first;
  12588. const auto &handler = x.second;
  12589. if (matcher->match(req)) {
  12590. req.matched_route = matcher->pattern();
  12591. // Run the pre-request handler before reading the body so a rejected
  12592. // request (e.g. failed authentication) never forces us to buffer a
  12593. // potentially large body. `req.matched_route` is available here.
  12594. if (pre_request_handler_ &&
  12595. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12596. return true;
  12597. }
  12598. // The route matched and the request was approved; read the body now.
  12599. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12600. output_error_log(Error::Read, &req);
  12601. return false;
  12602. }
  12603. handler(req, res);
  12604. return true;
  12605. }
  12606. }
  12607. return false;
  12608. }
  12609. // Decides the content coding for a response served straight from a file. Both
  12610. // the ETag, which has to name the representation actually sent, and
  12611. // `apply_static_file_compression()` go through this, so the two cannot drift
  12612. // apart.
  12613. inline detail::EncodingType
  12614. Server::static_file_encoding(const Request &req, const Response &res,
  12615. const std::string &content_type,
  12616. size_t length) const {
  12617. if (!static_file_compression_) { return detail::EncodingType::None; }
  12618. // Nothing to compress, and an empty file already answers with
  12619. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12620. // turn an empty body into a 20-byte gzip stream.
  12621. if (length == 0) { return detail::EncodingType::None; }
  12622. // A file that already fits in a single packet gains nothing from being made
  12623. // smaller, since it still travels in that one segment, and a file of a few
  12624. // bytes comes out larger than it went in.
  12625. if (length < static_file_compression_min_length_) {
  12626. return detail::EncodingType::None;
  12627. }
  12628. // RFC 9110 applies Range to the representation after content coding, so a
  12629. // compressed 206 would mean compressing the whole file and then slicing it.
  12630. // Serve ranges from the identity representation instead.
  12631. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12632. if (static_file_compression_max_length_ > 0 &&
  12633. length > static_file_compression_max_length_) {
  12634. return detail::EncodingType::None;
  12635. }
  12636. return detail::encoding_type(req, res, content_type);
  12637. }
  12638. // Compresses a file-backed content provider into `res.body`. Returns false when
  12639. // the response is left untouched.
  12640. inline bool Server::apply_static_file_compression(const Request &req,
  12641. Response &res) const {
  12642. auto type = res.content_coding_;
  12643. if (type == detail::EncodingType::None || !res.content_provider_) {
  12644. return false;
  12645. }
  12646. auto compressor = detail::make_compressor(type);
  12647. if (!compressor) { return false; }
  12648. output_pre_compression_log(req, res);
  12649. std::string compressed;
  12650. if (!detail::compress_content_provider(res.content_provider_,
  12651. res.content_length_, *compressor,
  12652. compressed)) {
  12653. return false;
  12654. }
  12655. res.body.swap(compressed);
  12656. // The provider was consumed in full, so its releaser hears about a success.
  12657. res.content_provider_success_ = true;
  12658. detail::clear_content_provider(res);
  12659. res.set_header("Content-Encoding", detail::encoding_name(type));
  12660. res.set_header("Vary", "Accept-Encoding");
  12661. return true;
  12662. }
  12663. inline void Server::apply_ranges(const Request &req, Response &res,
  12664. std::string &content_type,
  12665. std::string &boundary) const {
  12666. // A known-length content provider leaves `res.body` empty, so the compressor
  12667. // at the end of this function never runs for one (issue #2545). A file-backed
  12668. // provider is fully readable right here, so compress it and answer with an
  12669. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12670. // takes the same path as `set_content()` from here on. Range requests never
  12671. // get a content coding, so `Content-Range` still names identity bytes and
  12672. // none of the range handling below applies.
  12673. if (apply_static_file_compression(req, res)) { return; }
  12674. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12675. auto it = res.headers.find("Content-Type");
  12676. if (it != res.headers.end()) {
  12677. content_type = it->second;
  12678. res.headers.erase(it);
  12679. }
  12680. boundary = detail::make_multipart_data_boundary();
  12681. res.set_header("Content-Type",
  12682. "multipart/byteranges; boundary=" + boundary);
  12683. }
  12684. auto type =
  12685. compress_ ? detail::encoding_type(req, res) : detail::EncodingType::None;
  12686. if (res.body.empty()) {
  12687. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12688. res.status == StatusCode::PartialContent_206) {
  12689. auto offset_and_length = detail::get_range_offset_and_length(
  12690. req.ranges[0], res.content_length_);
  12691. auto content_range = detail::make_content_range_header_field(
  12692. offset_and_length, res.content_length_);
  12693. res.set_header("Content-Range", content_range);
  12694. } else if (res.is_chunked_content_provider_) {
  12695. res.content_coding_ = type;
  12696. if (type != detail::EncodingType::None) {
  12697. res.set_header("Content-Encoding", detail::encoding_name(type));
  12698. res.set_header("Vary", "Accept-Encoding");
  12699. }
  12700. }
  12701. } else {
  12702. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12703. ;
  12704. } else if (req.ranges.size() == 1) {
  12705. auto offset_and_length =
  12706. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12707. auto offset = offset_and_length.first;
  12708. auto length = offset_and_length.second;
  12709. auto content_range = detail::make_content_range_header_field(
  12710. offset_and_length, res.body.size());
  12711. res.set_header("Content-Range", content_range);
  12712. assert(offset + length <= res.body.size());
  12713. res.body = res.body.substr(offset, length);
  12714. } else {
  12715. std::string data;
  12716. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12717. res.body.size(), data);
  12718. res.body.swap(data);
  12719. }
  12720. if (type != detail::EncodingType::None) {
  12721. output_pre_compression_log(req, res);
  12722. if (auto compressor = detail::make_compressor(type)) {
  12723. std::string compressed;
  12724. if (compressor->compress(res.body.data(), res.body.size(), true,
  12725. [&](const char *data, size_t data_len) {
  12726. compressed.append(data, data_len);
  12727. return true;
  12728. })) {
  12729. res.body.swap(compressed);
  12730. res.set_header("Content-Encoding", detail::encoding_name(type));
  12731. res.set_header("Vary", "Accept-Encoding");
  12732. }
  12733. }
  12734. }
  12735. res.content_length_ = res.body.size();
  12736. }
  12737. }
  12738. inline bool Server::dispatch_request_for_content_reader(
  12739. Request &req, Response &res, ContentReader content_reader,
  12740. const HandlersForContentReader &handlers) const {
  12741. for (const auto &x : handlers) {
  12742. const auto &matcher = x.first;
  12743. const auto &handler = x.second;
  12744. if (matcher->match(req)) {
  12745. req.matched_route = matcher->pattern();
  12746. if (!pre_request_handler_ ||
  12747. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12748. handler(req, res, content_reader);
  12749. }
  12750. return true;
  12751. }
  12752. }
  12753. return false;
  12754. }
  12755. inline std::string
  12756. get_client_ip(const std::string &x_forwarded_for,
  12757. const std::vector<std::string> &trusted_proxies) {
  12758. // X-Forwarded-For is a comma-separated list per RFC 7239
  12759. std::vector<std::string> ip_list;
  12760. detail::split(x_forwarded_for.data(),
  12761. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12762. [&](const char *b, const char *e) {
  12763. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12764. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12765. });
  12766. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12767. // no segments. Signal "no client IP derived" with an empty string so the
  12768. // caller can fall back to the connection-level remote address.
  12769. if (ip_list.empty()) { return std::string(); }
  12770. // Each hop appends the address it received the request from, so the rightmost
  12771. // entries are the ones written by our own infrastructure while the leftmost
  12772. // are whatever the original client chose to send. Walk from the right and
  12773. // skip trusted proxies; the first address that is not a trusted proxy is the
  12774. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12775. // from the left instead lets a client forge an arbitrary address by following
  12776. // it with a trusted proxy's address, which the left-to-right scan then
  12777. // returned as the client.
  12778. for (size_t i = ip_list.size(); i-- > 0;) {
  12779. const auto &ip = ip_list[i];
  12780. if (!detail::is_trusted_proxy(ip, trusted_proxies)) { return ip; }
  12781. }
  12782. // Every hop was a trusted proxy; fall back to the first entry.
  12783. return ip_list.front();
  12784. }
  12785. inline bool
  12786. Server::process_request(Stream &strm, const std::string &remote_addr,
  12787. int remote_port, const std::string &local_addr,
  12788. int local_port, bool close_connection,
  12789. bool &connection_closed,
  12790. const std::function<void(Request &)> &setup_request,
  12791. bool *websocket_upgraded) {
  12792. std::array<char, 2048> buf{};
  12793. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12794. // The read timeout bounds the request line and headers as a whole, so a
  12795. // client sending them a byte at a time cannot hold the worker any longer.
  12796. auto read_timeout_msec = read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000;
  12797. strm.set_max_timeout(read_timeout_msec);
  12798. // Connection has been closed on client
  12799. if (!line_reader.getline()) { return false; }
  12800. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12801. // clients send an extra CRLF after a request body, which would otherwise be
  12802. // parsed as the next request on a persistent connection.
  12803. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12804. return false;
  12805. }
  12806. Request req;
  12807. req.start_time_ = std::chrono::steady_clock::now();
  12808. req.remote_addr = remote_addr;
  12809. req.remote_port = remote_port;
  12810. req.local_addr = local_addr;
  12811. req.local_port = local_port;
  12812. Response res;
  12813. res.version = "HTTP/1.1";
  12814. res.headers = default_headers_;
  12815. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12816. // close the connection after that response, whichever path wrote it (an
  12817. // error status, a handler, or a rejected request). Reading on would also
  12818. // parse whatever the client sent next on a connection it considers done.
  12819. auto honor_connection_close = detail::scope_exit([&] {
  12820. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12821. connection_closed = true;
  12822. }
  12823. });
  12824. // Request line and headers. A rejected message leaves the rest of it (and
  12825. // any body) unread, so the connection cannot be reused: the leftover bytes
  12826. // would be parsed as the next request.
  12827. if (!parse_request_line(line_reader.ptr(), req)) {
  12828. connection_closed = true;
  12829. res.status = StatusCode::BadRequest_400;
  12830. output_error_log(Error::InvalidRequestLine, &req);
  12831. return write_response(strm, close_connection, req, res);
  12832. }
  12833. // Request headers
  12834. if (!detail::read_headers(strm, req.headers)) {
  12835. connection_closed = true;
  12836. res.status = StatusCode::BadRequest_400;
  12837. output_error_log(Error::InvalidHeaders, &req);
  12838. return write_response(strm, close_connection, req, res);
  12839. }
  12840. strm.set_max_timeout(0);
  12841. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12842. // which would otherwise let an intermediary and this parser disagree on
  12843. // where the body ends and enable request smuggling. Three cases: a
  12844. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12845. // or empty), which would otherwise be read as "no body"; a non-zero
  12846. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12847. // tolerated for compatibility with existing clients); and a
  12848. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12849. // length undeterminable. None of them may fall through to the "no body"
  12850. // path, or the body bytes are parsed as the next request on a persistent
  12851. // connection.
  12852. auto is_invalid_content_length = false;
  12853. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12854. is_invalid_content_length);
  12855. if (is_invalid_content_length ||
  12856. detail::has_conflicting_content_length(req.headers) ||
  12857. (req.has_header("Transfer-Encoding") &&
  12858. !detail::is_chunked_transfer_encoding(req.headers))) {
  12859. connection_closed = true;
  12860. res.status = StatusCode::BadRequest_400;
  12861. return write_response(strm, close_connection, req, res);
  12862. }
  12863. // RFC 9112 6.1: a lone "chunked" is the only transfer coding implemented
  12864. if (req.has_header("Transfer-Encoding") &&
  12865. (req.get_header_value_count("Transfer-Encoding") != 1 ||
  12866. !detail::case_ignore::equal(req.get_header_value("Transfer-Encoding"),
  12867. "chunked"))) {
  12868. connection_closed = true;
  12869. res.status = StatusCode::NotImplemented_501;
  12870. return write_response(strm, close_connection, req, res);
  12871. }
  12872. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12873. // HTTP/1.0 request, is honoured, but the connection closes after the
  12874. // response.
  12875. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  12876. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12877. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12878. // the same authority.
  12879. auto host_count = req.get_header_value_count("Host");
  12880. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12881. !detail::fields::is_host(req.get_header_value("Host"))) {
  12882. connection_closed = true;
  12883. res.status = StatusCode::BadRequest_400;
  12884. output_error_log(Error::InvalidHeaders, &req);
  12885. return write_response(strm, close_connection, req, res);
  12886. }
  12887. // Check if the request URI doesn't exceed the limit
  12888. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12889. connection_closed = true;
  12890. res.status = StatusCode::UriTooLong_414;
  12891. output_error_log(Error::ExceedUriMaxLength, &req);
  12892. return write_response(strm, close_connection, req, res);
  12893. }
  12894. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12895. connection_closed = true;
  12896. }
  12897. if (req.version == "HTTP/1.0" &&
  12898. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12899. connection_closed = true;
  12900. }
  12901. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12902. // itself a trusted proxy. Otherwise any direct client could spoof
  12903. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12904. if (detail::is_trusted_proxy(remote_addr, trusted_proxies_) &&
  12905. req.has_header("X-Forwarded-For")) {
  12906. // Some proxies append the address they observed as a separate
  12907. // X-Forwarded-For field line instead of extending the one the client sent
  12908. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12909. // be scanned. Reading only the first occurrence would hand back the
  12910. // client-supplied, and therefore forgeable, value.
  12911. auto x_forwarded_for =
  12912. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12913. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12914. req.remote_addr = derived.empty() ? remote_addr : derived;
  12915. } else {
  12916. req.remote_addr = remote_addr;
  12917. }
  12918. req.remote_port = remote_port;
  12919. req.local_addr = local_addr;
  12920. req.local_port = local_port;
  12921. if (req.has_header("Accept")) {
  12922. auto accept_header =
  12923. detail::get_combined_header_value(req.headers, "Accept");
  12924. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12925. connection_closed = true;
  12926. res.status = StatusCode::BadRequest_400;
  12927. output_error_log(Error::HTTPParsing, &req);
  12928. return write_response(strm, close_connection, req, res);
  12929. }
  12930. }
  12931. // RFC 9110 14.2: range handling is defined only for GET (and so for HEAD)
  12932. if ((req.method == "GET" || req.method == "HEAD") &&
  12933. req.has_header("Range")) {
  12934. const auto &range_header_value = req.get_header_value("Range");
  12935. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12936. connection_closed = true;
  12937. res.status = StatusCode::RangeNotSatisfiable_416;
  12938. output_error_log(Error::InvalidRangeHeader, &req);
  12939. return write_response(strm, close_connection, req, res);
  12940. }
  12941. }
  12942. if (setup_request) { setup_request(req); }
  12943. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12944. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12945. // must be ignored. An expectation we do not recognize is left alone; the
  12946. // 417 the section allows for one is a MAY, not a requirement.
  12947. //
  12948. // `100 Continue` itself is deferred until the body is actually read (see
  12949. // read_content_core), so a request rejected by a later handler never
  12950. // invites the client to send a body nobody will read.
  12951. if (req.version != "HTTP/1.0" &&
  12952. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12953. int status = StatusCode::Continue_100;
  12954. if (expect_100_continue_handler_) {
  12955. status = expect_100_continue_handler_(req, res);
  12956. }
  12957. if (status == StatusCode::Continue_100) {
  12958. req.expect_100_continue_pending_ = true;
  12959. } else {
  12960. if (res.status == -1) { res.status = status; }
  12961. connection_closed = true;
  12962. return write_response(strm, true, req, res);
  12963. }
  12964. }
  12965. // Setup `is_connection_closed` method
  12966. auto sock = strm.socket();
  12967. req.is_connection_closed = [sock]() {
  12968. return !detail::is_socket_alive(sock);
  12969. };
  12970. // WebSocket upgrade
  12971. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12972. // that authentication and other middleware can reject the request with an
  12973. // HTTP response (e.g., 401) before the protocol switches.
  12974. // The response says so when this connection closes after it.
  12975. auto close_after_response = close_connection || connection_closed;
  12976. // An upgrade request has been through pre-routing before it reaches routing()
  12977. auto is_upgrade = detail::is_websocket_upgrade(req);
  12978. if (is_upgrade) {
  12979. // A response given here leaves the body unread, and it would be parsed as
  12980. // the next request.
  12981. auto close_if_answered =
  12982. close_after_response || detail::has_framed_body(req);
  12983. const WebSocketHandlerEntry *ws_route = nullptr;
  12984. std::string selected_subprotocol;
  12985. auto answer_before_upgrade = [&]() -> bool {
  12986. if (pre_routing_handler_ &&
  12987. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12988. return true;
  12989. }
  12990. for (const auto &entry : websocket_handlers_) {
  12991. if (!entry.matcher->match(req)) { continue; }
  12992. req.matched_route = entry.matcher->pattern();
  12993. if (pre_request_handler_ &&
  12994. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12995. return true;
  12996. }
  12997. ws_route = &entry;
  12998. if (entry.sub_protocol_selector) {
  12999. auto protocol_header = detail::get_combined_header_value(
  13000. req.headers, "Sec-WebSocket-Protocol");
  13001. if (!protocol_header.empty()) {
  13002. std::vector<std::string> protocols;
  13003. detail::split(protocol_header.data(),
  13004. protocol_header.data() + protocol_header.size(), ',',
  13005. [&](const char *b, const char *e) {
  13006. protocols.emplace_back(b, e);
  13007. });
  13008. selected_subprotocol = entry.sub_protocol_selector(protocols);
  13009. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  13010. if (std::find(protocols.begin(), protocols.end(),
  13011. selected_subprotocol) == protocols.end()) {
  13012. selected_subprotocol.clear();
  13013. }
  13014. }
  13015. }
  13016. return false;
  13017. }
  13018. return false;
  13019. };
  13020. auto answered = false;
  13021. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13022. answered = answer_before_upgrade();
  13023. #else
  13024. try {
  13025. answered = answer_before_upgrade();
  13026. } catch (...) {
  13027. if (!handle_exception(req, res)) {
  13028. return write_response(strm, close_if_answered, req, res);
  13029. }
  13030. answered = true;
  13031. }
  13032. #endif
  13033. if (answered) {
  13034. if (res.status == -1) { res.status = StatusCode::OK_200; }
  13035. return write_response_with_content(strm, close_if_answered, req, res);
  13036. }
  13037. if (ws_route) {
  13038. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  13039. auto accept_key = detail::websocket_accept_key(client_key);
  13040. // Send 101 Switching Protocols
  13041. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  13042. "Upgrade: websocket\r\n"
  13043. "Connection: Upgrade\r\n"
  13044. "Sec-WebSocket-Accept: " +
  13045. accept_key + "\r\n";
  13046. if (!selected_subprotocol.empty()) {
  13047. if (!detail::fields::is_field_value(selected_subprotocol)) {
  13048. return false;
  13049. }
  13050. handshake_response +=
  13051. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  13052. }
  13053. handshake_response += "\r\n";
  13054. if (strm.write(handshake_response.data(), handshake_response.size()) <
  13055. 0) {
  13056. return false;
  13057. }
  13058. connection_closed = true;
  13059. if (websocket_upgraded) { *websocket_upgraded = true; }
  13060. #ifdef CPPHTTPLIB_SSL_ENABLED
  13061. if (req.ssl) {
  13062. // wss: the heartbeat ping thread and the read path enter the same
  13063. // TLS session from different threads. Hand the WebSocket a stream
  13064. // that serializes every TLS call, so the shared SSLSocketStream on
  13065. // the plain HTTP/HTTPS paths stays untouched.
  13066. auto ws_strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  13067. strm.socket(), const_cast<tls::session_t>(req.ssl),
  13068. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  13069. write_timeout_sec_, write_timeout_usec_));
  13070. ws::WebSocket ws(std::move(ws_strm), req, true,
  13071. websocket_ping_interval_sec_,
  13072. websocket_max_missed_pongs_);
  13073. ws_route->handler(req, ws);
  13074. return true;
  13075. }
  13076. #endif
  13077. // Use WebSocket-specific read timeout instead of HTTP timeout
  13078. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0);
  13079. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  13080. websocket_max_missed_pongs_);
  13081. ws_route->handler(req, ws);
  13082. return true;
  13083. }
  13084. // No WebSocket route: route it as a plain HTTP request
  13085. }
  13086. // Routing
  13087. auto routed = false;
  13088. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13089. routed = routing(req, res, strm, is_upgrade);
  13090. #else
  13091. try {
  13092. routed = routing(req, res, strm, is_upgrade);
  13093. } catch (...) { routed = handle_exception(req, res); }
  13094. #endif
  13095. auto ret = false;
  13096. if (routed) {
  13097. if (res.status == -1) {
  13098. res.status = req.ranges.empty() ? StatusCode::OK_200
  13099. : StatusCode::PartialContent_206;
  13100. }
  13101. // Before the Range checks below, so they see the body's own length.
  13102. detail::prefer_assigned_body(res);
  13103. // Serve file content by using a content provider
  13104. auto file_open_error = false;
  13105. if (!res.file_content_path_.empty()) {
  13106. const auto &path = res.file_content_path_;
  13107. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13108. if (!mm->is_open()) {
  13109. res.status = StatusCode::NotFound_404;
  13110. output_error_log(Error::OpenFile, &req);
  13111. file_open_error = true;
  13112. } else {
  13113. auto content_type = res.file_content_content_type_;
  13114. if (content_type.empty()) {
  13115. // One the handler set after set_file_content()
  13116. content_type = res.get_header_value("Content-Type");
  13117. }
  13118. if (content_type.empty()) {
  13119. content_type = detail::find_content_type(
  13120. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13121. }
  13122. detail::set_file_content_provider(
  13123. res, mm, content_type,
  13124. static_file_encoding(req, res, content_type, mm->size()));
  13125. }
  13126. }
  13127. if (file_open_error) {
  13128. ret = write_response(strm, close_after_response, req, res);
  13129. } else if (detail::range_error(req, res)) {
  13130. detail::clear_content(res);
  13131. res.status = StatusCode::RangeNotSatisfiable_416;
  13132. ret = write_response(strm, close_after_response, req, res);
  13133. } else {
  13134. ret = write_response_with_content(strm, close_after_response, req, res);
  13135. }
  13136. } else {
  13137. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13138. ret = write_response(strm, close_after_response, req, res);
  13139. }
  13140. // Drain any unconsumed framed body to prevent request smuggling on
  13141. // keep-alive. Without framing there is no body to drain — reading would
  13142. // consume the next request (issue #2450). If the response has committed the
  13143. // connection to close, there is no next request to protect. A body read in
  13144. // part cannot be drained from where it stopped, so the connection closes,
  13145. // as it does when the body is longer than the drain limit or does not
  13146. // arrive within the read timeout.
  13147. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13148. !detail::has_header_token(res.headers, "Connection", "close")) {
  13149. strm.set_max_timeout(read_timeout_msec);
  13150. int dummy_status;
  13151. if (req.body_read_started_ ||
  13152. !detail::read_content(
  13153. strm, req, CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH, dummy_status,
  13154. nullptr, [](const char *, size_t, size_t, size_t) { return true; },
  13155. false)) {
  13156. connection_closed = true;
  13157. }
  13158. }
  13159. return ret;
  13160. }
  13161. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13162. inline bool Server::process_and_close_socket(socket_t sock) {
  13163. std::string remote_addr;
  13164. int remote_port = 0;
  13165. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13166. std::string local_addr;
  13167. int local_port = 0;
  13168. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13169. bool websocket_upgraded = false;
  13170. auto ret = serve_guarded([&]() {
  13171. return detail::process_server_socket(
  13172. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13173. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13174. write_timeout_usec_,
  13175. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13176. return process_request(strm, remote_addr, remote_port, local_addr,
  13177. local_port, close_connection,
  13178. connection_closed, nullptr,
  13179. &websocket_upgraded);
  13180. });
  13181. });
  13182. detail::drain_and_close_socket(sock);
  13183. return ret;
  13184. }
  13185. inline void Server::output_log(const Request &req, const Response &res) const {
  13186. if (logger_) {
  13187. std::lock_guard<std::mutex> guard(logger_mutex_);
  13188. logger_(req, res);
  13189. }
  13190. }
  13191. inline void Server::output_pre_compression_log(const Request &req,
  13192. const Response &res) const {
  13193. if (pre_compression_logger_) {
  13194. std::lock_guard<std::mutex> guard(logger_mutex_);
  13195. pre_compression_logger_(req, res);
  13196. }
  13197. }
  13198. inline void Server::output_error_log(const Error &err,
  13199. const Request *req) const {
  13200. if (error_logger_) {
  13201. std::lock_guard<std::mutex> guard(logger_mutex_);
  13202. error_logger_(err, req);
  13203. }
  13204. }
  13205. /*
  13206. * Group 5: ClientImpl and Client (Universal) implementation
  13207. */
  13208. // HTTP client implementation
  13209. inline ClientImpl::ClientImpl(const std::string &host)
  13210. : ClientImpl(host, 80, std::string(), std::string()) {}
  13211. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13212. : ClientImpl(host, port, std::string(), std::string()) {}
  13213. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13214. const std::string &client_cert_path,
  13215. const std::string &client_key_path)
  13216. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13217. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13218. inline ClientImpl::~ClientImpl() {
  13219. // Wait until all the requests in flight are handled.
  13220. size_t retry_count = 10;
  13221. while (retry_count-- > 0) {
  13222. {
  13223. std::lock_guard<std::mutex> guard(socket_mutex_);
  13224. if (socket_requests_in_flight_ == 0) { break; }
  13225. }
  13226. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13227. }
  13228. std::lock_guard<std::mutex> guard(socket_mutex_);
  13229. shutdown_socket(socket_);
  13230. close_socket(socket_);
  13231. }
  13232. inline bool ClientImpl::is_valid() const { return true; }
  13233. inline bool
  13234. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13235. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13236. if (no_proxy_entries_.empty()) { return true; }
  13237. // host_ is const so its normalized form is invariant; cache it. The
  13238. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13239. if (host == host_) {
  13240. if (!host_normalized_valid_) {
  13241. host_normalized_ = detail::normalize_target(host_);
  13242. host_normalized_valid_ = true;
  13243. }
  13244. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13245. }
  13246. auto target = detail::normalize_target(host);
  13247. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13248. }
  13249. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13250. if (is_proxy_enabled_for_host(host_)) {
  13251. return detail::create_client_socket(
  13252. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13253. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13254. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13255. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13256. }
  13257. // Check is custom IP or hostname specified for host_
  13258. std::string connect_host;
  13259. std::string ip;
  13260. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13261. return detail::create_client_socket(
  13262. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13263. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13264. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13265. write_timeout_usec_, interface_, error);
  13266. }
  13267. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13268. Error &error) {
  13269. auto sock = create_client_socket(error);
  13270. if (sock == INVALID_SOCKET) { return false; }
  13271. socket.sock = sock;
  13272. return true;
  13273. }
  13274. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13275. socket_tls_settings_version_ = tls_settings_version_;
  13276. return create_and_connect_socket(socket, error);
  13277. }
  13278. inline bool ClientImpl::setup_proxy_connection(
  13279. Socket & /*socket*/,
  13280. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13281. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13282. return true;
  13283. }
  13284. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13285. bool /*shutdown_gracefully*/) {
  13286. // If there are any requests in flight from threads other than us, then it's
  13287. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13288. assert(socket_requests_in_flight_ == 0 ||
  13289. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13290. }
  13291. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13292. if (socket.sock == INVALID_SOCKET) { return; }
  13293. detail::shutdown_socket(socket.sock);
  13294. }
  13295. inline void ClientImpl::close_socket(Socket &socket) {
  13296. // If there are requests in flight in another thread, usually closing
  13297. // the socket will be fine and they will simply receive an error when
  13298. // using the closed socket, but it is still a bug since rarely the OS
  13299. // may reassign the socket id to be used for a new socket, and then
  13300. // suddenly they will be operating on a live socket that is different
  13301. // than the one they intended!
  13302. assert(socket_requests_in_flight_ == 0 ||
  13303. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13304. // It is also a bug if this happens while SSL is still active
  13305. #ifdef CPPHTTPLIB_SSL_ENABLED
  13306. assert(socket.ssl == nullptr);
  13307. #endif
  13308. if (socket.sock == INVALID_SOCKET) { return; }
  13309. detail::close_socket(socket.sock);
  13310. socket.sock = INVALID_SOCKET;
  13311. }
  13312. inline void ClientImpl::disconnect(bool gracefully) {
  13313. shutdown_ssl(socket_, gracefully);
  13314. shutdown_socket(socket_);
  13315. close_socket(socket_);
  13316. }
  13317. inline bool ClientImpl::socket_reusable() {
  13318. if (!socket_.is_open()) { return false; }
  13319. auto is_alive = detail::is_socket_alive(socket_.sock);
  13320. #ifdef CPPHTTPLIB_SSL_ENABLED
  13321. if (is_alive && is_ssl() && tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13322. is_alive = false;
  13323. }
  13324. #endif
  13325. if (!is_alive) {
  13326. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13327. disconnect(/*gracefully=*/false);
  13328. return false;
  13329. }
  13330. if (is_ssl() && socket_tls_settings_version_ != tls_settings_version_) {
  13331. disconnect(/*gracefully=*/true);
  13332. return false;
  13333. }
  13334. return true;
  13335. }
  13336. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13337. Response &res,
  13338. bool skip_100_continue) const {
  13339. std::array<char, 2048> buf{};
  13340. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13341. if (!line_reader.getline()) { return false; }
  13342. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13343. res.reason)) {
  13344. return req.method == "CONNECT";
  13345. }
  13346. // Skip interim (1xx) responses along with their header fields, except a 100
  13347. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13348. // HTTP on the connection, so it is final. A server sending them without end
  13349. // would hold the client, so there may be only so many.
  13350. size_t interim_count = 0;
  13351. while (100 <= res.status && res.status < 200 &&
  13352. res.status != StatusCode::SwitchingProtocol_101 &&
  13353. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13354. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13355. return false;
  13356. }
  13357. Headers interim_headers;
  13358. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13359. if (!line_reader.getline()) { return false; } // next response line
  13360. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13361. res.reason)) {
  13362. return false;
  13363. }
  13364. }
  13365. return true;
  13366. }
  13367. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13368. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13369. // A same-origin redirect and a digest retry send through here again. Only
  13370. // the call the caller made reports a failure, once, with its request.
  13371. auto outermost = send_depth_++ == 0;
  13372. auto se = detail::scope_exit([&] { send_depth_--; });
  13373. if (outermost) { error = Error::Success; }
  13374. auto ret = send_(req, res, error);
  13375. if (error == Error::SSLPeerCouldBeClosed_) {
  13376. assert(!ret);
  13377. ret = send_(req, res, error);
  13378. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13379. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13380. }
  13381. // Also an answer that carries an error, such as a proxy's 407
  13382. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  13383. return ret;
  13384. }
  13385. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13386. #ifdef CPPHTTPLIB_SSL_ENABLED
  13387. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13388. // client that failed to set up its TLS context keeps reporting why.
  13389. if (is_valid()) {
  13390. last_ssl_error_ = 0;
  13391. last_backend_error_ = 0;
  13392. }
  13393. #endif
  13394. {
  13395. std::lock_guard<std::mutex> guard(socket_mutex_);
  13396. // Set this to false immediately - if it ever gets set to true by the end
  13397. // of the request, we know another thread instructed us to close the
  13398. // socket.
  13399. socket_should_be_closed_when_request_is_done_ = false;
  13400. if (!socket_reusable()) {
  13401. if (!ensure_socket_connection(socket_, error)) { return false; }
  13402. {
  13403. auto success = true;
  13404. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13405. error)) {
  13406. return success;
  13407. }
  13408. }
  13409. }
  13410. // Mark the current socket as being in use so that it cannot be closed by
  13411. // anyone else while this request is ongoing, even though we will be
  13412. // releasing the mutex.
  13413. if (socket_requests_in_flight_ > 1) {
  13414. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13415. }
  13416. socket_requests_in_flight_ += 1;
  13417. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13418. }
  13419. for (const auto &header : default_headers_) {
  13420. if (req.headers.find(header.first) == req.headers.end()) {
  13421. req.headers.insert(header);
  13422. }
  13423. }
  13424. auto ret = false;
  13425. auto close_connection = !keep_alive_;
  13426. auto se = detail::scope_exit([&]() {
  13427. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13428. std::lock_guard<std::mutex> guard(socket_mutex_);
  13429. socket_requests_in_flight_ -= 1;
  13430. if (socket_requests_in_flight_ <= 0) {
  13431. assert(socket_requests_in_flight_ == 0);
  13432. socket_requests_are_from_thread_ = std::thread::id();
  13433. }
  13434. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13435. !ret) {
  13436. disconnect(/*gracefully=*/true);
  13437. }
  13438. });
  13439. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13440. return handle_request(strm, req, res, close_connection, error);
  13441. });
  13442. if (!ret) {
  13443. if (error == Error::Success) { error = Error::Unknown; }
  13444. }
  13445. return ret;
  13446. }
  13447. inline Result ClientImpl::send(const Request &req) {
  13448. auto req2 = req;
  13449. return send_(std::move(req2));
  13450. }
  13451. inline Result ClientImpl::send_(Request &&req) {
  13452. auto res = detail::make_unique<Response>();
  13453. auto error = Error::Success;
  13454. #ifdef CPPHTTPLIB_SSL_ENABLED
  13455. // Hold the request lock until the Result has read this request's TLS error
  13456. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13457. #endif
  13458. auto ret = send(req, *res, error);
  13459. #ifdef CPPHTTPLIB_SSL_ENABLED
  13460. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13461. last_ssl_error_, last_backend_error_};
  13462. #else
  13463. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13464. #endif
  13465. }
  13466. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13467. const std::string &ct) {
  13468. (void)for_stream;
  13469. // Default headers are meant for the origin and may carry its credentials, so
  13470. // keep them off the CONNECT request the proxy reads.
  13471. if (r.method != "CONNECT") {
  13472. for (const auto &header : default_headers_) {
  13473. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13474. }
  13475. }
  13476. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13477. // prepend it rather than appending it after the caller's own fields.
  13478. if (!r.has_header("Host")) {
  13479. r.headers.emplace_front(
  13480. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13481. address_family_));
  13482. }
  13483. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13484. if (!r.content_receiver) {
  13485. if (!r.has_header("Accept-Encoding")) {
  13486. std::string accept_encoding;
  13487. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13488. accept_encoding = "br";
  13489. #endif
  13490. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13491. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13492. accept_encoding += "gzip, deflate";
  13493. #endif
  13494. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13495. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13496. accept_encoding += "zstd";
  13497. #endif
  13498. r.set_header("Accept-Encoding", accept_encoding);
  13499. }
  13500. detail::add_default_user_agent_header(r);
  13501. }
  13502. if (!r.body.empty()) {
  13503. if (!ct.empty() && !r.has_header("Content-Type")) {
  13504. r.headers.emplace("Content-Type", ct);
  13505. }
  13506. if (!r.has_header("Content-Length")) {
  13507. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13508. }
  13509. }
  13510. }
  13511. inline ClientImpl::StreamHandle
  13512. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13513. const Params &params, const Headers &headers,
  13514. const std::string &body,
  13515. const std::string &content_type) {
  13516. // Encode the target exactly like the buffered send path does, so that the
  13517. // same `path` produces the same request line through either API.
  13518. auto raw_query_path =
  13519. params.empty() ? path : append_query_params(path, params);
  13520. Request req;
  13521. req.method = method;
  13522. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  13523. req.headers = headers;
  13524. req.body = body;
  13525. prepare_default_headers(req, true, content_type);
  13526. auto handle = open_stream_(req);
  13527. // Like a buffered request, a stream that fails to open is reported once
  13528. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  13529. return handle;
  13530. }
  13531. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  13532. StreamHandle handle;
  13533. handle.response = detail::make_unique<Response>();
  13534. handle.error = Error::Success;
  13535. handle.connection_ = detail::make_unique<ClientConnection>();
  13536. {
  13537. std::lock_guard<std::mutex> guard(socket_mutex_);
  13538. if (!socket_reusable()) {
  13539. if (!ensure_socket_connection(socket_, handle.error)) {
  13540. handle.response.reset();
  13541. return handle;
  13542. }
  13543. {
  13544. auto success = true;
  13545. auto start_time = std::chrono::steady_clock::now();
  13546. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13547. success, handle.error)) {
  13548. if (!success) { handle.response.reset(); }
  13549. return handle;
  13550. }
  13551. }
  13552. }
  13553. transfer_socket_ownership_to_handle(handle);
  13554. }
  13555. #ifdef CPPHTTPLIB_SSL_ENABLED
  13556. if (is_ssl() && handle.connection_->session) {
  13557. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13558. handle.connection_->sock, handle.connection_->session,
  13559. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13560. write_timeout_usec_);
  13561. } else {
  13562. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13563. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13564. write_timeout_sec_, write_timeout_usec_);
  13565. }
  13566. #else
  13567. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13568. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13569. write_timeout_sec_, write_timeout_usec_);
  13570. #endif
  13571. handle.stream_ = handle.socket_stream_.get();
  13572. auto &strm = *handle.stream_;
  13573. // After connecting, as for a buffered request
  13574. add_credential_headers(req);
  13575. // Build the request line and headers in memory first, like write_request()
  13576. // does, so that a rejected header leaves nothing on the wire.
  13577. {
  13578. detail::BufferStream bstrm;
  13579. // The path follows the authority in absolute-form, so one that does not
  13580. // begin with '/' (e.g. "@evil.example/x") would name another host.
  13581. auto prefix = proxy_target_prefix();
  13582. if ((!prefix.empty() && req.path[0] != '/') ||
  13583. detail::write_request_line(bstrm, req.method, prefix + req.path) < 0) {
  13584. handle.error = Error::Write;
  13585. handle.response.reset();
  13586. return handle;
  13587. }
  13588. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13589. handle.error)) {
  13590. handle.response.reset();
  13591. return handle;
  13592. }
  13593. const auto &data = bstrm.get_buffer();
  13594. if (!detail::write_data(strm, data.data(), data.size())) {
  13595. handle.error = Error::Write;
  13596. handle.response.reset();
  13597. return handle;
  13598. }
  13599. }
  13600. if (!req.body.empty()) {
  13601. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13602. handle.error = Error::Write;
  13603. handle.response.reset();
  13604. return handle;
  13605. }
  13606. }
  13607. if (!read_response_line(strm, req, *handle.response) ||
  13608. !detail::read_headers(strm, handle.response->headers)) {
  13609. handle.error = Error::Read;
  13610. handle.response.reset();
  13611. return handle;
  13612. }
  13613. handle.body_reader_.stream = handle.stream_;
  13614. handle.body_reader_.payload_max_length = payload_max_length_;
  13615. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  13616. // header section, so none of its framing or coding headers apply.
  13617. if (req.method == "HEAD" ||
  13618. handle.response->status == StatusCode::NoContent_204 ||
  13619. handle.response->status == StatusCode::NotModified_304) {
  13620. handle.body_reader_.eof = true;
  13621. return handle;
  13622. }
  13623. // Same framing check as ClientImpl::process_request()
  13624. if (detail::has_conflicting_content_length(handle.response->headers)) {
  13625. handle.error = Error::Read;
  13626. handle.response.reset();
  13627. return handle;
  13628. }
  13629. if (handle.response->has_header("Content-Length")) {
  13630. bool is_invalid = false;
  13631. auto content_length = detail::get_header_value_u64(
  13632. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13633. if (is_invalid) {
  13634. handle.error = Error::Read;
  13635. handle.response.reset();
  13636. return handle;
  13637. }
  13638. handle.body_reader_.has_content_length = true;
  13639. handle.body_reader_.content_length = content_length;
  13640. }
  13641. handle.body_reader_.chunked =
  13642. detail::is_chunked_transfer_encoding(handle.response->headers);
  13643. auto content_encoding = detail::get_combined_header_value(
  13644. handle.response->headers, "Content-Encoding");
  13645. if (decompress_ && !content_encoding.empty()) {
  13646. // Same policy as prepare_content_receiver(): reject a coding we know about
  13647. // but were not built with, pass an unrecognized one through as-is.
  13648. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13649. if (!handle.decompressor_) {
  13650. if (detail::is_known_content_encoding(content_encoding)) {
  13651. handle.error = Error::UnsupportedContentEncoding;
  13652. handle.response.reset();
  13653. return handle;
  13654. }
  13655. } else if (!handle.decompressor_->is_valid()) {
  13656. handle.error = Error::Compression;
  13657. handle.response.reset();
  13658. return handle;
  13659. }
  13660. }
  13661. return handle;
  13662. }
  13663. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13664. if (!is_valid() || !response) { return -1; }
  13665. auto n = decompressor_
  13666. ? read_with_decompression(buf, len)
  13667. : detail::read_body_content(stream_, body_reader_, buf, len);
  13668. if (n == 0) { parse_trailers_if_needed(); }
  13669. return n;
  13670. }
  13671. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13672. size_t len) {
  13673. if (decompress_offset_ < decompress_buffer_.size()) {
  13674. auto available = decompress_buffer_.size() - decompress_offset_;
  13675. auto to_copy = (std::min)(len, available);
  13676. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13677. decompress_offset_ += to_copy;
  13678. decompressed_bytes_read_ += to_copy;
  13679. return static_cast<ssize_t>(to_copy);
  13680. }
  13681. decompress_buffer_.clear();
  13682. decompress_offset_ = 0;
  13683. constexpr size_t kDecompressionBufferSize = 8192;
  13684. char compressed_buf[kDecompressionBufferSize];
  13685. while (true) {
  13686. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13687. sizeof(compressed_buf));
  13688. if (n <= 0) { return n; }
  13689. auto exceeded = false;
  13690. bool decompress_ok = decompressor_->decompress(
  13691. compressed_buf, static_cast<size_t>(n),
  13692. [&](const char *data, size_t data_len) {
  13693. decompress_buffer_.append(data, data_len);
  13694. auto limit = body_reader_.payload_max_length;
  13695. exceeded =
  13696. limit > 0 &&
  13697. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13698. return !exceeded;
  13699. });
  13700. if (!decompress_ok) {
  13701. body_reader_.last_error =
  13702. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13703. return -1;
  13704. }
  13705. if (!decompress_buffer_.empty()) { break; }
  13706. }
  13707. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13708. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13709. decompress_offset_ = to_copy;
  13710. decompressed_bytes_read_ += to_copy;
  13711. return static_cast<ssize_t>(to_copy);
  13712. }
  13713. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13714. // The trailers follow the last chunk, so there are none before it
  13715. auto &decoder = body_reader_.chunked_decoder;
  13716. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  13717. return;
  13718. }
  13719. trailers_parsed_ = true;
  13720. decoder->parse_trailers_into(response->trailers, response->headers);
  13721. }
  13722. namespace detail {
  13723. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13724. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13725. size_t &out_chunk_offset,
  13726. size_t &out_chunk_total) {
  13727. if (finished) { return 0; }
  13728. if (chunk_remaining == 0) {
  13729. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13730. if (!lr.getline()) { return -1; }
  13731. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13732. // the line terminator is never mistaken for line content.
  13733. const char *eol = lr.ptr() + lr.size();
  13734. if (lr.end_with_crlf()) {
  13735. eol -= 2;
  13736. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13737. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13738. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13739. // has to come off here or the check below would reject the line.
  13740. eol -= 1;
  13741. }
  13742. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13743. const char *p = lr.ptr();
  13744. int v = 0;
  13745. if (p == eol || !is_hex(*p, v)) { return -1; }
  13746. size_t chunk_len = 0;
  13747. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13748. for (; p < eol && is_hex(*p, v); ++p) {
  13749. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13750. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13751. }
  13752. while (p < eol && is_space_or_tab(*p)) {
  13753. ++p;
  13754. }
  13755. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13756. // terminator, and it is built from tokens and quoted-strings, so it never
  13757. // holds a CR, LF or any other control character. getline() reads up to the
  13758. // CRLF, so a bare LF left in here would be swallowed as extension text
  13759. // while an intermediary that ends the line on it delimits the chunks
  13760. // differently, and the two disagree on where the body ends (request
  13761. // smuggling).
  13762. if (p < eol && *p != ';') { return -1; }
  13763. for (; p < eol; ++p) {
  13764. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13765. }
  13766. // The bytes around the data are no payload, so they are counted on their
  13767. // own, as Go does: each chunk may spend 16 bytes and twice its data on
  13768. // them, which lets a stream send a byte at a time, and what goes past that
  13769. // in padding, leading zeros and extensions builds up to one header field.
  13770. overhead += lr.size() + 2;
  13771. overhead = overhead > 16 ? overhead - 16 : 0;
  13772. overhead = chunk_len > overhead / 2 ? 0 : overhead - 2 * chunk_len;
  13773. if (overhead > CPPHTTPLIB_HEADER_MAX_LENGTH) { return -1; }
  13774. if (chunk_len == 0) {
  13775. chunk_remaining = 0;
  13776. finished = true;
  13777. out_chunk_offset = 0;
  13778. out_chunk_total = 0;
  13779. return 0;
  13780. }
  13781. chunk_remaining = chunk_len;
  13782. last_chunk_total = chunk_remaining;
  13783. last_chunk_offset = 0;
  13784. }
  13785. auto to_read = (std::min)(chunk_remaining, len);
  13786. auto n = strm.read(buf, to_read);
  13787. if (n <= 0) { return -1; }
  13788. auto offset_before = last_chunk_offset;
  13789. last_chunk_offset += static_cast<size_t>(n);
  13790. chunk_remaining -= static_cast<size_t>(n);
  13791. out_chunk_offset = offset_before;
  13792. out_chunk_total = last_chunk_total;
  13793. if (chunk_remaining == 0) {
  13794. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13795. if (!lr.getline()) { return -1; }
  13796. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13797. }
  13798. return n;
  13799. }
  13800. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13801. const Headers &src_headers) {
  13802. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13803. if (!lr.getline()) { return false; }
  13804. return parse_trailers(lr, dest, src_headers);
  13805. }
  13806. // Only 301, 302, 303, 307 and 308 redirect. Any other 3xx, such as a 304, or
  13807. // a redirect without a Location, is a final response.
  13808. inline bool is_redirect(const Response &res) {
  13809. switch (res.status) {
  13810. case StatusCode::MovedPermanently_301:
  13811. case StatusCode::Found_302:
  13812. case StatusCode::SeeOther_303:
  13813. case StatusCode::TemporaryRedirect_307:
  13814. case StatusCode::PermanentRedirect_308:
  13815. return !res.get_header_value("Location").empty();
  13816. default: return false;
  13817. }
  13818. }
  13819. } // namespace detail
  13820. inline void
  13821. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13822. handle.connection_->sock = socket_.sock;
  13823. #ifdef CPPHTTPLIB_SSL_ENABLED
  13824. handle.connection_->session = socket_.ssl;
  13825. socket_.ssl = nullptr;
  13826. #endif
  13827. socket_.sock = INVALID_SOCKET;
  13828. }
  13829. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  13830. inline std::string ClientImpl::proxy_target_prefix() const {
  13831. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  13832. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  13833. }
  13834. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13835. Response &res, bool close_connection,
  13836. Error &error) {
  13837. if (req.path.empty()) {
  13838. error = Error::Connection;
  13839. return false;
  13840. }
  13841. auto req_save = req;
  13842. bool ret;
  13843. auto prefix = proxy_target_prefix();
  13844. if (!prefix.empty()) {
  13845. // The path follows the authority in absolute-form, so one that does not
  13846. // begin with '/' (e.g. "@evil.example/x") would name another host.
  13847. if (req.path[0] != '/') {
  13848. error = Error::Write;
  13849. return false;
  13850. }
  13851. auto req2 = req;
  13852. req2.path = prefix + req.path;
  13853. ret = process_request(strm, req2, res, close_connection, error);
  13854. req = std::move(req2);
  13855. req.path = req_save.path;
  13856. } else {
  13857. ret = process_request(strm, req, res, close_connection, error);
  13858. }
  13859. if (!ret) { return false; }
  13860. {
  13861. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13862. // for this to be safe.
  13863. // This is safe to call because handle_request is only called by send_
  13864. // which locks the request mutex during the process. It would be a bug
  13865. // to call it from a different thread since it's a thread-safety issue
  13866. // to do these things to the socket if another thread is using the socket.
  13867. std::lock_guard<std::mutex> guard(socket_mutex_);
  13868. // Also when the request asked for it (e.g. a body that was never sent,
  13869. // or "Connection: close"), so that a redirect or an auth retry below does
  13870. // not reuse the socket.
  13871. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13872. detail::has_header_token(res.headers, "Connection", "close") ||
  13873. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13874. disconnect(/*gracefully=*/true);
  13875. }
  13876. }
  13877. if (follow_location_ && detail::is_redirect(res)) {
  13878. req = std::move(req_save);
  13879. // The client that followed the redirect has answered any challenge it
  13880. // could. Retrying below would sign another host's challenge and send it
  13881. // here.
  13882. return redirect(req, res, error);
  13883. }
  13884. #ifdef CPPHTTPLIB_SSL_ENABLED
  13885. if ((res.status == StatusCode::Unauthorized_401 ||
  13886. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13887. req.authorization_count_ < 5) {
  13888. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13889. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13890. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13891. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13892. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13893. return ret;
  13894. }
  13895. const auto &username =
  13896. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13897. const auto &password =
  13898. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13899. if (!username.empty() && !password.empty()) {
  13900. std::map<std::string, std::string> auth;
  13901. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13902. Request new_req = req;
  13903. new_req.authorization_count_ += 1;
  13904. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13905. : "Authorization");
  13906. new_req.headers.insert(detail::make_digest_authentication_header(
  13907. req, make_request_target(req), auth, new_req.authorization_count_,
  13908. detail::random_string(10), username, password, is_proxy));
  13909. Response new_res;
  13910. ret = send(new_req, new_res, error);
  13911. if (ret) { res = std::move(new_res); }
  13912. }
  13913. }
  13914. }
  13915. #endif
  13916. return ret;
  13917. }
  13918. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13919. if (req.redirect_count_ == 0) {
  13920. error = Error::ExceedRedirectCount;
  13921. return false;
  13922. }
  13923. auto location = res.get_header_value("location");
  13924. if (location.empty()) { return false; }
  13925. detail::UrlComponents uc;
  13926. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13927. uc)) {
  13928. return false;
  13929. }
  13930. // Only follow http/https redirects
  13931. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13932. return false;
  13933. }
  13934. auto scheme = is_ssl() ? "https" : "http";
  13935. auto next_scheme = std::move(uc.scheme);
  13936. auto next_host = std::move(uc.host);
  13937. auto port_str = std::move(uc.port);
  13938. auto next_path = std::move(uc.path);
  13939. auto next_query = std::move(uc.query);
  13940. auto next_port = port_;
  13941. if (!port_str.empty()) {
  13942. if (!detail::parse_port(port_str, next_port)) { return false; }
  13943. } else if (!next_scheme.empty()) {
  13944. next_port = next_scheme == "https" ? 443 : 80;
  13945. }
  13946. if (next_scheme.empty()) { next_scheme = scheme; }
  13947. if (next_host.empty()) { next_host = host_; }
  13948. if (next_path.empty()) { next_path = "/"; }
  13949. auto path = std::move(next_path) + next_query;
  13950. // Same host redirect - use current client
  13951. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13952. return detail::redirect(*this, req, res, path, location, error);
  13953. }
  13954. // Cross-host/scheme redirect - create new client with robust setup
  13955. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13956. path, location, error);
  13957. }
  13958. // New method for robust redirect client creation
  13959. inline bool ClientImpl::create_redirect_client(
  13960. const std::string &scheme, const std::string &host, int port, Request &req,
  13961. Response &res, const std::string &path, const std::string &location,
  13962. Error &error) {
  13963. // Determine if we need SSL
  13964. auto need_ssl = (scheme == "https");
  13965. // Clean up request headers that are host/client specific
  13966. // Remove headers that should not be carried over to new host
  13967. auto headers_to_remove = std::vector<std::string>{
  13968. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13969. for (const auto &header_name : headers_to_remove) {
  13970. auto it = req.headers.find(header_name);
  13971. while (it != req.headers.end()) {
  13972. it = req.headers.erase(it);
  13973. it = req.headers.find(header_name);
  13974. }
  13975. }
  13976. // Create appropriate client type and handle redirect
  13977. if (need_ssl) {
  13978. #ifdef CPPHTTPLIB_SSL_ENABLED
  13979. // Create SSL client for HTTPS redirect
  13980. SSLClient redirect_client(host, port);
  13981. // Setup basic client configuration first
  13982. setup_redirect_client(redirect_client);
  13983. redirect_client.enable_server_certificate_verification(
  13984. server_certificate_verification_);
  13985. redirect_client.enable_server_hostname_verification(
  13986. server_hostname_verification_);
  13987. redirect_client.system_ca_mode_ = system_ca_mode_;
  13988. // Transfer CA certificate to redirect client
  13989. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13990. if (is_ssl()) {
  13991. auto &self = static_cast<SSLClient &>(*this);
  13992. // A store given to set_ca_cert_store() lives only in this client's
  13993. // context, which then holds all that is trusted.
  13994. if (self.ca_cert_store_set_) {
  13995. std::string pem;
  13996. {
  13997. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  13998. pem = detail::ca_certs_to_pem(self.ctx_);
  13999. }
  14000. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  14001. redirect_client.ca_cert_store_set_ = true;
  14002. } else if (self.custom_ca_loaded_) {
  14003. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  14004. ca_cert_pem_.size());
  14005. }
  14006. redirect_client.set_session_verifier(self.session_verifier_);
  14007. if (self.server_certificate_verifier_) {
  14008. redirect_client.set_server_certificate_verifier(
  14009. self.server_certificate_verifier_);
  14010. }
  14011. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  14012. redirect_client.enable_windows_cert_verification_ =
  14013. self.enable_windows_cert_verification_;
  14014. #endif
  14015. }
  14016. // Client certificates are set through constructor for SSLClient
  14017. // NOTE: SSLClient constructor already takes client_cert_path and
  14018. // client_key_path so we need to create it properly if client certs are
  14019. // needed
  14020. // Execute the redirect
  14021. return detail::redirect(redirect_client, req, res, path, location, error);
  14022. #else
  14023. // SSL not supported - set appropriate error
  14024. error = Error::SSLConnection;
  14025. return false;
  14026. #endif
  14027. } else {
  14028. // HTTP redirect
  14029. ClientImpl redirect_client(host, port);
  14030. // Setup client with robust configuration
  14031. setup_redirect_client(redirect_client);
  14032. // Execute the redirect
  14033. return detail::redirect(redirect_client, req, res, path, location, error);
  14034. }
  14035. }
  14036. // New method for robust client setup (based on basic_manual_redirect.cpp
  14037. // logic)
  14038. template <typename ClientType>
  14039. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  14040. // Copy basic settings first
  14041. client.set_connection_timeout(connection_timeout_sec_,
  14042. connection_timeout_usec_);
  14043. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14044. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  14045. client.set_max_timeout(max_timeout_msec_);
  14046. if (has_payload_max_length_) {
  14047. client.set_payload_max_length(payload_max_length_);
  14048. }
  14049. client.set_keep_alive(keep_alive_);
  14050. client.set_follow_location(
  14051. true); // Enable redirects to handle multi-step redirects
  14052. client.set_path_encode(path_encode_);
  14053. client.set_compress(compress_);
  14054. client.set_decompress(decompress_);
  14055. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  14056. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  14057. // 15.4, credentials must not be forwarded when redirecting to a different
  14058. // host. This function is only called for cross-host redirects; same-host
  14059. // redirects are handled directly in ClientImpl::redirect().
  14060. // Copy the proxy configuration unconditionally; the per-target bypass is
  14061. // re-evaluated at send time, so a later hop to a non-bypassed host can
  14062. // still use the proxy.
  14063. client.no_proxy_entries_ = no_proxy_entries_;
  14064. if (!proxy_host_.empty() && proxy_port_ != -1) {
  14065. client.set_proxy(proxy_host_, proxy_port_);
  14066. if (!proxy_basic_auth_username_.empty() ||
  14067. !proxy_basic_auth_password_.empty()) {
  14068. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  14069. proxy_basic_auth_password_);
  14070. }
  14071. if (!proxy_bearer_token_auth_token_.empty()) {
  14072. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  14073. }
  14074. #ifdef CPPHTTPLIB_SSL_ENABLED
  14075. if (!proxy_digest_auth_username_.empty()) {
  14076. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  14077. proxy_digest_auth_password_);
  14078. }
  14079. #endif
  14080. }
  14081. // Copy network and socket settings
  14082. client.addr_map_ = addr_map_;
  14083. client.set_address_family(address_family_);
  14084. client.set_tcp_nodelay(tcp_nodelay_);
  14085. client.set_ipv6_v6only(ipv6_v6only_);
  14086. if (socket_options_) { client.set_socket_options(socket_options_); }
  14087. if (!interface_.empty()) { client.set_interface(interface_); }
  14088. // Copy logging and headers. Not the error logger: a failure comes back to
  14089. // this client's send(), which reports it with the caller's request.
  14090. if (logger_) { client.set_logger(logger_); }
  14091. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  14092. // Each new client should generate its own headers based on its target host
  14093. }
  14094. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14095. const Request &req,
  14096. Error &error) const {
  14097. auto is_shutting_down = []() { return false; };
  14098. if (req.is_chunked_content_provider_) {
  14099. auto compressor = compress_ ? detail::create_compressor().first
  14100. : std::unique_ptr<detail::compressor>();
  14101. if (!compressor) {
  14102. compressor = detail::make_unique<detail::nocompressor>();
  14103. }
  14104. return detail::write_content_chunked(strm, req.content_provider_,
  14105. is_shutting_down, *compressor, error);
  14106. } else {
  14107. return detail::write_content_with_progress(
  14108. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14109. req.upload_progress, error);
  14110. }
  14111. }
  14112. // What goes on the request line for req: its path, encoded and without the
  14113. // fragment, with `req.params` as the query when the path has none.
  14114. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14115. auto target = detail::encode_request_target(req.path, path_encode_);
  14116. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14117. target = append_query_params(target, req.params);
  14118. }
  14119. return target;
  14120. }
  14121. inline void ClientImpl::add_credential_headers(Request &req) {
  14122. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14123. // it opens is read by the origin. Each credential goes only to its own hop.
  14124. auto is_connect = req.method == "CONNECT";
  14125. if (!is_connect) {
  14126. detail::add_authorization_header(req, basic_auth_username_,
  14127. basic_auth_password_,
  14128. bearer_token_auth_token_, false);
  14129. }
  14130. // Proxy-Authorization is only sent when the proxy reads this message —
  14131. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14132. // would leak proxy credentials to the destination server.
  14133. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14134. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14135. proxy_basic_auth_password_,
  14136. proxy_bearer_token_auth_token_, true);
  14137. }
  14138. }
  14139. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14140. bool close_connection, Error &error,
  14141. bool skip_body, bool &rejected_locally) {
  14142. rejected_locally = false;
  14143. // Prepare additional headers
  14144. if (close_connection) {
  14145. if (!req.has_header("Connection")) {
  14146. req.set_header("Connection", "close");
  14147. }
  14148. }
  14149. std::string ct_for_defaults;
  14150. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14151. ct_for_defaults = "text/plain";
  14152. }
  14153. prepare_default_headers(req, false, ct_for_defaults);
  14154. if (req.body.empty()) {
  14155. if (req.content_provider_) {
  14156. if (!req.is_chunked_content_provider_) {
  14157. if (!req.has_header("Content-Length")) {
  14158. auto length = std::to_string(req.content_length_);
  14159. req.set_header("Content-Length", length);
  14160. }
  14161. }
  14162. } else {
  14163. if (req.method == "POST" || req.method == "PUT" ||
  14164. req.method == "PATCH") {
  14165. req.set_header("Content-Length", "0");
  14166. }
  14167. }
  14168. }
  14169. add_credential_headers(req);
  14170. // Request line and headers
  14171. {
  14172. detail::BufferStream bstrm;
  14173. auto path_with_query = make_request_target(req);
  14174. // The query already came in through `req.path`; still populate
  14175. // `req.params` for handlers/users who read them.
  14176. auto query_part = detail::query_of(req.path);
  14177. if (!query_part.empty()) {
  14178. detail::parse_query_text(query_part, req.params);
  14179. }
  14180. // Write request line and headers
  14181. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14182. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14183. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14184. // fail the request cleanly instead of emitting a request-line-less,
  14185. // header-injecting request.
  14186. error = Error::Write;
  14187. rejected_locally = true;
  14188. return false;
  14189. }
  14190. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14191. error)) {
  14192. rejected_locally = true;
  14193. return false;
  14194. }
  14195. // Flush buffer
  14196. auto &data = bstrm.get_buffer();
  14197. if (!detail::write_data(strm, data.data(), data.size())) {
  14198. error = Error::Write;
  14199. return false;
  14200. }
  14201. }
  14202. // After sending request line and headers, wait briefly for an early server
  14203. // response (e.g. 4xx) and avoid sending a potentially large request body
  14204. // unnecessarily. This workaround is only enabled on Windows because Unix
  14205. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14206. // buffering can accept large writes even when the peer already responded.
  14207. // Check the stream first (which covers SSL via `is_readable()`), then
  14208. // fall back to select on the socket. Only perform the wait for very large
  14209. // request bodies to avoid interfering with normal small requests and
  14210. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14211. // response. Skip this check when using Expect: 100-continue, as the protocol
  14212. // handles early responses properly.
  14213. #if defined(_WIN32)
  14214. if (!skip_body &&
  14215. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14216. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14217. auto start = std::chrono::high_resolution_clock::now();
  14218. for (;;) {
  14219. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14220. // from SSL internals. If the underlying socket is readable, assume an
  14221. // early response may be present.
  14222. auto sock = strm.socket();
  14223. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14224. return false;
  14225. }
  14226. // Fallback to stream-level check for non-socket streams or when the
  14227. // socket isn't reporting readable. Avoid using `is_readable()` for
  14228. // SSL, since `SSL_pending()` may report buffered records that do not
  14229. // indicate a complete application-level response yet.
  14230. if (!is_ssl() && strm.is_readable()) { return false; }
  14231. auto now = std::chrono::high_resolution_clock::now();
  14232. auto elapsed =
  14233. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14234. .count();
  14235. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14236. break;
  14237. }
  14238. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14239. }
  14240. }
  14241. #endif
  14242. // Body
  14243. if (skip_body) { return true; }
  14244. return write_request_body(strm, req, error);
  14245. }
  14246. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14247. Error &error) {
  14248. if (req.body.empty()) {
  14249. return write_content_with_provider(strm, req, error);
  14250. }
  14251. if (req.upload_progress) {
  14252. auto body_size = req.body.size();
  14253. size_t written = 0;
  14254. auto data = req.body.data();
  14255. while (written < body_size) {
  14256. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14257. if (!detail::write_data(strm, data + written, to_write)) {
  14258. error = Error::Write;
  14259. return false;
  14260. }
  14261. written += to_write;
  14262. if (!req.upload_progress(written, body_size)) {
  14263. error = Error::Canceled;
  14264. return false;
  14265. }
  14266. }
  14267. } else {
  14268. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14269. error = Error::Write;
  14270. return false;
  14271. }
  14272. }
  14273. return true;
  14274. }
  14275. inline std::unique_ptr<Response>
  14276. ClientImpl::send_with_content_provider_and_receiver(
  14277. Request &req, const char *body, size_t content_length,
  14278. ContentProvider content_provider,
  14279. ContentProviderWithoutLength content_provider_without_length,
  14280. const std::string &content_type, ContentReceiver content_receiver,
  14281. Error &error) {
  14282. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14283. auto enc = compress_
  14284. ? detail::create_compressor()
  14285. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14286. nullptr, nullptr);
  14287. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14288. if (enc.first && !content_provider_without_length) {
  14289. auto &compressor = enc.first;
  14290. if (content_provider) {
  14291. auto ok = true;
  14292. auto finished = false;
  14293. size_t offset = 0;
  14294. DataSink data_sink;
  14295. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14296. if (ok) {
  14297. auto last = offset + data_len == content_length;
  14298. auto ret = compressor->compress(
  14299. data, data_len, last,
  14300. [&](const char *compressed_data, size_t compressed_data_len) {
  14301. req.body.append(compressed_data, compressed_data_len);
  14302. return true;
  14303. });
  14304. if (ret) {
  14305. offset += data_len;
  14306. } else {
  14307. ok = false;
  14308. }
  14309. }
  14310. return ok;
  14311. };
  14312. // As in detail::write_content_with_progress(): the body is framed by
  14313. // content_length, so a provider that finishes early has truncated it.
  14314. // Stop and report that instead of calling the provider forever.
  14315. data_sink.done = [&]() { finished = true; };
  14316. while (ok && !finished && offset < content_length) {
  14317. if (!content_provider(offset, content_length - offset, data_sink)) {
  14318. error = Error::Canceled;
  14319. output_error_log(error, &req);
  14320. return nullptr;
  14321. }
  14322. }
  14323. // A short body here means either the provider stopped early or the
  14324. // compressor gave up. The branch below reports a failing compressor as
  14325. // Error::Compression, so keep the two distinguishable.
  14326. if (offset < content_length) {
  14327. error = ok ? Error::Write : Error::Compression;
  14328. output_error_log(error, &req);
  14329. return nullptr;
  14330. }
  14331. } else {
  14332. if (!compressor->compress(body, content_length, true,
  14333. [&](const char *data, size_t data_len) {
  14334. req.body.append(data, data_len);
  14335. return true;
  14336. })) {
  14337. error = Error::Compression;
  14338. output_error_log(error, &req);
  14339. return nullptr;
  14340. }
  14341. }
  14342. } else {
  14343. if (content_provider) {
  14344. req.content_length_ = content_length;
  14345. req.content_provider_ = std::move(content_provider);
  14346. req.is_chunked_content_provider_ = false;
  14347. } else if (content_provider_without_length) {
  14348. req.content_length_ = 0;
  14349. req.content_provider_ = detail::ContentProviderAdapter(
  14350. std::move(content_provider_without_length));
  14351. req.is_chunked_content_provider_ = true;
  14352. req.set_header("Transfer-Encoding", "chunked");
  14353. } else {
  14354. req.body.assign(body, content_length);
  14355. }
  14356. }
  14357. if (content_receiver) {
  14358. req.content_receiver =
  14359. [content_receiver](const char *data, size_t data_length,
  14360. size_t /*offset*/, size_t /*total_length*/) {
  14361. return content_receiver(data, data_length);
  14362. };
  14363. }
  14364. auto res = detail::make_unique<Response>();
  14365. return send(req, *res, error) ? std::move(res) : nullptr;
  14366. }
  14367. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14368. const std::string &method, const std::string &path, const Headers &headers,
  14369. const char *body, size_t content_length, ContentProvider content_provider,
  14370. ContentProviderWithoutLength content_provider_without_length,
  14371. const std::string &content_type, ContentReceiver content_receiver,
  14372. UploadProgress progress) {
  14373. Request req;
  14374. req.method = method;
  14375. req.headers = headers;
  14376. req.path = path;
  14377. req.upload_progress = std::move(progress);
  14378. if (max_timeout_msec_ > 0) {
  14379. req.start_time_ = std::chrono::steady_clock::now();
  14380. }
  14381. auto error = Error::Success;
  14382. #ifdef CPPHTTPLIB_SSL_ENABLED
  14383. // Hold the request lock until the Result has read this request's TLS error
  14384. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14385. #endif
  14386. auto res = send_with_content_provider_and_receiver(
  14387. req, body, content_length, std::move(content_provider),
  14388. std::move(content_provider_without_length), content_type,
  14389. std::move(content_receiver), error);
  14390. #ifdef CPPHTTPLIB_SSL_ENABLED
  14391. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14392. last_backend_error_};
  14393. #else
  14394. return Result{std::move(res), error, std::move(req.headers)};
  14395. #endif
  14396. }
  14397. inline void ClientImpl::output_log(const Request &req,
  14398. const Response &res) const {
  14399. if (logger_) {
  14400. std::lock_guard<std::mutex> guard(logger_mutex_);
  14401. logger_(req, res);
  14402. }
  14403. }
  14404. inline void ClientImpl::output_error_log(const Error &err,
  14405. const Request *req) const {
  14406. if (error_logger_) {
  14407. std::lock_guard<std::mutex> guard(logger_mutex_);
  14408. error_logger_(err, req);
  14409. }
  14410. }
  14411. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14412. Response &res, bool close_connection,
  14413. Error &error) {
  14414. // Auto-add Expect: 100-continue for large bodies
  14415. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14416. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14417. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14418. req.set_header("Expect", "100-continue");
  14419. }
  14420. }
  14421. // Check for Expect: 100-continue
  14422. auto expect_100_continue =
  14423. detail::has_header_token(req.headers, "Expect", "100-continue");
  14424. // Send request (skip body if using Expect: 100-continue)
  14425. auto rejected_locally = false;
  14426. auto write_request_success =
  14427. write_request(strm, req, close_connection, error, expect_100_continue,
  14428. rejected_locally);
  14429. // A failed write normally still reads the response below, since the server
  14430. // may have answered early (e.g. 413/414) and closed while the body was being
  14431. // sent. A request rejected before any byte reached the socket gets no such
  14432. // response, and waiting for one would block until the read timeout.
  14433. if (rejected_locally) { return false; }
  14434. #ifdef CPPHTTPLIB_SSL_ENABLED
  14435. if (is_ssl() && !expect_100_continue) {
  14436. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14437. if (!is_proxy_enabled) {
  14438. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14439. error = Error::SSLPeerCouldBeClosed_;
  14440. return false;
  14441. }
  14442. }
  14443. }
  14444. #endif
  14445. // Handle Expect: 100-continue.
  14446. //
  14447. // Wait for an interim/early response by attempting to read the status line
  14448. // under a short timeout, instead of trusting raw socket readability. Over
  14449. // TLS, post-handshake records (e.g. session tickets) make the socket
  14450. // readable without any HTTP response being available; relying on
  14451. // `select_read` there caused the body to be withheld forever and the
  14452. // request to fail with `Read` (#2458). If no status line arrives within the
  14453. // timeout, send the body anyway (matching curl's behavior).
  14454. auto status_line_read = false;
  14455. if (expect_100_continue && write_request_success) {
  14456. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14457. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14458. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14459. strm.set_read_timeout(sec, usec);
  14460. status_line_read = read_response_line(strm, req, res, false);
  14461. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14462. }
  14463. if (!status_line_read) {
  14464. // No interim response within the timeout: send the body and handle the
  14465. // response as usual.
  14466. if (!write_request_body(strm, req, error)) { return false; }
  14467. expect_100_continue = false; // Switch to normal response handling
  14468. }
  14469. }
  14470. // Receive response and headers
  14471. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14472. if ((!status_line_read &&
  14473. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14474. !detail::read_headers(strm, res.headers)) {
  14475. if (write_request_success) { error = Error::Read; }
  14476. return false;
  14477. }
  14478. if (!write_request_success) { return false; }
  14479. // Handle Expect: 100-continue response
  14480. if (expect_100_continue) {
  14481. if (res.status == StatusCode::Continue_100) {
  14482. // Server accepted, send the body
  14483. if (!write_request_body(strm, req, error)) { return false; }
  14484. // Read the actual response
  14485. res.headers.clear();
  14486. res.body.clear();
  14487. if (!read_response_line(strm, req, res) ||
  14488. !detail::read_headers(strm, res.headers)) {
  14489. error = Error::Read;
  14490. return false;
  14491. }
  14492. } else {
  14493. // A final response came first, so the body this request declared was
  14494. // never sent, and the server may still be waiting for it. The
  14495. // connection cannot carry another request.
  14496. std::lock_guard<std::mutex> guard(socket_mutex_);
  14497. socket_should_be_closed_when_request_is_done_ = true;
  14498. }
  14499. }
  14500. // Body
  14501. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14502. req.method != "CONNECT") {
  14503. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14504. // whose final transfer coding is not chunked is not ambiguous: its body
  14505. // runs until the server closes the connection, so it is not rejected.
  14506. // HEAD/204 are excluded above and a 304 carries no body.
  14507. if (res.status != StatusCode::NotModified_304) {
  14508. if (detail::has_conflicting_content_length(res.headers)) {
  14509. error = Error::Read;
  14510. return false;
  14511. }
  14512. if (detail::has_faulty_transfer_encoding(res)) {
  14513. std::lock_guard<std::mutex> guard(socket_mutex_);
  14514. socket_should_be_closed_when_request_is_done_ = true;
  14515. }
  14516. }
  14517. auto redirect = follow_location_ && detail::is_redirect(res);
  14518. if (req.response_handler && !redirect) {
  14519. if (!req.response_handler(res)) {
  14520. error = Error::Canceled;
  14521. return false;
  14522. }
  14523. }
  14524. auto out =
  14525. req.content_receiver
  14526. ? static_cast<ContentReceiverWithProgress>(
  14527. [&](const char *buf, size_t n, size_t off, size_t len) {
  14528. if (redirect) { return true; }
  14529. auto ret = req.content_receiver(buf, n, off, len);
  14530. if (!ret) { error = Error::Canceled; }
  14531. return ret;
  14532. })
  14533. : static_cast<ContentReceiverWithProgress>(
  14534. [&](const char *buf, size_t n, size_t /*off*/,
  14535. size_t /*len*/) {
  14536. assert(res.body.size() + n <= res.body.max_size());
  14537. if (payload_max_length_ > 0 &&
  14538. (res.body.size() >= payload_max_length_ ||
  14539. n > payload_max_length_ - res.body.size())) {
  14540. return false;
  14541. }
  14542. res.body.append(buf, n);
  14543. return true;
  14544. });
  14545. auto progress = [&](size_t current, size_t total) {
  14546. if (!req.download_progress || redirect) { return true; }
  14547. auto ret = req.download_progress(current, total);
  14548. if (!ret) { error = Error::Canceled; }
  14549. return ret;
  14550. };
  14551. if (res.has_header("Content-Length")) {
  14552. if (!req.content_receiver) {
  14553. auto len = res.get_header_value_u64("Content-Length");
  14554. if (len > res.body.max_size()) {
  14555. error = Error::Read;
  14556. return false;
  14557. }
  14558. // Content-Length is only the server's claim, so reserve no more than
  14559. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14560. // body has arrived. A longer body grows as it is read.
  14561. auto reserve_len =
  14562. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14563. if (payload_max_length_ > 0) {
  14564. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14565. }
  14566. res.body.reserve(reserve_len);
  14567. }
  14568. }
  14569. if (res.status != StatusCode::NotModified_304) {
  14570. auto content_status = 0;
  14571. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14572. ? (std::numeric_limits<size_t>::max)()
  14573. : payload_max_length_;
  14574. if (!detail::read_content(strm, res, max_length, content_status,
  14575. std::move(progress), std::move(out),
  14576. decompress_)) {
  14577. if (error != Error::Canceled) {
  14578. // Tell the caller apart from a plain read failure when the body was
  14579. // over the payload limit or could not be decoded because of its
  14580. // Content-Encoding.
  14581. switch (content_status) {
  14582. case StatusCode::PayloadTooLarge_413:
  14583. error = Error::ExceedMaxPayloadSize;
  14584. break;
  14585. case StatusCode::UnsupportedMediaType_415:
  14586. error = Error::UnsupportedContentEncoding;
  14587. break;
  14588. case StatusCode::InternalServerError_500:
  14589. error = Error::Compression;
  14590. break;
  14591. default: error = Error::Read; break;
  14592. }
  14593. }
  14594. return false;
  14595. }
  14596. }
  14597. }
  14598. // Log
  14599. output_log(req, res);
  14600. return true;
  14601. }
  14602. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14603. const std::string &boundary, const UploadFormDataItems &items,
  14604. const FormDataProviderItems &provider_items) const {
  14605. size_t cur_item = 0;
  14606. size_t cur_start = 0;
  14607. // cur_item and cur_start are copied to within the std::function and
  14608. // maintain state between successive calls
  14609. return [&, cur_item, cur_start](size_t offset,
  14610. DataSink &sink) mutable -> bool {
  14611. if (!offset && !items.empty()) {
  14612. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14613. return true;
  14614. } else if (cur_item < provider_items.size()) {
  14615. if (!cur_start) {
  14616. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14617. provider_items[cur_item], boundary);
  14618. offset += begin.size();
  14619. cur_start = offset;
  14620. sink.os << begin;
  14621. }
  14622. DataSink cur_sink;
  14623. auto has_data = true;
  14624. cur_sink.write = sink.write;
  14625. // Forward is_writable so a provider item asking whether it may keep
  14626. // going gets the outer sink's answer rather than the default `true`.
  14627. cur_sink.is_writable = sink.is_writable;
  14628. cur_sink.done = [&]() { has_data = false; };
  14629. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14630. return false;
  14631. }
  14632. if (!has_data) {
  14633. sink.os << detail::serialize_multipart_formdata_item_end();
  14634. cur_item++;
  14635. cur_start = 0;
  14636. }
  14637. return true;
  14638. } else {
  14639. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14640. sink.done();
  14641. return true;
  14642. }
  14643. };
  14644. }
  14645. inline bool ClientImpl::process_socket(
  14646. const Socket &socket,
  14647. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14648. std::function<bool(Stream &strm)> callback) {
  14649. return detail::process_client_socket(
  14650. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14651. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14652. }
  14653. inline bool ClientImpl::is_ssl() const { return false; }
  14654. inline Result ClientImpl::Get(const std::string &path,
  14655. DownloadProgress progress) {
  14656. return Get(path, Headers(), std::move(progress));
  14657. }
  14658. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14659. DownloadProgress progress) {
  14660. return Get(path, params, Headers(), std::move(progress));
  14661. }
  14662. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14663. const Headers &headers,
  14664. DownloadProgress progress) {
  14665. if (params.empty()) { return Get(path, headers); }
  14666. std::string path_with_query = append_query_params(path, params);
  14667. return Get(path_with_query, headers, std::move(progress));
  14668. }
  14669. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14670. DownloadProgress progress) {
  14671. Request req;
  14672. req.method = "GET";
  14673. req.path = path;
  14674. req.headers = headers;
  14675. req.download_progress = std::move(progress);
  14676. if (max_timeout_msec_ > 0) {
  14677. req.start_time_ = std::chrono::steady_clock::now();
  14678. }
  14679. return send_(std::move(req));
  14680. }
  14681. inline Result ClientImpl::Get(const std::string &path,
  14682. ContentReceiver content_receiver,
  14683. DownloadProgress progress) {
  14684. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14685. std::move(progress));
  14686. }
  14687. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14688. ContentReceiver content_receiver,
  14689. DownloadProgress progress) {
  14690. return Get(path, headers, nullptr, std::move(content_receiver),
  14691. std::move(progress));
  14692. }
  14693. inline Result ClientImpl::Get(const std::string &path,
  14694. ResponseHandler response_handler,
  14695. ContentReceiver content_receiver,
  14696. DownloadProgress progress) {
  14697. return Get(path, Headers(), std::move(response_handler),
  14698. std::move(content_receiver), std::move(progress));
  14699. }
  14700. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14701. ResponseHandler response_handler,
  14702. ContentReceiver content_receiver,
  14703. DownloadProgress progress) {
  14704. Request req;
  14705. req.method = "GET";
  14706. req.path = path;
  14707. req.headers = headers;
  14708. req.response_handler = std::move(response_handler);
  14709. req.content_receiver =
  14710. [content_receiver](const char *data, size_t data_length,
  14711. size_t /*offset*/, size_t /*total_length*/) {
  14712. return content_receiver(data, data_length);
  14713. };
  14714. req.download_progress = std::move(progress);
  14715. if (max_timeout_msec_ > 0) {
  14716. req.start_time_ = std::chrono::steady_clock::now();
  14717. }
  14718. return send_(std::move(req));
  14719. }
  14720. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14721. const Headers &headers,
  14722. ContentReceiver content_receiver,
  14723. DownloadProgress progress) {
  14724. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14725. std::move(progress));
  14726. }
  14727. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14728. const Headers &headers,
  14729. ResponseHandler response_handler,
  14730. ContentReceiver content_receiver,
  14731. DownloadProgress progress) {
  14732. if (params.empty()) {
  14733. return Get(path, headers, std::move(response_handler),
  14734. std::move(content_receiver), std::move(progress));
  14735. }
  14736. std::string path_with_query = append_query_params(path, params);
  14737. return Get(path_with_query, headers, std::move(response_handler),
  14738. std::move(content_receiver), std::move(progress));
  14739. }
  14740. inline Result ClientImpl::Head(const std::string &path) {
  14741. return Head(path, Headers());
  14742. }
  14743. inline Result ClientImpl::Head(const std::string &path,
  14744. const Headers &headers) {
  14745. Request req;
  14746. req.method = "HEAD";
  14747. req.headers = headers;
  14748. req.path = path;
  14749. if (max_timeout_msec_ > 0) {
  14750. req.start_time_ = std::chrono::steady_clock::now();
  14751. }
  14752. return send_(std::move(req));
  14753. }
  14754. inline Result ClientImpl::Post(const std::string &path) {
  14755. return Post(path, std::string(), std::string());
  14756. }
  14757. inline Result ClientImpl::Post(const std::string &path,
  14758. const Headers &headers) {
  14759. return Post(path, headers, nullptr, 0, std::string());
  14760. }
  14761. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14762. size_t content_length,
  14763. const std::string &content_type,
  14764. UploadProgress progress) {
  14765. return Post(path, Headers(), body, content_length, content_type, progress);
  14766. }
  14767. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14768. const std::string &content_type,
  14769. UploadProgress progress) {
  14770. return Post(path, Headers(), body, content_type, progress);
  14771. }
  14772. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14773. return Post(path, Headers(), params);
  14774. }
  14775. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14776. ContentProvider content_provider,
  14777. const std::string &content_type,
  14778. UploadProgress progress) {
  14779. return Post(path, Headers(), content_length, std::move(content_provider),
  14780. content_type, progress);
  14781. }
  14782. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14783. ContentProvider content_provider,
  14784. const std::string &content_type,
  14785. ContentReceiver content_receiver,
  14786. UploadProgress progress) {
  14787. return Post(path, Headers(), content_length, std::move(content_provider),
  14788. content_type, std::move(content_receiver), progress);
  14789. }
  14790. inline Result ClientImpl::Post(const std::string &path,
  14791. ContentProviderWithoutLength content_provider,
  14792. const std::string &content_type,
  14793. UploadProgress progress) {
  14794. return Post(path, Headers(), std::move(content_provider), content_type,
  14795. progress);
  14796. }
  14797. inline Result ClientImpl::Post(const std::string &path,
  14798. ContentProviderWithoutLength content_provider,
  14799. const std::string &content_type,
  14800. ContentReceiver content_receiver,
  14801. UploadProgress progress) {
  14802. return Post(path, Headers(), std::move(content_provider), content_type,
  14803. std::move(content_receiver), progress);
  14804. }
  14805. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14806. const Params &params) {
  14807. auto query = detail::params_to_query_str(params);
  14808. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14809. }
  14810. inline Result ClientImpl::Post(const std::string &path,
  14811. const UploadFormDataItems &items,
  14812. UploadProgress progress) {
  14813. return Post(path, Headers(), items, progress);
  14814. }
  14815. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14816. const UploadFormDataItems &items,
  14817. UploadProgress progress) {
  14818. const auto &boundary = detail::make_multipart_data_boundary();
  14819. const auto &content_type =
  14820. detail::serialize_multipart_formdata_get_content_type(boundary);
  14821. auto content_length = detail::get_multipart_content_length(items, boundary);
  14822. return Post(path, headers, content_length,
  14823. detail::make_multipart_content_provider(items, boundary),
  14824. content_type, progress);
  14825. }
  14826. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14827. const UploadFormDataItems &items,
  14828. const std::string &boundary,
  14829. UploadProgress progress) {
  14830. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14831. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14832. }
  14833. const auto &content_type =
  14834. detail::serialize_multipart_formdata_get_content_type(boundary);
  14835. auto content_length = detail::get_multipart_content_length(items, boundary);
  14836. return Post(path, headers, content_length,
  14837. detail::make_multipart_content_provider(items, boundary),
  14838. content_type, progress);
  14839. }
  14840. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14841. const char *body, size_t content_length,
  14842. const std::string &content_type,
  14843. UploadProgress progress) {
  14844. return send_with_content_provider_and_receiver(
  14845. "POST", path, headers, body, content_length, nullptr, nullptr,
  14846. content_type, nullptr, progress);
  14847. }
  14848. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14849. const std::string &body,
  14850. const std::string &content_type,
  14851. UploadProgress progress) {
  14852. return send_with_content_provider_and_receiver(
  14853. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14854. content_type, nullptr, progress);
  14855. }
  14856. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14857. size_t content_length,
  14858. ContentProvider content_provider,
  14859. const std::string &content_type,
  14860. UploadProgress progress) {
  14861. return send_with_content_provider_and_receiver(
  14862. "POST", path, headers, nullptr, content_length,
  14863. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14864. }
  14865. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14866. size_t content_length,
  14867. ContentProvider content_provider,
  14868. const std::string &content_type,
  14869. ContentReceiver content_receiver,
  14870. DownloadProgress progress) {
  14871. return send_with_content_provider_and_receiver(
  14872. "POST", path, headers, nullptr, content_length,
  14873. std::move(content_provider), nullptr, content_type,
  14874. std::move(content_receiver), std::move(progress));
  14875. }
  14876. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14877. ContentProviderWithoutLength content_provider,
  14878. const std::string &content_type,
  14879. UploadProgress progress) {
  14880. return send_with_content_provider_and_receiver(
  14881. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14882. content_type, nullptr, progress);
  14883. }
  14884. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14885. ContentProviderWithoutLength content_provider,
  14886. const std::string &content_type,
  14887. ContentReceiver content_receiver,
  14888. DownloadProgress progress) {
  14889. return send_with_content_provider_and_receiver(
  14890. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14891. content_type, std::move(content_receiver), std::move(progress));
  14892. }
  14893. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14894. const UploadFormDataItems &items,
  14895. const FormDataProviderItems &provider_items,
  14896. UploadProgress progress) {
  14897. const auto &boundary = detail::make_multipart_data_boundary();
  14898. const auto &content_type =
  14899. detail::serialize_multipart_formdata_get_content_type(boundary);
  14900. return send_with_content_provider_and_receiver(
  14901. "POST", path, headers, nullptr, 0, nullptr,
  14902. get_multipart_content_provider(boundary, items, provider_items),
  14903. content_type, nullptr, progress);
  14904. }
  14905. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14906. const std::string &body,
  14907. const std::string &content_type,
  14908. ContentReceiver content_receiver,
  14909. DownloadProgress progress) {
  14910. Request req;
  14911. req.method = "POST";
  14912. req.path = path;
  14913. req.headers = headers;
  14914. req.body = body;
  14915. req.content_receiver =
  14916. [content_receiver](const char *data, size_t data_length,
  14917. size_t /*offset*/, size_t /*total_length*/) {
  14918. return content_receiver(data, data_length);
  14919. };
  14920. req.download_progress = std::move(progress);
  14921. if (max_timeout_msec_ > 0) {
  14922. req.start_time_ = std::chrono::steady_clock::now();
  14923. }
  14924. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14925. return send_(std::move(req));
  14926. }
  14927. inline Result ClientImpl::Put(const std::string &path) {
  14928. return Put(path, std::string(), std::string());
  14929. }
  14930. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14931. return Put(path, headers, nullptr, 0, std::string());
  14932. }
  14933. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14934. size_t content_length,
  14935. const std::string &content_type,
  14936. UploadProgress progress) {
  14937. return Put(path, Headers(), body, content_length, content_type, progress);
  14938. }
  14939. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14940. const std::string &content_type,
  14941. UploadProgress progress) {
  14942. return Put(path, Headers(), body, content_type, progress);
  14943. }
  14944. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14945. return Put(path, Headers(), params);
  14946. }
  14947. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14948. ContentProvider content_provider,
  14949. const std::string &content_type,
  14950. UploadProgress progress) {
  14951. return Put(path, Headers(), content_length, std::move(content_provider),
  14952. content_type, progress);
  14953. }
  14954. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14955. ContentProvider content_provider,
  14956. const std::string &content_type,
  14957. ContentReceiver content_receiver,
  14958. UploadProgress progress) {
  14959. return Put(path, Headers(), content_length, std::move(content_provider),
  14960. content_type, std::move(content_receiver), progress);
  14961. }
  14962. inline Result ClientImpl::Put(const std::string &path,
  14963. ContentProviderWithoutLength content_provider,
  14964. const std::string &content_type,
  14965. UploadProgress progress) {
  14966. return Put(path, Headers(), std::move(content_provider), content_type,
  14967. progress);
  14968. }
  14969. inline Result ClientImpl::Put(const std::string &path,
  14970. ContentProviderWithoutLength content_provider,
  14971. const std::string &content_type,
  14972. ContentReceiver content_receiver,
  14973. UploadProgress progress) {
  14974. return Put(path, Headers(), std::move(content_provider), content_type,
  14975. std::move(content_receiver), progress);
  14976. }
  14977. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14978. const Params &params) {
  14979. auto query = detail::params_to_query_str(params);
  14980. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14981. }
  14982. inline Result ClientImpl::Put(const std::string &path,
  14983. const UploadFormDataItems &items,
  14984. UploadProgress progress) {
  14985. return Put(path, Headers(), items, progress);
  14986. }
  14987. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14988. const UploadFormDataItems &items,
  14989. UploadProgress progress) {
  14990. const auto &boundary = detail::make_multipart_data_boundary();
  14991. const auto &content_type =
  14992. detail::serialize_multipart_formdata_get_content_type(boundary);
  14993. auto content_length = detail::get_multipart_content_length(items, boundary);
  14994. return Put(path, headers, content_length,
  14995. detail::make_multipart_content_provider(items, boundary),
  14996. content_type, progress);
  14997. }
  14998. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14999. const UploadFormDataItems &items,
  15000. const std::string &boundary,
  15001. UploadProgress progress) {
  15002. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15003. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15004. }
  15005. const auto &content_type =
  15006. detail::serialize_multipart_formdata_get_content_type(boundary);
  15007. auto content_length = detail::get_multipart_content_length(items, boundary);
  15008. return Put(path, headers, content_length,
  15009. detail::make_multipart_content_provider(items, boundary),
  15010. content_type, progress);
  15011. }
  15012. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15013. const char *body, size_t content_length,
  15014. const std::string &content_type,
  15015. UploadProgress progress) {
  15016. return send_with_content_provider_and_receiver(
  15017. "PUT", path, headers, body, content_length, nullptr, nullptr,
  15018. content_type, nullptr, progress);
  15019. }
  15020. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15021. const std::string &body,
  15022. const std::string &content_type,
  15023. UploadProgress progress) {
  15024. return send_with_content_provider_and_receiver(
  15025. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  15026. content_type, nullptr, progress);
  15027. }
  15028. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15029. size_t content_length,
  15030. ContentProvider content_provider,
  15031. const std::string &content_type,
  15032. UploadProgress progress) {
  15033. return send_with_content_provider_and_receiver(
  15034. "PUT", path, headers, nullptr, content_length,
  15035. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15036. }
  15037. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15038. size_t content_length,
  15039. ContentProvider content_provider,
  15040. const std::string &content_type,
  15041. ContentReceiver content_receiver,
  15042. UploadProgress progress) {
  15043. return send_with_content_provider_and_receiver(
  15044. "PUT", path, headers, nullptr, content_length,
  15045. std::move(content_provider), nullptr, content_type,
  15046. std::move(content_receiver), progress);
  15047. }
  15048. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15049. ContentProviderWithoutLength content_provider,
  15050. const std::string &content_type,
  15051. UploadProgress progress) {
  15052. return send_with_content_provider_and_receiver(
  15053. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15054. content_type, nullptr, progress);
  15055. }
  15056. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15057. ContentProviderWithoutLength content_provider,
  15058. const std::string &content_type,
  15059. ContentReceiver content_receiver,
  15060. UploadProgress progress) {
  15061. return send_with_content_provider_and_receiver(
  15062. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15063. content_type, std::move(content_receiver), progress);
  15064. }
  15065. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15066. const UploadFormDataItems &items,
  15067. const FormDataProviderItems &provider_items,
  15068. UploadProgress progress) {
  15069. const auto &boundary = detail::make_multipart_data_boundary();
  15070. const auto &content_type =
  15071. detail::serialize_multipart_formdata_get_content_type(boundary);
  15072. return send_with_content_provider_and_receiver(
  15073. "PUT", path, headers, nullptr, 0, nullptr,
  15074. get_multipart_content_provider(boundary, items, provider_items),
  15075. content_type, nullptr, progress);
  15076. }
  15077. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15078. const std::string &body,
  15079. const std::string &content_type,
  15080. ContentReceiver content_receiver,
  15081. DownloadProgress progress) {
  15082. Request req;
  15083. req.method = "PUT";
  15084. req.path = path;
  15085. req.headers = headers;
  15086. req.body = body;
  15087. req.content_receiver =
  15088. [content_receiver](const char *data, size_t data_length,
  15089. size_t /*offset*/, size_t /*total_length*/) {
  15090. return content_receiver(data, data_length);
  15091. };
  15092. req.download_progress = std::move(progress);
  15093. if (max_timeout_msec_ > 0) {
  15094. req.start_time_ = std::chrono::steady_clock::now();
  15095. }
  15096. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15097. return send_(std::move(req));
  15098. }
  15099. inline Result ClientImpl::Patch(const std::string &path) {
  15100. return Patch(path, std::string(), std::string());
  15101. }
  15102. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15103. UploadProgress progress) {
  15104. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15105. }
  15106. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15107. size_t content_length,
  15108. const std::string &content_type,
  15109. UploadProgress progress) {
  15110. return Patch(path, Headers(), body, content_length, content_type, progress);
  15111. }
  15112. inline Result ClientImpl::Patch(const std::string &path,
  15113. const std::string &body,
  15114. const std::string &content_type,
  15115. UploadProgress progress) {
  15116. return Patch(path, Headers(), body, content_type, progress);
  15117. }
  15118. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15119. return Patch(path, Headers(), params);
  15120. }
  15121. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15122. ContentProvider content_provider,
  15123. const std::string &content_type,
  15124. UploadProgress progress) {
  15125. return Patch(path, Headers(), content_length, std::move(content_provider),
  15126. content_type, progress);
  15127. }
  15128. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15129. ContentProvider content_provider,
  15130. const std::string &content_type,
  15131. ContentReceiver content_receiver,
  15132. UploadProgress progress) {
  15133. return Patch(path, Headers(), content_length, std::move(content_provider),
  15134. content_type, std::move(content_receiver), progress);
  15135. }
  15136. inline Result ClientImpl::Patch(const std::string &path,
  15137. ContentProviderWithoutLength content_provider,
  15138. const std::string &content_type,
  15139. UploadProgress progress) {
  15140. return Patch(path, Headers(), std::move(content_provider), content_type,
  15141. progress);
  15142. }
  15143. inline Result ClientImpl::Patch(const std::string &path,
  15144. ContentProviderWithoutLength content_provider,
  15145. const std::string &content_type,
  15146. ContentReceiver content_receiver,
  15147. UploadProgress progress) {
  15148. return Patch(path, Headers(), std::move(content_provider), content_type,
  15149. std::move(content_receiver), progress);
  15150. }
  15151. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15152. const Params &params) {
  15153. auto query = detail::params_to_query_str(params);
  15154. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15155. }
  15156. inline Result ClientImpl::Patch(const std::string &path,
  15157. const UploadFormDataItems &items,
  15158. UploadProgress progress) {
  15159. return Patch(path, Headers(), items, progress);
  15160. }
  15161. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15162. const UploadFormDataItems &items,
  15163. UploadProgress progress) {
  15164. const auto &boundary = detail::make_multipart_data_boundary();
  15165. const auto &content_type =
  15166. detail::serialize_multipart_formdata_get_content_type(boundary);
  15167. auto content_length = detail::get_multipart_content_length(items, boundary);
  15168. return Patch(path, headers, content_length,
  15169. detail::make_multipart_content_provider(items, boundary),
  15170. content_type, progress);
  15171. }
  15172. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15173. const UploadFormDataItems &items,
  15174. const std::string &boundary,
  15175. UploadProgress progress) {
  15176. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15177. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15178. }
  15179. const auto &content_type =
  15180. detail::serialize_multipart_formdata_get_content_type(boundary);
  15181. auto content_length = detail::get_multipart_content_length(items, boundary);
  15182. return Patch(path, headers, content_length,
  15183. detail::make_multipart_content_provider(items, boundary),
  15184. content_type, progress);
  15185. }
  15186. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15187. const char *body, size_t content_length,
  15188. const std::string &content_type,
  15189. UploadProgress progress) {
  15190. return send_with_content_provider_and_receiver(
  15191. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15192. content_type, nullptr, progress);
  15193. }
  15194. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15195. const std::string &body,
  15196. const std::string &content_type,
  15197. UploadProgress progress) {
  15198. return send_with_content_provider_and_receiver(
  15199. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15200. content_type, nullptr, progress);
  15201. }
  15202. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15203. size_t content_length,
  15204. ContentProvider content_provider,
  15205. const std::string &content_type,
  15206. UploadProgress progress) {
  15207. return send_with_content_provider_and_receiver(
  15208. "PATCH", path, headers, nullptr, content_length,
  15209. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15210. }
  15211. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15212. size_t content_length,
  15213. ContentProvider content_provider,
  15214. const std::string &content_type,
  15215. ContentReceiver content_receiver,
  15216. UploadProgress progress) {
  15217. return send_with_content_provider_and_receiver(
  15218. "PATCH", path, headers, nullptr, content_length,
  15219. std::move(content_provider), nullptr, content_type,
  15220. std::move(content_receiver), progress);
  15221. }
  15222. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15223. ContentProviderWithoutLength content_provider,
  15224. const std::string &content_type,
  15225. UploadProgress progress) {
  15226. return send_with_content_provider_and_receiver(
  15227. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15228. content_type, nullptr, progress);
  15229. }
  15230. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15231. ContentProviderWithoutLength content_provider,
  15232. const std::string &content_type,
  15233. ContentReceiver content_receiver,
  15234. UploadProgress progress) {
  15235. return send_with_content_provider_and_receiver(
  15236. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15237. content_type, std::move(content_receiver), progress);
  15238. }
  15239. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15240. const UploadFormDataItems &items,
  15241. const FormDataProviderItems &provider_items,
  15242. UploadProgress progress) {
  15243. const auto &boundary = detail::make_multipart_data_boundary();
  15244. const auto &content_type =
  15245. detail::serialize_multipart_formdata_get_content_type(boundary);
  15246. return send_with_content_provider_and_receiver(
  15247. "PATCH", path, headers, nullptr, 0, nullptr,
  15248. get_multipart_content_provider(boundary, items, provider_items),
  15249. content_type, nullptr, progress);
  15250. }
  15251. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15252. const std::string &body,
  15253. const std::string &content_type,
  15254. ContentReceiver content_receiver,
  15255. DownloadProgress progress) {
  15256. Request req;
  15257. req.method = "PATCH";
  15258. req.path = path;
  15259. req.headers = headers;
  15260. req.body = body;
  15261. req.content_receiver =
  15262. [content_receiver](const char *data, size_t data_length,
  15263. size_t /*offset*/, size_t /*total_length*/) {
  15264. return content_receiver(data, data_length);
  15265. };
  15266. req.download_progress = std::move(progress);
  15267. if (max_timeout_msec_ > 0) {
  15268. req.start_time_ = std::chrono::steady_clock::now();
  15269. }
  15270. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15271. return send_(std::move(req));
  15272. }
  15273. inline Result ClientImpl::Delete(const std::string &path,
  15274. DownloadProgress progress) {
  15275. return Delete(path, Headers(), std::string(), std::string(), progress);
  15276. }
  15277. inline Result ClientImpl::Delete(const std::string &path,
  15278. const Headers &headers,
  15279. DownloadProgress progress) {
  15280. return Delete(path, headers, std::string(), std::string(), progress);
  15281. }
  15282. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15283. size_t content_length,
  15284. const std::string &content_type,
  15285. DownloadProgress progress) {
  15286. return Delete(path, Headers(), body, content_length, content_type, progress);
  15287. }
  15288. inline Result ClientImpl::Delete(const std::string &path,
  15289. const std::string &body,
  15290. const std::string &content_type,
  15291. DownloadProgress progress) {
  15292. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15293. progress);
  15294. }
  15295. inline Result ClientImpl::Delete(const std::string &path,
  15296. const Headers &headers,
  15297. const std::string &body,
  15298. const std::string &content_type,
  15299. DownloadProgress progress) {
  15300. return Delete(path, headers, body.data(), body.size(), content_type,
  15301. progress);
  15302. }
  15303. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15304. DownloadProgress progress) {
  15305. return Delete(path, Headers(), params, progress);
  15306. }
  15307. inline Result ClientImpl::Delete(const std::string &path,
  15308. const Headers &headers, const Params &params,
  15309. DownloadProgress progress) {
  15310. auto query = detail::params_to_query_str(params);
  15311. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15312. progress);
  15313. }
  15314. inline Result ClientImpl::Delete(const std::string &path,
  15315. const Headers &headers, const char *body,
  15316. size_t content_length,
  15317. const std::string &content_type,
  15318. DownloadProgress progress) {
  15319. Request req;
  15320. req.method = "DELETE";
  15321. req.headers = headers;
  15322. req.path = path;
  15323. req.download_progress = std::move(progress);
  15324. if (max_timeout_msec_ > 0) {
  15325. req.start_time_ = std::chrono::steady_clock::now();
  15326. }
  15327. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15328. req.body.assign(body, content_length);
  15329. return send_(std::move(req));
  15330. }
  15331. inline Result ClientImpl::Options(const std::string &path) {
  15332. return Options(path, Headers());
  15333. }
  15334. inline Result ClientImpl::Options(const std::string &path,
  15335. const Headers &headers) {
  15336. Request req;
  15337. req.method = "OPTIONS";
  15338. req.headers = headers;
  15339. req.path = path;
  15340. if (max_timeout_msec_ > 0) {
  15341. req.start_time_ = std::chrono::steady_clock::now();
  15342. }
  15343. return send_(std::move(req));
  15344. }
  15345. inline void ClientImpl::stop() {
  15346. std::lock_guard<std::mutex> guard(socket_mutex_);
  15347. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15348. // do is to shutdown_socket, so that threads using this socket suddenly
  15349. // discover they can't read/write any more and error out. Everything else
  15350. // (closing the socket, shutting ssl down) is unsafe because these actions
  15351. // are not thread-safe.
  15352. if (socket_requests_in_flight_ > 0) {
  15353. shutdown_socket(socket_);
  15354. // Aside from that, we set a flag for the socket to be closed when we're
  15355. // done.
  15356. socket_should_be_closed_when_request_is_done_ = true;
  15357. return;
  15358. }
  15359. disconnect(/*gracefully=*/true);
  15360. }
  15361. inline std::string ClientImpl::host() const { return host_; }
  15362. inline int ClientImpl::port() const { return port_; }
  15363. inline size_t ClientImpl::is_socket_open() const {
  15364. std::lock_guard<std::mutex> guard(socket_mutex_);
  15365. return socket_.is_open();
  15366. }
  15367. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15368. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15369. connection_timeout_sec_ = sec;
  15370. connection_timeout_usec_ = usec;
  15371. }
  15372. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15373. read_timeout_sec_ = sec;
  15374. read_timeout_usec_ = usec;
  15375. }
  15376. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15377. write_timeout_sec_ = sec;
  15378. write_timeout_usec_ = usec;
  15379. }
  15380. inline void ClientImpl::set_max_timeout(time_t msec) {
  15381. max_timeout_msec_ = msec;
  15382. }
  15383. inline void ClientImpl::set_basic_auth(const std::string &username,
  15384. const std::string &password) {
  15385. basic_auth_username_ = username;
  15386. basic_auth_password_ = password;
  15387. }
  15388. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15389. bearer_token_auth_token_ = token;
  15390. }
  15391. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15392. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15393. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15394. inline void
  15395. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15396. addr_map_ = std::move(addr_map);
  15397. }
  15398. inline void ClientImpl::set_default_headers(Headers headers) {
  15399. default_headers_ = std::move(headers);
  15400. }
  15401. inline void ClientImpl::set_header_writer(
  15402. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15403. header_writer_ = writer;
  15404. }
  15405. inline void ClientImpl::set_address_family(int family) {
  15406. address_family_ = family;
  15407. }
  15408. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15409. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15410. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15411. socket_options_ = std::move(socket_options);
  15412. }
  15413. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15414. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15415. inline void ClientImpl::set_payload_max_length(size_t length) {
  15416. payload_max_length_ = length;
  15417. has_payload_max_length_ = true;
  15418. }
  15419. inline void ClientImpl::set_interface(const std::string &intf) {
  15420. interface_ = intf;
  15421. }
  15422. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15423. proxy_host_ = host;
  15424. proxy_port_ = port;
  15425. std::lock_guard<std::mutex> guard(socket_mutex_);
  15426. disconnect(/*gracefully=*/true);
  15427. }
  15428. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15429. const std::string &password) {
  15430. proxy_basic_auth_username_ = username;
  15431. proxy_basic_auth_password_ = password;
  15432. }
  15433. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15434. proxy_bearer_token_auth_token_ = token;
  15435. }
  15436. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15437. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15438. std::lock_guard<std::mutex> guard(socket_mutex_);
  15439. disconnect(/*gracefully=*/true);
  15440. }
  15441. #ifdef CPPHTTPLIB_SSL_ENABLED
  15442. inline void ClientImpl::set_digest_auth(const std::string &username,
  15443. const std::string &password) {
  15444. digest_auth_username_ = username;
  15445. digest_auth_password_ = password;
  15446. }
  15447. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15448. const std::string &ca_cert_dir_path) {
  15449. ca_cert_file_path_ = ca_cert_file_path;
  15450. ca_cert_dir_path_ = ca_cert_dir_path;
  15451. }
  15452. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15453. const std::string &password) {
  15454. proxy_digest_auth_username_ = username;
  15455. proxy_digest_auth_password_ = password;
  15456. }
  15457. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15458. if (server_certificate_verification_ == enabled) { return; }
  15459. server_certificate_verification_ = enabled;
  15460. tls_settings_changed();
  15461. }
  15462. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15463. if (server_hostname_verification_ == enabled) { return; }
  15464. server_hostname_verification_ = enabled;
  15465. tls_settings_changed();
  15466. }
  15467. inline void ClientImpl::enable_system_ca(bool enabled) {
  15468. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15469. }
  15470. #endif
  15471. inline void ClientImpl::set_logger(Logger logger) {
  15472. logger_ = std::move(logger);
  15473. }
  15474. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15475. error_logger_ = std::move(error_logger);
  15476. }
  15477. /*
  15478. * SSL/TLS Common Implementation
  15479. */
  15480. inline ClientConnection::~ClientConnection() {
  15481. #ifdef CPPHTTPLIB_SSL_ENABLED
  15482. if (session) {
  15483. tls::shutdown(session, true);
  15484. tls::free_session(session);
  15485. session = nullptr;
  15486. }
  15487. #endif
  15488. if (sock != INVALID_SOCKET) {
  15489. detail::close_socket(sock);
  15490. sock = INVALID_SOCKET;
  15491. }
  15492. }
  15493. // Universal client implementation
  15494. inline Client::Client(const std::string &scheme_host_port)
  15495. : Client(scheme_host_port, std::string(), std::string()) {}
  15496. inline Client::Client(const std::string &scheme_host_port,
  15497. const std::string &client_cert_path,
  15498. const std::string &client_key_path) {
  15499. detail::UrlComponents uc;
  15500. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15501. auto &scheme = uc.scheme;
  15502. #ifdef CPPHTTPLIB_SSL_ENABLED
  15503. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15504. #else
  15505. if (!scheme.empty() && scheme != "http") {
  15506. #endif
  15507. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15508. std::string msg = "'" + scheme + "' scheme is not supported.";
  15509. throw std::invalid_argument(msg);
  15510. #endif
  15511. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15512. return;
  15513. }
  15514. auto is_ssl = scheme == "https";
  15515. auto host = std::move(uc.host);
  15516. auto port = is_ssl ? 443 : 80;
  15517. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15518. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15519. return;
  15520. }
  15521. if (is_ssl) {
  15522. #ifdef CPPHTTPLIB_SSL_ENABLED
  15523. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15524. client_key_path);
  15525. is_ssl_ = is_ssl;
  15526. #endif
  15527. } else {
  15528. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15529. client_key_path);
  15530. }
  15531. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15532. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15533. // A URL, but not one this client can use, such as one with userinfo. A
  15534. // Unix socket path may have "//" further on.
  15535. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15536. } else {
  15537. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15538. // if port param below changes.
  15539. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15540. client_cert_path, client_key_path);
  15541. }
  15542. }
  15543. inline Client::Client(const std::string &host, int port)
  15544. : Client(host, port, std::string(), std::string()) {}
  15545. inline Client::Client(const std::string &host, int port,
  15546. const std::string &client_cert_path,
  15547. const std::string &client_key_path)
  15548. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15549. client_key_path)) {}
  15550. inline Client::~Client() = default;
  15551. inline bool Client::is_valid() const {
  15552. return cli_ != nullptr && cli_->is_valid();
  15553. }
  15554. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15555. return cli_->Get(path, std::move(progress));
  15556. }
  15557. inline Result Client::Get(const std::string &path, const Headers &headers,
  15558. DownloadProgress progress) {
  15559. return cli_->Get(path, headers, std::move(progress));
  15560. }
  15561. inline Result Client::Get(const std::string &path,
  15562. ContentReceiver content_receiver,
  15563. DownloadProgress progress) {
  15564. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15565. }
  15566. inline Result Client::Get(const std::string &path, const Headers &headers,
  15567. ContentReceiver content_receiver,
  15568. DownloadProgress progress) {
  15569. return cli_->Get(path, headers, std::move(content_receiver),
  15570. std::move(progress));
  15571. }
  15572. inline Result Client::Get(const std::string &path,
  15573. ResponseHandler response_handler,
  15574. ContentReceiver content_receiver,
  15575. DownloadProgress progress) {
  15576. return cli_->Get(path, std::move(response_handler),
  15577. std::move(content_receiver), std::move(progress));
  15578. }
  15579. inline Result Client::Get(const std::string &path, const Headers &headers,
  15580. ResponseHandler response_handler,
  15581. ContentReceiver content_receiver,
  15582. DownloadProgress progress) {
  15583. return cli_->Get(path, headers, std::move(response_handler),
  15584. std::move(content_receiver), std::move(progress));
  15585. }
  15586. inline Result Client::Get(const std::string &path, const Params &params,
  15587. DownloadProgress progress) {
  15588. return cli_->Get(path, params, std::move(progress));
  15589. }
  15590. inline Result Client::Get(const std::string &path, const Params &params,
  15591. const Headers &headers, DownloadProgress progress) {
  15592. return cli_->Get(path, params, headers, std::move(progress));
  15593. }
  15594. inline Result Client::Get(const std::string &path, const Params &params,
  15595. const Headers &headers,
  15596. ContentReceiver content_receiver,
  15597. DownloadProgress progress) {
  15598. return cli_->Get(path, params, headers, std::move(content_receiver),
  15599. std::move(progress));
  15600. }
  15601. inline Result Client::Get(const std::string &path, const Params &params,
  15602. const Headers &headers,
  15603. ResponseHandler response_handler,
  15604. ContentReceiver content_receiver,
  15605. DownloadProgress progress) {
  15606. return cli_->Get(path, params, headers, std::move(response_handler),
  15607. std::move(content_receiver), std::move(progress));
  15608. }
  15609. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15610. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15611. return cli_->Head(path, headers);
  15612. }
  15613. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15614. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15615. return cli_->Post(path, headers);
  15616. }
  15617. inline Result Client::Post(const std::string &path, const char *body,
  15618. size_t content_length,
  15619. const std::string &content_type,
  15620. UploadProgress progress) {
  15621. return cli_->Post(path, body, content_length, content_type, progress);
  15622. }
  15623. inline Result Client::Post(const std::string &path, const Headers &headers,
  15624. const char *body, size_t content_length,
  15625. const std::string &content_type,
  15626. UploadProgress progress) {
  15627. return cli_->Post(path, headers, body, content_length, content_type,
  15628. progress);
  15629. }
  15630. inline Result Client::Post(const std::string &path, const std::string &body,
  15631. const std::string &content_type,
  15632. UploadProgress progress) {
  15633. return cli_->Post(path, body, content_type, progress);
  15634. }
  15635. inline Result Client::Post(const std::string &path, const Headers &headers,
  15636. const std::string &body,
  15637. const std::string &content_type,
  15638. UploadProgress progress) {
  15639. return cli_->Post(path, headers, body, content_type, progress);
  15640. }
  15641. inline Result Client::Post(const std::string &path, size_t content_length,
  15642. ContentProvider content_provider,
  15643. const std::string &content_type,
  15644. UploadProgress progress) {
  15645. return cli_->Post(path, content_length, std::move(content_provider),
  15646. content_type, progress);
  15647. }
  15648. inline Result Client::Post(const std::string &path, size_t content_length,
  15649. ContentProvider content_provider,
  15650. const std::string &content_type,
  15651. ContentReceiver content_receiver,
  15652. UploadProgress progress) {
  15653. return cli_->Post(path, content_length, std::move(content_provider),
  15654. content_type, std::move(content_receiver), progress);
  15655. }
  15656. inline Result Client::Post(const std::string &path,
  15657. ContentProviderWithoutLength content_provider,
  15658. const std::string &content_type,
  15659. UploadProgress progress) {
  15660. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15661. }
  15662. inline Result Client::Post(const std::string &path,
  15663. ContentProviderWithoutLength content_provider,
  15664. const std::string &content_type,
  15665. ContentReceiver content_receiver,
  15666. UploadProgress progress) {
  15667. return cli_->Post(path, std::move(content_provider), content_type,
  15668. std::move(content_receiver), progress);
  15669. }
  15670. inline Result Client::Post(const std::string &path, const Headers &headers,
  15671. size_t content_length,
  15672. ContentProvider content_provider,
  15673. const std::string &content_type,
  15674. UploadProgress progress) {
  15675. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15676. content_type, progress);
  15677. }
  15678. inline Result Client::Post(const std::string &path, const Headers &headers,
  15679. size_t content_length,
  15680. ContentProvider content_provider,
  15681. const std::string &content_type,
  15682. ContentReceiver content_receiver,
  15683. DownloadProgress progress) {
  15684. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15685. content_type, std::move(content_receiver), progress);
  15686. }
  15687. inline Result Client::Post(const std::string &path, const Headers &headers,
  15688. ContentProviderWithoutLength content_provider,
  15689. const std::string &content_type,
  15690. UploadProgress progress) {
  15691. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15692. progress);
  15693. }
  15694. inline Result Client::Post(const std::string &path, const Headers &headers,
  15695. ContentProviderWithoutLength content_provider,
  15696. const std::string &content_type,
  15697. ContentReceiver content_receiver,
  15698. DownloadProgress progress) {
  15699. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15700. std::move(content_receiver), progress);
  15701. }
  15702. inline Result Client::Post(const std::string &path, const Params &params) {
  15703. return cli_->Post(path, params);
  15704. }
  15705. inline Result Client::Post(const std::string &path, const Headers &headers,
  15706. const Params &params) {
  15707. return cli_->Post(path, headers, params);
  15708. }
  15709. inline Result Client::Post(const std::string &path,
  15710. const UploadFormDataItems &items,
  15711. UploadProgress progress) {
  15712. return cli_->Post(path, items, progress);
  15713. }
  15714. inline Result Client::Post(const std::string &path, const Headers &headers,
  15715. const UploadFormDataItems &items,
  15716. UploadProgress progress) {
  15717. return cli_->Post(path, headers, items, progress);
  15718. }
  15719. inline Result Client::Post(const std::string &path, const Headers &headers,
  15720. const UploadFormDataItems &items,
  15721. const std::string &boundary,
  15722. UploadProgress progress) {
  15723. return cli_->Post(path, headers, items, boundary, progress);
  15724. }
  15725. inline Result Client::Post(const std::string &path, const Headers &headers,
  15726. const UploadFormDataItems &items,
  15727. const FormDataProviderItems &provider_items,
  15728. UploadProgress progress) {
  15729. return cli_->Post(path, headers, items, provider_items, progress);
  15730. }
  15731. inline Result Client::Post(const std::string &path, const Headers &headers,
  15732. const std::string &body,
  15733. const std::string &content_type,
  15734. ContentReceiver content_receiver,
  15735. DownloadProgress progress) {
  15736. return cli_->Post(path, headers, body, content_type,
  15737. std::move(content_receiver), progress);
  15738. }
  15739. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15740. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15741. return cli_->Put(path, headers);
  15742. }
  15743. inline Result Client::Put(const std::string &path, const char *body,
  15744. size_t content_length,
  15745. const std::string &content_type,
  15746. UploadProgress progress) {
  15747. return cli_->Put(path, body, content_length, content_type, progress);
  15748. }
  15749. inline Result Client::Put(const std::string &path, const Headers &headers,
  15750. const char *body, size_t content_length,
  15751. const std::string &content_type,
  15752. UploadProgress progress) {
  15753. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15754. }
  15755. inline Result Client::Put(const std::string &path, const std::string &body,
  15756. const std::string &content_type,
  15757. UploadProgress progress) {
  15758. return cli_->Put(path, body, content_type, progress);
  15759. }
  15760. inline Result Client::Put(const std::string &path, const Headers &headers,
  15761. const std::string &body,
  15762. const std::string &content_type,
  15763. UploadProgress progress) {
  15764. return cli_->Put(path, headers, body, content_type, progress);
  15765. }
  15766. inline Result Client::Put(const std::string &path, size_t content_length,
  15767. ContentProvider content_provider,
  15768. const std::string &content_type,
  15769. UploadProgress progress) {
  15770. return cli_->Put(path, content_length, std::move(content_provider),
  15771. content_type, progress);
  15772. }
  15773. inline Result Client::Put(const std::string &path, size_t content_length,
  15774. ContentProvider content_provider,
  15775. const std::string &content_type,
  15776. ContentReceiver content_receiver,
  15777. UploadProgress progress) {
  15778. return cli_->Put(path, content_length, std::move(content_provider),
  15779. content_type, std::move(content_receiver), progress);
  15780. }
  15781. inline Result Client::Put(const std::string &path,
  15782. ContentProviderWithoutLength content_provider,
  15783. const std::string &content_type,
  15784. UploadProgress progress) {
  15785. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15786. }
  15787. inline Result Client::Put(const std::string &path,
  15788. ContentProviderWithoutLength content_provider,
  15789. const std::string &content_type,
  15790. ContentReceiver content_receiver,
  15791. UploadProgress progress) {
  15792. return cli_->Put(path, std::move(content_provider), content_type,
  15793. std::move(content_receiver), progress);
  15794. }
  15795. inline Result Client::Put(const std::string &path, const Headers &headers,
  15796. size_t content_length,
  15797. ContentProvider content_provider,
  15798. const std::string &content_type,
  15799. UploadProgress progress) {
  15800. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15801. content_type, progress);
  15802. }
  15803. inline Result Client::Put(const std::string &path, const Headers &headers,
  15804. size_t content_length,
  15805. ContentProvider content_provider,
  15806. const std::string &content_type,
  15807. ContentReceiver content_receiver,
  15808. UploadProgress progress) {
  15809. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15810. content_type, std::move(content_receiver), progress);
  15811. }
  15812. inline Result Client::Put(const std::string &path, const Headers &headers,
  15813. ContentProviderWithoutLength content_provider,
  15814. const std::string &content_type,
  15815. UploadProgress progress) {
  15816. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15817. progress);
  15818. }
  15819. inline Result Client::Put(const std::string &path, const Headers &headers,
  15820. ContentProviderWithoutLength content_provider,
  15821. const std::string &content_type,
  15822. ContentReceiver content_receiver,
  15823. UploadProgress progress) {
  15824. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15825. std::move(content_receiver), progress);
  15826. }
  15827. inline Result Client::Put(const std::string &path, const Params &params) {
  15828. return cli_->Put(path, params);
  15829. }
  15830. inline Result Client::Put(const std::string &path, const Headers &headers,
  15831. const Params &params) {
  15832. return cli_->Put(path, headers, params);
  15833. }
  15834. inline Result Client::Put(const std::string &path,
  15835. const UploadFormDataItems &items,
  15836. UploadProgress progress) {
  15837. return cli_->Put(path, items, progress);
  15838. }
  15839. inline Result Client::Put(const std::string &path, const Headers &headers,
  15840. const UploadFormDataItems &items,
  15841. UploadProgress progress) {
  15842. return cli_->Put(path, headers, items, progress);
  15843. }
  15844. inline Result Client::Put(const std::string &path, const Headers &headers,
  15845. const UploadFormDataItems &items,
  15846. const std::string &boundary,
  15847. UploadProgress progress) {
  15848. return cli_->Put(path, headers, items, boundary, progress);
  15849. }
  15850. inline Result Client::Put(const std::string &path, const Headers &headers,
  15851. const UploadFormDataItems &items,
  15852. const FormDataProviderItems &provider_items,
  15853. UploadProgress progress) {
  15854. return cli_->Put(path, headers, items, provider_items, progress);
  15855. }
  15856. inline Result Client::Put(const std::string &path, const Headers &headers,
  15857. const std::string &body,
  15858. const std::string &content_type,
  15859. ContentReceiver content_receiver,
  15860. DownloadProgress progress) {
  15861. return cli_->Put(path, headers, body, content_type, content_receiver,
  15862. progress);
  15863. }
  15864. inline Result Client::Patch(const std::string &path) {
  15865. return cli_->Patch(path);
  15866. }
  15867. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15868. return cli_->Patch(path, headers);
  15869. }
  15870. inline Result Client::Patch(const std::string &path, const char *body,
  15871. size_t content_length,
  15872. const std::string &content_type,
  15873. UploadProgress progress) {
  15874. return cli_->Patch(path, body, content_length, content_type, progress);
  15875. }
  15876. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15877. const char *body, size_t content_length,
  15878. const std::string &content_type,
  15879. UploadProgress progress) {
  15880. return cli_->Patch(path, headers, body, content_length, content_type,
  15881. progress);
  15882. }
  15883. inline Result Client::Patch(const std::string &path, const std::string &body,
  15884. const std::string &content_type,
  15885. UploadProgress progress) {
  15886. return cli_->Patch(path, body, content_type, progress);
  15887. }
  15888. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15889. const std::string &body,
  15890. const std::string &content_type,
  15891. UploadProgress progress) {
  15892. return cli_->Patch(path, headers, body, content_type, progress);
  15893. }
  15894. inline Result Client::Patch(const std::string &path, size_t content_length,
  15895. ContentProvider content_provider,
  15896. const std::string &content_type,
  15897. UploadProgress progress) {
  15898. return cli_->Patch(path, content_length, std::move(content_provider),
  15899. content_type, progress);
  15900. }
  15901. inline Result Client::Patch(const std::string &path, size_t content_length,
  15902. ContentProvider content_provider,
  15903. const std::string &content_type,
  15904. ContentReceiver content_receiver,
  15905. UploadProgress progress) {
  15906. return cli_->Patch(path, content_length, std::move(content_provider),
  15907. content_type, std::move(content_receiver), progress);
  15908. }
  15909. inline Result Client::Patch(const std::string &path,
  15910. ContentProviderWithoutLength content_provider,
  15911. const std::string &content_type,
  15912. UploadProgress progress) {
  15913. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15914. }
  15915. inline Result Client::Patch(const std::string &path,
  15916. ContentProviderWithoutLength content_provider,
  15917. const std::string &content_type,
  15918. ContentReceiver content_receiver,
  15919. UploadProgress progress) {
  15920. return cli_->Patch(path, std::move(content_provider), content_type,
  15921. std::move(content_receiver), progress);
  15922. }
  15923. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15924. size_t content_length,
  15925. ContentProvider content_provider,
  15926. const std::string &content_type,
  15927. UploadProgress progress) {
  15928. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15929. content_type, progress);
  15930. }
  15931. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15932. size_t content_length,
  15933. ContentProvider content_provider,
  15934. const std::string &content_type,
  15935. ContentReceiver content_receiver,
  15936. UploadProgress progress) {
  15937. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15938. content_type, std::move(content_receiver), progress);
  15939. }
  15940. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15941. ContentProviderWithoutLength content_provider,
  15942. const std::string &content_type,
  15943. UploadProgress progress) {
  15944. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15945. progress);
  15946. }
  15947. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15948. ContentProviderWithoutLength content_provider,
  15949. const std::string &content_type,
  15950. ContentReceiver content_receiver,
  15951. UploadProgress progress) {
  15952. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15953. std::move(content_receiver), progress);
  15954. }
  15955. inline Result Client::Patch(const std::string &path, const Params &params) {
  15956. return cli_->Patch(path, params);
  15957. }
  15958. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15959. const Params &params) {
  15960. return cli_->Patch(path, headers, params);
  15961. }
  15962. inline Result Client::Patch(const std::string &path,
  15963. const UploadFormDataItems &items,
  15964. UploadProgress progress) {
  15965. return cli_->Patch(path, items, progress);
  15966. }
  15967. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15968. const UploadFormDataItems &items,
  15969. UploadProgress progress) {
  15970. return cli_->Patch(path, headers, items, progress);
  15971. }
  15972. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15973. const UploadFormDataItems &items,
  15974. const std::string &boundary,
  15975. UploadProgress progress) {
  15976. return cli_->Patch(path, headers, items, boundary, progress);
  15977. }
  15978. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15979. const UploadFormDataItems &items,
  15980. const FormDataProviderItems &provider_items,
  15981. UploadProgress progress) {
  15982. return cli_->Patch(path, headers, items, provider_items, progress);
  15983. }
  15984. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15985. const std::string &body,
  15986. const std::string &content_type,
  15987. ContentReceiver content_receiver,
  15988. DownloadProgress progress) {
  15989. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15990. progress);
  15991. }
  15992. inline Result Client::Delete(const std::string &path,
  15993. DownloadProgress progress) {
  15994. return cli_->Delete(path, progress);
  15995. }
  15996. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15997. DownloadProgress progress) {
  15998. return cli_->Delete(path, headers, progress);
  15999. }
  16000. inline Result Client::Delete(const std::string &path, const char *body,
  16001. size_t content_length,
  16002. const std::string &content_type,
  16003. DownloadProgress progress) {
  16004. return cli_->Delete(path, body, content_length, content_type, progress);
  16005. }
  16006. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16007. const char *body, size_t content_length,
  16008. const std::string &content_type,
  16009. DownloadProgress progress) {
  16010. return cli_->Delete(path, headers, body, content_length, content_type,
  16011. progress);
  16012. }
  16013. inline Result Client::Delete(const std::string &path, const std::string &body,
  16014. const std::string &content_type,
  16015. DownloadProgress progress) {
  16016. return cli_->Delete(path, body, content_type, progress);
  16017. }
  16018. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16019. const std::string &body,
  16020. const std::string &content_type,
  16021. DownloadProgress progress) {
  16022. return cli_->Delete(path, headers, body, content_type, progress);
  16023. }
  16024. inline Result Client::Delete(const std::string &path, const Params &params,
  16025. DownloadProgress progress) {
  16026. return cli_->Delete(path, params, progress);
  16027. }
  16028. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16029. const Params &params, DownloadProgress progress) {
  16030. return cli_->Delete(path, headers, params, progress);
  16031. }
  16032. inline Result Client::Options(const std::string &path) {
  16033. return cli_->Options(path);
  16034. }
  16035. inline Result Client::Options(const std::string &path, const Headers &headers) {
  16036. return cli_->Options(path, headers);
  16037. }
  16038. inline ClientImpl::StreamHandle
  16039. Client::open_stream(const std::string &method, const std::string &path,
  16040. const Params &params, const Headers &headers,
  16041. const std::string &body, const std::string &content_type) {
  16042. return cli_->open_stream(method, path, params, headers, body, content_type);
  16043. }
  16044. inline bool Client::send(Request &req, Response &res, Error &error) {
  16045. return cli_->send(req, res, error);
  16046. }
  16047. inline Result Client::send(const Request &req) { return cli_->send(req); }
  16048. inline void Client::stop() { cli_->stop(); }
  16049. inline std::string Client::host() const { return cli_->host(); }
  16050. inline int Client::port() const { return cli_->port(); }
  16051. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  16052. inline socket_t Client::socket() const { return cli_->socket(); }
  16053. inline void
  16054. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  16055. cli_->set_hostname_addr_map(std::move(addr_map));
  16056. }
  16057. inline void Client::set_default_headers(Headers headers) {
  16058. cli_->set_default_headers(std::move(headers));
  16059. }
  16060. inline void Client::set_header_writer(
  16061. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16062. cli_->set_header_writer(writer);
  16063. }
  16064. inline void Client::set_address_family(int family) {
  16065. cli_->set_address_family(family);
  16066. }
  16067. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  16068. inline void Client::set_socket_options(SocketOptions socket_options) {
  16069. cli_->set_socket_options(std::move(socket_options));
  16070. }
  16071. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  16072. cli_->set_connection_timeout(sec, usec);
  16073. }
  16074. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  16075. cli_->set_read_timeout(sec, usec);
  16076. }
  16077. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  16078. cli_->set_write_timeout(sec, usec);
  16079. }
  16080. inline void Client::set_basic_auth(const std::string &username,
  16081. const std::string &password) {
  16082. cli_->set_basic_auth(username, password);
  16083. }
  16084. inline void Client::set_bearer_token_auth(const std::string &token) {
  16085. cli_->set_bearer_token_auth(token);
  16086. }
  16087. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  16088. inline void Client::set_follow_location(bool on) {
  16089. cli_->set_follow_location(on);
  16090. }
  16091. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  16092. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  16093. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  16094. inline void Client::set_payload_max_length(size_t length) {
  16095. cli_->set_payload_max_length(length);
  16096. }
  16097. inline void Client::set_interface(const std::string &intf) {
  16098. cli_->set_interface(intf);
  16099. }
  16100. inline void Client::set_proxy(const std::string &host, int port) {
  16101. cli_->set_proxy(host, port);
  16102. }
  16103. inline void Client::set_proxy_basic_auth(const std::string &username,
  16104. const std::string &password) {
  16105. cli_->set_proxy_basic_auth(username, password);
  16106. }
  16107. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16108. cli_->set_proxy_bearer_token_auth(token);
  16109. }
  16110. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16111. cli_->set_no_proxy(patterns);
  16112. }
  16113. inline void Client::set_logger(Logger logger) {
  16114. cli_->set_logger(std::move(logger));
  16115. }
  16116. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16117. cli_->set_error_logger(std::move(error_logger));
  16118. }
  16119. /*
  16120. * Group 6: SSL Server and Client implementation
  16121. */
  16122. #ifdef CPPHTTPLIB_SSL_ENABLED
  16123. // SSL HTTP server implementation
  16124. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16125. const char *client_ca_cert_file_path,
  16126. const char *client_ca_cert_dir_path,
  16127. const char *private_key_password) {
  16128. using namespace tls;
  16129. ctx_ = create_server_context();
  16130. if (!ctx_) { return; }
  16131. // Load server certificate and private key
  16132. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16133. private_key_password)) {
  16134. last_ssl_error_ = static_cast<int>(get_error());
  16135. free_context(ctx_);
  16136. ctx_ = nullptr;
  16137. return;
  16138. }
  16139. // Load client CA certificates for client authentication
  16140. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16141. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16142. client_ca_cert_dir_path)) {
  16143. last_ssl_error_ = static_cast<int>(get_error());
  16144. free_context(ctx_);
  16145. ctx_ = nullptr;
  16146. return;
  16147. }
  16148. // Enable client certificate verification
  16149. set_verify_client(ctx_, true);
  16150. }
  16151. }
  16152. inline SSLServer::SSLServer(const PemMemory &pem) {
  16153. using namespace tls;
  16154. ctx_ = create_server_context();
  16155. if (ctx_) {
  16156. std::string cert_buf, key_buf;
  16157. if (!set_server_cert_pem(
  16158. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16159. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16160. pem.private_key_password)) {
  16161. last_ssl_error_ = static_cast<int>(get_error());
  16162. free_context(ctx_);
  16163. ctx_ = nullptr;
  16164. } else if (pem.client_ca_pem) {
  16165. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16166. : strlen(pem.client_ca_pem);
  16167. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16168. last_ssl_error_ = static_cast<int>(get_error());
  16169. free_context(ctx_);
  16170. ctx_ = nullptr;
  16171. } else {
  16172. set_verify_client(ctx_, true);
  16173. }
  16174. }
  16175. }
  16176. }
  16177. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16178. using namespace tls;
  16179. ctx_ = create_server_context();
  16180. if (ctx_) {
  16181. if (!setup_callback(ctx_)) {
  16182. free_context(ctx_);
  16183. ctx_ = nullptr;
  16184. }
  16185. }
  16186. }
  16187. inline SSLServer::~SSLServer() {
  16188. if (ctx_) { tls::free_context(ctx_); }
  16189. }
  16190. inline bool SSLServer::is_valid() const {
  16191. return ctx_ != nullptr && Server::is_valid();
  16192. }
  16193. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16194. using namespace tls;
  16195. session_t session = nullptr;
  16196. {
  16197. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16198. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16199. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16200. if (session) { handshakes_in_progress_++; }
  16201. }
  16202. if (!session) {
  16203. last_ssl_error_ = static_cast<int>(get_error());
  16204. detail::shutdown_socket(sock);
  16205. detail::close_socket(sock);
  16206. return false;
  16207. }
  16208. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16209. bool handshake_done = false;
  16210. bool ret = false;
  16211. bool websocket_upgraded = false;
  16212. auto cleanup = detail::scope_exit([&] {
  16213. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16214. free_session(session);
  16215. detail::shutdown_socket(sock);
  16216. detail::close_socket(sock);
  16217. });
  16218. // Perform TLS accept handshake with timeout
  16219. TlsError tls_err;
  16220. auto accepted = false;
  16221. {
  16222. auto handshake_left = detail::scope_exit([&] {
  16223. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16224. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16225. });
  16226. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16227. read_timeout_usec_, &tls_err);
  16228. }
  16229. if (!accepted) {
  16230. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16231. // Map TlsError to legacy ssl_error for backward compatibility
  16232. if (tls_err.code == ErrorCode::WantRead) {
  16233. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16234. } else if (tls_err.code == ErrorCode::WantWrite) {
  16235. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16236. } else {
  16237. last_ssl_error_ = SSL_ERROR_SSL;
  16238. }
  16239. #else
  16240. last_ssl_error_ = static_cast<int>(get_error());
  16241. #endif
  16242. return false;
  16243. }
  16244. handshake_done = true;
  16245. std::string remote_addr;
  16246. int remote_port = 0;
  16247. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16248. std::string local_addr;
  16249. int local_port = 0;
  16250. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16251. ret = serve_guarded([&]() {
  16252. return detail::process_server_socket_ssl(
  16253. svr_sock_, session, sock, keep_alive_max_count_,
  16254. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16255. write_timeout_sec_, write_timeout_usec_,
  16256. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16257. return process_request(
  16258. strm, remote_addr, remote_port, local_addr, local_port,
  16259. close_connection, connection_closed,
  16260. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16261. });
  16262. });
  16263. return ret;
  16264. }
  16265. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16266. const char *key_pem,
  16267. const char *client_ca_pem,
  16268. const char *password) {
  16269. if (!ctx_) { return false; }
  16270. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16271. updates_pending_++;
  16272. auto se = detail::scope_exit([&] {
  16273. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16274. });
  16275. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16276. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16277. return false;
  16278. }
  16279. if (client_ca_pem) {
  16280. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16281. // As in the constructors, a client CA makes client certificates required
  16282. tls::set_verify_client(ctx_, true);
  16283. }
  16284. return true;
  16285. }
  16286. // SSL HTTP client implementation
  16287. inline SSLClient::~SSLClient() {
  16288. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16289. // base function rather than the derived function once we get to the
  16290. // base class destructor, and won't free the SSL (causing a leak).
  16291. // This must happen before the context is freed below: some backends
  16292. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16293. // context, so freeing the context first leaves close_notify reading
  16294. // freed memory.
  16295. shutdown_ssl_impl(socket_, true);
  16296. if (ctx_) {
  16297. tls::free_context(ctx_);
  16298. ctx_ = nullptr;
  16299. }
  16300. }
  16301. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16302. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16303. shutdown_ssl_impl(socket, shutdown_gracefully);
  16304. }
  16305. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16306. bool shutdown_gracefully) {
  16307. if (socket.sock == INVALID_SOCKET) {
  16308. assert(socket.ssl == nullptr);
  16309. return;
  16310. }
  16311. if (socket.ssl) {
  16312. tls::shutdown(socket.ssl, shutdown_gracefully);
  16313. {
  16314. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16315. tls::free_session(socket.ssl);
  16316. }
  16317. socket.ssl = nullptr;
  16318. }
  16319. assert(socket.ssl == nullptr);
  16320. }
  16321. inline bool SSLClient::process_socket(
  16322. const Socket &socket,
  16323. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16324. std::function<bool(Stream &strm)> callback) {
  16325. assert(socket.ssl);
  16326. return detail::process_client_socket_ssl(
  16327. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16328. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16329. [&](detail::SSLSocketStream &strm) {
  16330. auto ret = callback(strm);
  16331. // A request that failed after the handshake reports Error::Read or
  16332. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16333. // from the server, for Result::ssl_error() and ssl_backend_error()
  16334. const auto &tls_error = strm.tls_error();
  16335. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16336. last_ssl_error_ = static_cast<int>(tls_error.code);
  16337. last_backend_error_ = tls_error.backend_code;
  16338. }
  16339. return ret;
  16340. });
  16341. }
  16342. inline bool SSLClient::is_ssl() const { return true; }
  16343. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16344. if (!is_valid()) {
  16345. error = Error::SSLConnection;
  16346. return false;
  16347. }
  16348. return ClientImpl::create_and_connect_socket(socket, error);
  16349. }
  16350. inline bool SSLClient::setup_proxy_connection(
  16351. Socket &socket,
  16352. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16353. Response &res, bool &success, Error &error) {
  16354. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16355. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16356. return false;
  16357. }
  16358. if (!initialize_ssl(socket, error)) {
  16359. success = false;
  16360. return false;
  16361. }
  16362. return true;
  16363. }
  16364. // Assumes that socket_mutex_ is locked and that there are no requests in
  16365. // flight
  16366. inline bool SSLClient::connect_with_proxy(
  16367. Socket &socket,
  16368. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16369. Response &res, bool &success, Error &error) {
  16370. success = true;
  16371. Response proxy_res;
  16372. if (!detail::process_client_socket(
  16373. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16374. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16375. start_time, [&](Stream &strm) {
  16376. Request req2;
  16377. req2.method = "CONNECT";
  16378. req2.path =
  16379. detail::make_host_and_port_string_always_port(host_, port_);
  16380. if (max_timeout_msec_ > 0) {
  16381. req2.start_time_ = std::chrono::steady_clock::now();
  16382. }
  16383. return process_request(strm, req2, proxy_res, false, error);
  16384. })) {
  16385. // Thread-safe to close everything because we are assuming there are no
  16386. // requests in flight
  16387. shutdown_ssl(socket, true);
  16388. shutdown_socket(socket);
  16389. close_socket(socket);
  16390. success = false;
  16391. return false;
  16392. }
  16393. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16394. if (!proxy_digest_auth_username_.empty() &&
  16395. !proxy_digest_auth_password_.empty()) {
  16396. std::map<std::string, std::string> auth;
  16397. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16398. // Close the current socket and create a new one for the authenticated
  16399. // request
  16400. shutdown_ssl(socket, true);
  16401. shutdown_socket(socket);
  16402. close_socket(socket);
  16403. // Create a new socket for the authenticated CONNECT request
  16404. if (!ensure_socket_connection(socket, error)) {
  16405. success = false;
  16406. return false;
  16407. }
  16408. proxy_res = Response();
  16409. if (!detail::process_client_socket(
  16410. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16411. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16412. start_time, [&](Stream &strm) {
  16413. Request req3;
  16414. req3.method = "CONNECT";
  16415. req3.path = detail::make_host_and_port_string_always_port(
  16416. host_, port_);
  16417. req3.headers.insert(detail::make_digest_authentication_header(
  16418. req3, make_request_target(req3), auth, 1,
  16419. detail::random_string(10), proxy_digest_auth_username_,
  16420. proxy_digest_auth_password_, true));
  16421. if (max_timeout_msec_ > 0) {
  16422. req3.start_time_ = std::chrono::steady_clock::now();
  16423. }
  16424. return process_request(strm, req3, proxy_res, false, error);
  16425. })) {
  16426. // Thread-safe to close everything because we are assuming there are
  16427. // no requests in flight
  16428. shutdown_ssl(socket, true);
  16429. shutdown_socket(socket);
  16430. close_socket(socket);
  16431. success = false;
  16432. return false;
  16433. }
  16434. }
  16435. }
  16436. }
  16437. // If status code is not 200, proxy request is failed.
  16438. // Set error to ProxyConnection. A 407 is returned as the response of the
  16439. // request, so the caller sees the proxy asks for credentials; any other
  16440. // status would read as the answer of the origin, which it never reached.
  16441. if (proxy_res.status != StatusCode::OK_200) {
  16442. error = Error::ProxyConnection;
  16443. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16444. res = std::move(proxy_res);
  16445. } else {
  16446. success = false;
  16447. }
  16448. // Thread-safe to close everything because we are assuming there are
  16449. // no requests in flight
  16450. shutdown_ssl(socket, true);
  16451. shutdown_socket(socket);
  16452. close_socket(socket);
  16453. return false;
  16454. }
  16455. return true;
  16456. }
  16457. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16458. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16459. if (is_proxy_enabled_for_host(host_)) { return true; }
  16460. if (!initialize_ssl(socket, error)) {
  16461. shutdown_socket(socket);
  16462. close_socket(socket);
  16463. return false;
  16464. }
  16465. return true;
  16466. }
  16467. // SSL HTTP client implementation
  16468. inline SSLClient::SSLClient(const std::string &host)
  16469. : SSLClient(host, 443, std::string(), std::string()) {}
  16470. inline SSLClient::SSLClient(const std::string &host, int port)
  16471. : SSLClient(host, port, std::string(), std::string()) {}
  16472. inline void SSLClient::init_ctx() {
  16473. ctx_ = tls::create_client_context();
  16474. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16475. }
  16476. inline void SSLClient::reset_ctx_on_error() {
  16477. last_backend_error_ = tls::get_error();
  16478. tls::free_context(ctx_);
  16479. ctx_ = nullptr;
  16480. }
  16481. inline SSLClient::SSLClient(const std::string &host, int port,
  16482. const std::string &client_cert_path,
  16483. const std::string &client_key_path,
  16484. const std::string &private_key_password)
  16485. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16486. init_ctx();
  16487. if (!ctx_) { return; }
  16488. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16489. const char *password =
  16490. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16491. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16492. client_key_path.c_str(), password)) {
  16493. reset_ctx_on_error();
  16494. }
  16495. }
  16496. }
  16497. inline SSLClient::SSLClient(const std::string &host, int port,
  16498. const PemMemory &pem)
  16499. : ClientImpl(host, port) {
  16500. init_ctx();
  16501. if (!ctx_) { return; }
  16502. if (pem.cert_pem && pem.key_pem) {
  16503. std::string cert_buf, key_buf;
  16504. if (!tls::set_client_cert_pem(
  16505. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16506. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16507. pem.private_key_password)) {
  16508. reset_ctx_on_error();
  16509. }
  16510. }
  16511. }
  16512. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16513. if (ca_cert_store && ctx_) {
  16514. // set_ca_store takes ownership of ca_cert_store
  16515. tls::set_ca_store(ctx_, ca_cert_store);
  16516. ca_cert_store_set_ = true;
  16517. } else if (ca_cert_store) {
  16518. tls::free_ca_store(ca_cert_store);
  16519. }
  16520. custom_ca_loaded_ = true;
  16521. tls_settings_changed();
  16522. }
  16523. inline void
  16524. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16525. if (!ctx_) { return; }
  16526. server_certificate_verifier_ = verifier;
  16527. {
  16528. // Under the lock that creating a session from ctx_ takes
  16529. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16530. tls::set_verify_callback(ctx_, std::move(verifier));
  16531. }
  16532. tls_settings_changed();
  16533. }
  16534. inline void SSLClient::set_session_verifier(
  16535. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16536. session_verifier_ = std::move(verifier);
  16537. tls_settings_changed();
  16538. }
  16539. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16540. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16541. if (enable_windows_cert_verification_ == enabled) { return; }
  16542. enable_windows_cert_verification_ = enabled;
  16543. tls_settings_changed();
  16544. }
  16545. #endif
  16546. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16547. std::size_t size) {
  16548. if (ctx_ && ca_cert && size > 0) {
  16549. // Every PEM loaded, for redirect transfer
  16550. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16551. ca_cert_pem_ += '\n';
  16552. }
  16553. ca_cert_pem_.append(ca_cert, size);
  16554. tls::load_ca_pem(ctx_, ca_cert, size);
  16555. }
  16556. custom_ca_loaded_ = true;
  16557. tls_settings_changed();
  16558. }
  16559. inline bool SSLClient::load_certs() {
  16560. auto ret = true;
  16561. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16562. // one client is shared across concurrent requests here.
  16563. std::call_once(initialize_cert_, [&]() {
  16564. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16565. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  16566. ca_cert_dir_path_, custom_ca_loaded_,
  16567. system_ca_mode_, last_backend_error_);
  16568. });
  16569. return ret;
  16570. }
  16571. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16572. // Load CA certificates if server verification is enabled
  16573. if (server_certificate_verification_) {
  16574. if (!load_certs()) {
  16575. error = Error::SSLLoadingCerts;
  16576. return false;
  16577. }
  16578. }
  16579. detail::ClientTlsSessionOptions options;
  16580. options.server_hostname_verification = server_hostname_verification_;
  16581. options.session_verifier = session_verifier_;
  16582. options.ctx_mutex = &ctx_mutex_;
  16583. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16584. // Skip Schannel when a custom CA cert is specified, as the Windows
  16585. // certificate store would not know about user-provided CA certificates.
  16586. // Also skip when system CA trust is explicitly disabled.
  16587. options.windows_cert_verification =
  16588. enable_windows_cert_verification_ &&
  16589. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16590. ca_cert_dir_path_.empty() && !custom_ca_loaded_;
  16591. // Only a verifier set through set_server_certificate_verifier() is seen
  16592. // here, not one installed with tls::set_verify_callback() directly.
  16593. options.server_certificate_verifier_set =
  16594. static_cast<bool>(server_certificate_verifier_);
  16595. #endif
  16596. tls::session_t session = nullptr;
  16597. // Use scope_exit to ensure session is freed on error paths
  16598. bool success = false;
  16599. auto session_guard = detail::scope_exit([&] {
  16600. if (!success) { tls::free_session(session); }
  16601. });
  16602. detail::ClientTlsSessionError tls_error;
  16603. if (!detail::setup_client_tls_session(
  16604. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16605. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16606. options)) {
  16607. error = tls_error.error;
  16608. last_ssl_error_ = tls_error.ssl_error;
  16609. last_backend_error_ = tls_error.backend_error;
  16610. return false;
  16611. }
  16612. success = true;
  16613. socket.ssl = session;
  16614. return true;
  16615. }
  16616. inline void Client::set_digest_auth(const std::string &username,
  16617. const std::string &password) {
  16618. cli_->set_digest_auth(username, password);
  16619. }
  16620. inline void Client::set_proxy_digest_auth(const std::string &username,
  16621. const std::string &password) {
  16622. cli_->set_proxy_digest_auth(username, password);
  16623. }
  16624. inline void Client::enable_server_certificate_verification(bool enabled) {
  16625. cli_->enable_server_certificate_verification(enabled);
  16626. }
  16627. inline void Client::enable_server_hostname_verification(bool enabled) {
  16628. cli_->enable_server_hostname_verification(enabled);
  16629. }
  16630. inline void Client::enable_system_ca(bool enabled) {
  16631. cli_->enable_system_ca(enabled);
  16632. }
  16633. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16634. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16635. if (is_ssl_) {
  16636. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16637. enabled);
  16638. }
  16639. }
  16640. #endif
  16641. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16642. const std::string &ca_cert_dir_path) {
  16643. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16644. }
  16645. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16646. if (is_ssl_) {
  16647. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16648. } else if (ca_cert_store) {
  16649. tls::free_ca_store(ca_cert_store);
  16650. }
  16651. }
  16652. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16653. if (is_ssl_) {
  16654. // Use the PEM-based path so the CA data is retained for redirect transfer
  16655. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16656. }
  16657. }
  16658. inline void
  16659. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16660. if (is_ssl_) {
  16661. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16662. std::move(verifier));
  16663. }
  16664. }
  16665. inline void Client::set_session_verifier(
  16666. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16667. if (is_ssl_) {
  16668. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16669. }
  16670. }
  16671. inline tls::ctx_t Client::tls_context() const {
  16672. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16673. return nullptr;
  16674. }
  16675. #endif // CPPHTTPLIB_SSL_ENABLED
  16676. /*
  16677. * Group 7: TLS abstraction layer - Common API
  16678. */
  16679. #ifdef CPPHTTPLIB_SSL_ENABLED
  16680. namespace tls {
  16681. // Helper for PeerCert construction
  16682. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16683. return PeerCert(get_peer_cert(session));
  16684. }
  16685. namespace impl {
  16686. // set_verify_callback() can replace a callback while handshakes on other
  16687. // threads run it, so they share it, and take their reference under this lock.
  16688. inline std::mutex &verify_callback_mutex() {
  16689. static std::mutex mutex;
  16690. return mutex;
  16691. }
  16692. // The TLS libraries are C, so an exception from a verify callback must not
  16693. // unwind through them. It rejects the certificate instead.
  16694. inline bool run_verify_callback(const VerifyCallback &callback,
  16695. const VerifyContext &ctx) {
  16696. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16697. return callback(ctx);
  16698. #else
  16699. try {
  16700. return callback(ctx);
  16701. } catch (...) { return false; }
  16702. #endif
  16703. }
  16704. // Check if a string is an IPv4 address
  16705. inline bool is_ipv4_address(const std::string &str) {
  16706. int dots = 0;
  16707. for (char c : str) {
  16708. if (c == '.') {
  16709. dots++;
  16710. } else if (!detail::is_ascii_digit(c)) {
  16711. return false;
  16712. }
  16713. }
  16714. return dots == 3;
  16715. }
  16716. // Parse IPv4 address string to bytes
  16717. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16718. const char *p = str.c_str();
  16719. for (int i = 0; i < 4; i++) {
  16720. if (i > 0) {
  16721. if (*p != '.') { return false; }
  16722. p++;
  16723. }
  16724. int val = 0;
  16725. int digits = 0;
  16726. while (detail::is_ascii_digit(*p)) {
  16727. val = val * 10 + (*p - '0');
  16728. if (val > 255) { return false; }
  16729. p++;
  16730. digits++;
  16731. }
  16732. if (digits == 0) { return false; }
  16733. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16734. if (digits > 1 && *(p - digits) == '0') { return false; }
  16735. out[i] = static_cast<unsigned char>(val);
  16736. }
  16737. return *p == '\0';
  16738. }
  16739. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16740. // `out` must have room for at least 16 bytes. Returns the address length
  16741. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16742. // literal. Used to match a host against iPAddress SANs the same way the
  16743. // OpenSSL backend does via X509_check_ip.
  16744. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16745. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16746. struct in6_addr addr6 = {};
  16747. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16748. memcpy(out, &addr6, 16);
  16749. return 16;
  16750. }
  16751. return 0;
  16752. }
  16753. #ifdef _WIN32
  16754. // Enumerate Windows system certificates and call callback with DER data
  16755. template <typename Callback>
  16756. inline bool enumerate_windows_system_certs(Callback cb) {
  16757. bool loaded = false;
  16758. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16759. for (auto store_name : store_names) {
  16760. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16761. if (hStore) {
  16762. PCCERT_CONTEXT pContext = nullptr;
  16763. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16764. nullptr) {
  16765. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16766. loaded = true;
  16767. }
  16768. }
  16769. CertCloseStore(hStore, 0);
  16770. }
  16771. }
  16772. return loaded;
  16773. }
  16774. #endif
  16775. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16776. // The trust a certificate's Trust Settings give it for SSL server
  16777. // verification (SecTrustSettings.h). An empty array trusts it as a root.
  16778. // Otherwise the first usage-constraints dictionary that applies decides: one
  16779. // naming a policy other than SSL, a host name or an application does not
  16780. // apply, and a result left out means TrustRoot. Keychain Access writes "Never
  16781. // Trust" as kSecTrustSettingsResultDeny.
  16782. inline SecTrustSettingsResult
  16783. macos_ssl_trust_settings_result(CFArrayRef trust_settings) {
  16784. auto count = CFArrayGetCount(trust_settings);
  16785. if (count == 0) { return kSecTrustSettingsResultTrustRoot; }
  16786. for (CFIndex i = 0; i < count; i++) {
  16787. auto value = CFArrayGetValueAtIndex(trust_settings, i);
  16788. if (!value || CFGetTypeID(value) != CFDictionaryGetTypeID()) { continue; }
  16789. auto constraint = static_cast<CFDictionaryRef>(value);
  16790. auto policy_value =
  16791. CFDictionaryGetValue(constraint, kSecTrustSettingsPolicy);
  16792. if (policy_value) {
  16793. auto policy = static_cast<SecPolicyRef>(const_cast<void *>(policy_value));
  16794. auto is_ssl = false;
  16795. if (auto properties = SecPolicyCopyProperties(policy)) {
  16796. auto oid = CFDictionaryGetValue(properties, kSecPolicyOid);
  16797. is_ssl = oid && CFEqual(oid, kSecPolicyAppleSSL);
  16798. CFRelease(properties);
  16799. }
  16800. if (!is_ssl) { continue; }
  16801. }
  16802. if (CFDictionaryContainsKey(constraint, kSecTrustSettingsPolicyString) ||
  16803. CFDictionaryContainsKey(constraint, kSecTrustSettingsApplication)) {
  16804. continue;
  16805. }
  16806. auto result = kSecTrustSettingsResultTrustRoot;
  16807. auto number = static_cast<CFNumberRef>(
  16808. CFDictionaryGetValue(constraint, kSecTrustSettingsResult));
  16809. if (number) {
  16810. SInt32 number_value = 0;
  16811. if (!CFNumberGetValue(number, kCFNumberSInt32Type, &number_value)) {
  16812. continue;
  16813. }
  16814. result = static_cast<SecTrustSettingsResult>(number_value);
  16815. }
  16816. if (result == kSecTrustSettingsResultTrustRoot ||
  16817. result == kSecTrustSettingsResultTrustAsRoot ||
  16818. result == kSecTrustSettingsResultDeny) {
  16819. return result;
  16820. }
  16821. }
  16822. return kSecTrustSettingsResultUnspecified;
  16823. }
  16824. // Enumerate the macOS Keychain certificates trusted for SSL and call callback
  16825. // with DER data. A certificate with Trust Settings is not trusted just by
  16826. // having them: the settings say whether it is, and a per-user setting
  16827. // overrides the admin domain's, which overrides the system domain's (whose
  16828. // roots are all trusted). So a system root the user set to "Never Trust" is
  16829. // left out, as is one trusted only for S/MIME or code signing.
  16830. template <typename Callback>
  16831. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16832. const SecTrustSettingsDomain domains[] = {
  16833. kSecTrustSettingsDomainUser,
  16834. kSecTrustSettingsDomainAdmin,
  16835. kSecTrustSettingsDomainSystem,
  16836. };
  16837. std::set<std::string> decided;
  16838. std::vector<std::string> trusted;
  16839. for (auto domain : domains) {
  16840. CFArrayRef certs = nullptr;
  16841. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16842. if (status != errSecSuccess || !certs) {
  16843. if (certs) CFRelease(certs);
  16844. continue;
  16845. }
  16846. CFIndex count = CFArrayGetCount(certs);
  16847. for (CFIndex i = 0; i < count; i++) {
  16848. SecCertificateRef cert =
  16849. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16850. CFDataRef data = SecCertificateCopyData(cert);
  16851. if (!data) { continue; }
  16852. std::string der(reinterpret_cast<const char *>(CFDataGetBytePtr(data)),
  16853. static_cast<size_t>(CFDataGetLength(data)));
  16854. CFRelease(data);
  16855. // Decided by a domain that overrides this one
  16856. if (decided.find(der) != decided.end()) { continue; }
  16857. auto result = kSecTrustSettingsResultTrustRoot;
  16858. if (domain != kSecTrustSettingsDomainSystem) {
  16859. result = kSecTrustSettingsResultUnspecified;
  16860. CFArrayRef trust_settings = nullptr;
  16861. if (SecTrustSettingsCopyTrustSettings(cert, domain, &trust_settings) ==
  16862. errSecSuccess &&
  16863. trust_settings) {
  16864. result = macos_ssl_trust_settings_result(trust_settings);
  16865. }
  16866. if (trust_settings) CFRelease(trust_settings);
  16867. }
  16868. // Neither trusted nor distrusted here; a domain below may decide
  16869. if (result == kSecTrustSettingsResultUnspecified) { continue; }
  16870. decided.insert(der);
  16871. if (result == kSecTrustSettingsResultTrustRoot ||
  16872. result == kSecTrustSettingsResultTrustAsRoot) {
  16873. trusted.push_back(std::move(der));
  16874. }
  16875. }
  16876. CFRelease(certs);
  16877. }
  16878. bool loaded = false;
  16879. for (const auto &der : trusted) {
  16880. if (cb(reinterpret_cast<const unsigned char *>(der.data()), der.size())) {
  16881. loaded = true;
  16882. }
  16883. }
  16884. return loaded;
  16885. }
  16886. #endif
  16887. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16888. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16889. // Common CA certificate file paths on Linux/Unix
  16890. inline const char **system_ca_paths() {
  16891. static const char *paths[] = {
  16892. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16893. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16894. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16895. "/etc/pki/tls/cacert.pem", // OpenELEC
  16896. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16897. nullptr};
  16898. return paths;
  16899. }
  16900. // Common CA certificate directory paths on Linux/Unix
  16901. inline const char **system_ca_dirs() {
  16902. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16903. "/etc/pki/tls/certs", // RHEL/CentOS
  16904. "/usr/share/ca-certificates", // Other
  16905. nullptr};
  16906. return dirs;
  16907. }
  16908. #endif
  16909. } // namespace impl
  16910. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16911. const char *ca_dir) {
  16912. if (!ctx) { return false; }
  16913. bool success = true;
  16914. if (ca_file && *ca_file) {
  16915. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16916. }
  16917. if (ca_dir && *ca_dir) {
  16918. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16919. }
  16920. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16921. // Set CA list for client certificate request (CertificateRequest message)
  16922. if (ca_file && *ca_file) {
  16923. auto list = SSL_load_client_CA_file(ca_file);
  16924. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16925. }
  16926. #endif
  16927. return success;
  16928. }
  16929. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16930. const char *password) {
  16931. return set_client_cert_pem(ctx, cert, key, password);
  16932. }
  16933. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16934. const char *key_path, const char *password) {
  16935. return set_client_cert_file(ctx, cert_path, key_path, password);
  16936. }
  16937. // PeerCert implementation
  16938. inline PeerCert::PeerCert() = default;
  16939. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16940. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16941. other.cert_ = nullptr;
  16942. }
  16943. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16944. if (this != &other) {
  16945. if (cert_) { free_cert(cert_); }
  16946. cert_ = other.cert_;
  16947. other.cert_ = nullptr;
  16948. }
  16949. return *this;
  16950. }
  16951. inline PeerCert::~PeerCert() {
  16952. if (cert_) { free_cert(cert_); }
  16953. }
  16954. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16955. inline std::string PeerCert::subject_cn() const {
  16956. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16957. }
  16958. inline std::string PeerCert::issuer_name() const {
  16959. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16960. }
  16961. inline bool PeerCert::check_hostname(const char *hostname) const {
  16962. return cert_ ? verify_hostname(cert_, hostname) : false;
  16963. }
  16964. inline std::vector<SanEntry> PeerCert::sans() const {
  16965. std::vector<SanEntry> result;
  16966. if (cert_) { get_cert_sans(cert_, result); }
  16967. return result;
  16968. }
  16969. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16970. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16971. }
  16972. inline std::string PeerCert::serial() const {
  16973. return cert_ ? get_cert_serial(cert_) : std::string();
  16974. }
  16975. // VerifyContext method implementations
  16976. inline std::string VerifyContext::subject_cn() const {
  16977. return cert ? get_cert_subject_cn(cert) : std::string();
  16978. }
  16979. inline std::string VerifyContext::issuer_name() const {
  16980. return cert ? get_cert_issuer_name(cert) : std::string();
  16981. }
  16982. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16983. return cert ? verify_hostname(cert, hostname) : false;
  16984. }
  16985. inline std::vector<SanEntry> VerifyContext::sans() const {
  16986. std::vector<SanEntry> result;
  16987. if (cert) { get_cert_sans(cert, result); }
  16988. return result;
  16989. }
  16990. inline bool VerifyContext::validity(time_t &not_before,
  16991. time_t &not_after) const {
  16992. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16993. }
  16994. inline std::string VerifyContext::serial() const {
  16995. return cert ? get_cert_serial(cert) : std::string();
  16996. }
  16997. // TlsError static method implementation
  16998. inline std::string TlsError::verify_error_to_string(long error_code) {
  16999. return verify_error_string(error_code);
  17000. }
  17001. } // namespace tls
  17002. // Request::peer_cert() implementation
  17003. inline tls::PeerCert Request::peer_cert() const {
  17004. return tls::get_peer_cert_from_session(ssl);
  17005. }
  17006. // Request::sni() implementation
  17007. inline std::string Request::sni() const {
  17008. if (!ssl) { return std::string(); }
  17009. const char *s = tls::get_sni(ssl);
  17010. return s ? std::string(s) : std::string();
  17011. }
  17012. #endif // CPPHTTPLIB_SSL_ENABLED
  17013. /*
  17014. * Group 8: TLS abstraction layer - OpenSSL backend
  17015. */
  17016. /*
  17017. * OpenSSL Backend Implementation
  17018. */
  17019. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17020. namespace tls {
  17021. namespace impl {
  17022. // Helper to map OpenSSL SSL_get_error to ErrorCode
  17023. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  17024. switch (ssl_error) {
  17025. case SSL_ERROR_NONE: return ErrorCode::Success;
  17026. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  17027. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  17028. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  17029. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  17030. case SSL_ERROR_SSL:
  17031. default: return ErrorCode::Fatal;
  17032. }
  17033. }
  17034. // Fills in a failed SSL_connect(). One that the server certificate's
  17035. // verification stopped reports the verify result, as the other backends and
  17036. // a check after the handshake do.
  17037. inline void fill_connect_error(SSL *ssl, int ret, TlsError &err) {
  17038. auto ssl_err = SSL_get_error(ssl, ret);
  17039. auto error = ERR_get_error();
  17040. err.code = map_ssl_error(ssl_err, err.sys_errno);
  17041. err.backend_code = error;
  17042. if (ssl_err != SSL_ERROR_SSL || ERR_GET_LIB(error) != ERR_LIB_SSL ||
  17043. ERR_GET_REASON(error) != SSL_R_CERTIFICATE_VERIFY_FAILED) {
  17044. return;
  17045. }
  17046. // A certificate only a verify callback turned down carries no verdict of
  17047. // its own, and fails as any other handshake does
  17048. auto verify_result = SSL_get_verify_result(ssl);
  17049. if (verify_result == X509_V_OK || verify_result == X509_V_ERR_UNSPECIFIED) {
  17050. return;
  17051. }
  17052. err.code = verify_result == X509_V_ERR_HOSTNAME_MISMATCH
  17053. ? ErrorCode::HostnameMismatch
  17054. : ErrorCode::CertVerifyFailed;
  17055. err.backend_code = static_cast<uint64_t>(verify_result);
  17056. }
  17057. // Helper: Create client CA list from PEM string
  17058. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  17059. // Caller takes ownership of returned list
  17060. inline STACK_OF(X509_NAME) *
  17061. create_client_ca_list_from_pem(const char *ca_pem) {
  17062. if (!ca_pem) { return nullptr; }
  17063. auto ca_list = sk_X509_NAME_new_null();
  17064. if (!ca_list) { return nullptr; }
  17065. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  17066. if (!bio) {
  17067. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  17068. return nullptr;
  17069. }
  17070. X509 *cert = nullptr;
  17071. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17072. nullptr) {
  17073. const X509_NAME *name = X509_get_subject_name(cert);
  17074. if (name) {
  17075. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  17076. }
  17077. X509_free(cert);
  17078. }
  17079. BIO_free(bio);
  17080. return ca_list;
  17081. }
  17082. inline void free_verify_callback(void * /*parent*/, void *ptr,
  17083. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  17084. long /*argl*/, void * /*argp*/) {
  17085. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  17086. }
  17087. // The SSL_CTX owns its verify callback, so each client or server sees only
  17088. // its own, on whichever thread runs the handshake.
  17089. inline int verify_callback_index() {
  17090. static const auto index = SSL_CTX_get_ex_new_index(
  17091. 0, nullptr, nullptr, nullptr, free_verify_callback);
  17092. return index;
  17093. }
  17094. // OpenSSL verify callback wrapper
  17095. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  17096. // Get SSL object from X509_STORE_CTX
  17097. auto ssl = static_cast<SSL *>(
  17098. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  17099. if (!ssl) { return preverify_ok; }
  17100. std::shared_ptr<VerifyCallback> callback;
  17101. {
  17102. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  17103. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  17104. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  17105. if (stored) { callback = *stored; }
  17106. }
  17107. if (!callback) { return preverify_ok; }
  17108. // Get current certificate and depth
  17109. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  17110. int depth = X509_STORE_CTX_get_error_depth(ctx);
  17111. int error = X509_STORE_CTX_get_error(ctx);
  17112. // Build context
  17113. VerifyContext verify_ctx;
  17114. verify_ctx.session = static_cast<session_t>(ssl);
  17115. verify_ctx.cert = static_cast<cert_t>(cert);
  17116. verify_ctx.depth = depth;
  17117. verify_ctx.preverify_ok = (preverify_ok != 0);
  17118. verify_ctx.error_code = error;
  17119. verify_ctx.error_string =
  17120. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  17121. auto accepted = run_verify_callback(*callback, verify_ctx);
  17122. // A client verifying the server during the handshake, which is what
  17123. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  17124. if (!SSL_is_server(ssl) &&
  17125. (SSL_get_verify_mode(ssl) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  17126. accepted = accepted && preverify_ok;
  17127. }
  17128. return accepted ? 1 : 0;
  17129. }
  17130. // Sets the verify mode from whether the peer's certificate is required and
  17131. // whether a verify callback is set.
  17132. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  17133. auto has_callback =
  17134. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  17135. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  17136. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  17137. SSL_CTX_set_verify(ssl_ctx, mode,
  17138. has_callback ? openssl_verify_callback : nullptr);
  17139. }
  17140. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  17141. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  17142. // that must be released with release_store_objects
  17143. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  17144. OPENSSL_VERSION_NUMBER >= 0x30300000L
  17145. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17146. #endif
  17147. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  17148. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17149. return X509_STORE_get1_objects(store);
  17150. #else
  17151. return X509_STORE_get0_objects(store);
  17152. #endif
  17153. }
  17154. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  17155. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17156. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  17157. #else
  17158. (void)objs; // get0 variant returns an internal pointer; nothing to free
  17159. #endif
  17160. }
  17161. } // namespace impl
  17162. inline ctx_t create_client_context() {
  17163. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  17164. if (ctx) {
  17165. // Disable auto-retry to properly handle non-blocking I/O
  17166. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  17167. // Set minimum TLS version
  17168. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17169. }
  17170. return static_cast<ctx_t>(ctx);
  17171. }
  17172. inline void free_context(ctx_t ctx) {
  17173. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  17174. }
  17175. inline bool set_min_version(ctx_t ctx, Version version) {
  17176. if (!ctx) return false;
  17177. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  17178. static_cast<uint16_t>(version)) == 1;
  17179. }
  17180. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17181. if (!ctx || !pem || len == 0) return false;
  17182. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17183. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17184. if (!store) return false;
  17185. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  17186. if (!bio) return false;
  17187. bool ok = true;
  17188. X509 *cert = nullptr;
  17189. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17190. nullptr) {
  17191. if (X509_STORE_add_cert(store, cert) != 1) {
  17192. // Ignore duplicate errors
  17193. auto err = ERR_peek_last_error();
  17194. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  17195. ok = false;
  17196. }
  17197. }
  17198. X509_free(cert);
  17199. if (!ok) break;
  17200. }
  17201. BIO_free(bio);
  17202. // Clear any "no more certificates" errors
  17203. ERR_clear_error();
  17204. return ok;
  17205. }
  17206. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17207. if (!ctx || !file_path) return false;
  17208. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  17209. nullptr) == 1;
  17210. }
  17211. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17212. if (!ctx || !dir_path) return false;
  17213. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17214. dir_path) == 1;
  17215. }
  17216. inline bool load_system_certs(ctx_t ctx) {
  17217. if (!ctx) return false;
  17218. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17219. #ifdef _WIN32
  17220. // Windows: Load from system certificate store (ROOT and CA)
  17221. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17222. if (!store) return false;
  17223. bool loaded_any = false;
  17224. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17225. for (auto store_name : store_names) {
  17226. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17227. if (!hStore) continue;
  17228. PCCERT_CONTEXT pContext = nullptr;
  17229. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17230. nullptr) {
  17231. const unsigned char *data = pContext->pbCertEncoded;
  17232. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17233. if (x509) {
  17234. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17235. X509_free(x509);
  17236. }
  17237. }
  17238. CertCloseStore(hStore, 0);
  17239. }
  17240. return loaded_any;
  17241. #elif defined(__APPLE__)
  17242. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17243. // macOS: Load from Keychain
  17244. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17245. if (!store) return false;
  17246. auto loaded_any = impl::enumerate_macos_keychain_certs(
  17247. [&](const unsigned char *data, size_t len) {
  17248. auto x509 = d2i_X509(nullptr, &data, static_cast<long>(len));
  17249. if (!x509) { return false; }
  17250. auto added = X509_STORE_add_cert(store, x509) == 1;
  17251. X509_free(x509);
  17252. return added;
  17253. });
  17254. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17255. #else
  17256. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17257. #endif
  17258. #else
  17259. // Other Unix: use default verify paths
  17260. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17261. #endif
  17262. }
  17263. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17264. const char *password) {
  17265. if (!ctx || !cert || !key) return false;
  17266. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17267. // Load certificate
  17268. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17269. if (!cert_bio) return false;
  17270. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17271. BIO_free(cert_bio);
  17272. if (!x509) return false;
  17273. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17274. X509_free(x509);
  17275. if (!cert_ok) return false;
  17276. // Load private key
  17277. auto key_bio = BIO_new_mem_buf(key, -1);
  17278. if (!key_bio) return false;
  17279. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17280. password ? const_cast<char *>(password)
  17281. : nullptr);
  17282. BIO_free(key_bio);
  17283. if (!pkey) return false;
  17284. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17285. EVP_PKEY_free(pkey);
  17286. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17287. }
  17288. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17289. const char *key_path, const char *password) {
  17290. if (!ctx || !cert_path || !key_path) return false;
  17291. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17292. if (password && password[0] != '\0') {
  17293. SSL_CTX_set_default_passwd_cb_userdata(
  17294. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17295. }
  17296. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17297. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17298. }
  17299. inline ctx_t create_server_context() {
  17300. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17301. if (ctx) {
  17302. // No renegotiation, as on the other backends: it would run a handshake
  17303. // that SSLServer::update_certs_pem() does not wait for
  17304. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17305. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17306. SSL_OP_NO_RENEGOTIATION);
  17307. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17308. // Without one, a client resuming its session is sent a fatal alert once
  17309. // client certificates are verified.
  17310. static const unsigned char sid_ctx[] = "cpp-httplib";
  17311. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17312. }
  17313. return static_cast<ctx_t>(ctx);
  17314. }
  17315. inline void set_verify_client(ctx_t ctx, bool require) {
  17316. if (!ctx) return;
  17317. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17318. }
  17319. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17320. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17321. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17322. SSL *ssl = SSL_new(ssl_ctx);
  17323. if (!ssl) return nullptr;
  17324. // Disable auto-retry for proper non-blocking I/O handling
  17325. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17326. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17327. if (!bio) {
  17328. SSL_free(ssl);
  17329. return nullptr;
  17330. }
  17331. SSL_set_bio(ssl, bio, bio);
  17332. return static_cast<session_t>(ssl);
  17333. }
  17334. inline void free_session(session_t session) {
  17335. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17336. }
  17337. inline bool set_sni(session_t session, const char *hostname,
  17338. bool verify_hostname) {
  17339. if (!session || !hostname) return false;
  17340. auto ssl = static_cast<SSL *>(session);
  17341. // The handshake's chain verification then checks the name as well
  17342. if (verify_hostname) {
  17343. auto param = SSL_get0_param(ssl);
  17344. X509_VERIFY_PARAM_set_hostflags(param, X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
  17345. if (X509_VERIFY_PARAM_set1_host(param, hostname, strlen(hostname)) != 1) {
  17346. return false;
  17347. }
  17348. }
  17349. #if defined(OPENSSL_IS_BORINGSSL)
  17350. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17351. #else
  17352. // Direct call instead of macro to suppress -Wold-style-cast warning
  17353. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17354. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17355. #endif
  17356. }
  17357. inline TlsError connect(session_t session) {
  17358. if (!session) { return TlsError(); }
  17359. auto ssl = static_cast<SSL *>(session);
  17360. auto ret = SSL_connect(ssl);
  17361. TlsError err;
  17362. if (ret == 1) {
  17363. err.code = ErrorCode::Success;
  17364. } else {
  17365. impl::fill_connect_error(ssl, ret, err);
  17366. }
  17367. return err;
  17368. }
  17369. inline TlsError accept(session_t session) {
  17370. if (!session) { return TlsError(); }
  17371. auto ssl = static_cast<SSL *>(session);
  17372. auto ret = SSL_accept(ssl);
  17373. TlsError err;
  17374. if (ret == 1) {
  17375. err.code = ErrorCode::Success;
  17376. } else {
  17377. auto ssl_err = SSL_get_error(ssl, ret);
  17378. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17379. err.backend_code = ERR_get_error();
  17380. }
  17381. return err;
  17382. }
  17383. inline bool connect_nonblocking(session_t session, socket_t sock,
  17384. time_t timeout_sec, time_t timeout_usec,
  17385. TlsError *err) {
  17386. if (!session) {
  17387. if (err) { err->code = ErrorCode::Fatal; }
  17388. return false;
  17389. }
  17390. auto ssl = static_cast<SSL *>(session);
  17391. auto bio = SSL_get_rbio(ssl);
  17392. // Set non-blocking mode for handshake
  17393. detail::set_nonblocking(sock, true);
  17394. if (bio) { BIO_set_nbio(bio, 1); }
  17395. auto cleanup = detail::scope_exit([&]() {
  17396. // Restore blocking mode after handshake
  17397. if (bio) { BIO_set_nbio(bio, 0); }
  17398. detail::set_nonblocking(sock, false);
  17399. });
  17400. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17401. auto res = 0;
  17402. while ((res = SSL_connect(ssl)) != 1) {
  17403. auto ssl_err = SSL_get_error(ssl, res);
  17404. switch (ssl_err) {
  17405. case SSL_ERROR_WANT_READ:
  17406. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17407. break;
  17408. case SSL_ERROR_WANT_WRITE:
  17409. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17410. break;
  17411. default: break;
  17412. }
  17413. if (err) { impl::fill_connect_error(ssl, res, *err); }
  17414. return false;
  17415. }
  17416. if (err) { err->code = ErrorCode::Success; }
  17417. return true;
  17418. }
  17419. inline bool accept_nonblocking(session_t session, socket_t sock,
  17420. time_t timeout_sec, time_t timeout_usec,
  17421. TlsError *err) {
  17422. if (!session) {
  17423. if (err) { err->code = ErrorCode::Fatal; }
  17424. return false;
  17425. }
  17426. auto ssl = static_cast<SSL *>(session);
  17427. auto bio = SSL_get_rbio(ssl);
  17428. // Set non-blocking mode for handshake
  17429. detail::set_nonblocking(sock, true);
  17430. if (bio) { BIO_set_nbio(bio, 1); }
  17431. auto cleanup = detail::scope_exit([&]() {
  17432. // Restore blocking mode after handshake
  17433. if (bio) { BIO_set_nbio(bio, 0); }
  17434. detail::set_nonblocking(sock, false);
  17435. });
  17436. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17437. auto res = 0;
  17438. while ((res = SSL_accept(ssl)) != 1) {
  17439. auto ssl_err = SSL_get_error(ssl, res);
  17440. switch (ssl_err) {
  17441. case SSL_ERROR_WANT_READ:
  17442. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17443. break;
  17444. case SSL_ERROR_WANT_WRITE:
  17445. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17446. break;
  17447. default: break;
  17448. }
  17449. if (err) {
  17450. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17451. err->backend_code = ERR_get_error();
  17452. }
  17453. return false;
  17454. }
  17455. if (err) { err->code = ErrorCode::Success; }
  17456. return true;
  17457. }
  17458. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17459. if (!session || !buf) {
  17460. err.code = ErrorCode::Fatal;
  17461. return -1;
  17462. }
  17463. auto ssl = static_cast<SSL *>(session);
  17464. constexpr auto max_len =
  17465. static_cast<size_t>((std::numeric_limits<int>::max)());
  17466. if (len > max_len) { len = max_len; }
  17467. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17468. if (ret > 0) {
  17469. err.code = ErrorCode::Success;
  17470. return ret;
  17471. }
  17472. auto ssl_err = SSL_get_error(ssl, ret);
  17473. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17474. if (err.code == ErrorCode::PeerClosed) {
  17475. return 0;
  17476. } // Gracefully handle the peer closed state.
  17477. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17478. return -1;
  17479. }
  17480. inline ssize_t write(session_t session, const void *buf, size_t len,
  17481. TlsError &err) {
  17482. if (!session || !buf) {
  17483. err.code = ErrorCode::Fatal;
  17484. return -1;
  17485. }
  17486. auto ssl = static_cast<SSL *>(session);
  17487. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17488. if (ret > 0) {
  17489. err.code = ErrorCode::Success;
  17490. return ret;
  17491. }
  17492. auto ssl_err = SSL_get_error(ssl, ret);
  17493. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17494. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17495. return -1;
  17496. }
  17497. inline int pending(const_session_t session) {
  17498. if (!session) return 0;
  17499. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17500. }
  17501. inline void shutdown(session_t session, bool graceful) {
  17502. if (!session) return;
  17503. auto ssl = static_cast<SSL *>(session);
  17504. if (graceful) {
  17505. // Send close_notify without waiting for the peer's. The connection is
  17506. // closed right after this, so a unidirectional shutdown is enough, and an
  17507. // idle peer that never answers would otherwise hold this thread until the
  17508. // read timeout. The other backends do not wait either.
  17509. SSL_shutdown(ssl);
  17510. }
  17511. }
  17512. inline bool is_peer_closed(session_t session, socket_t sock) {
  17513. if (!session) return true;
  17514. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17515. detail::set_nonblocking(sock, true);
  17516. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17517. auto ssl = static_cast<SSL *>(session);
  17518. char buf;
  17519. auto ret = SSL_peek(ssl, &buf, 1);
  17520. if (ret > 0) return false;
  17521. auto err = SSL_get_error(ssl, ret);
  17522. return err == SSL_ERROR_ZERO_RETURN;
  17523. }
  17524. inline cert_t get_peer_cert(const_session_t session) {
  17525. if (!session) return nullptr;
  17526. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17527. static_cast<SSL *>(const_cast<void *>(session))));
  17528. }
  17529. inline size_t get_peer_certs(const_session_t session,
  17530. std::vector<cert_t> &certs) {
  17531. certs.clear();
  17532. if (!session) { return 0; }
  17533. auto ssl = static_cast<const SSL *>(session);
  17534. // On the server side, the chain leaves out the peer's own certificate
  17535. if (SSL_is_server(ssl)) {
  17536. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17537. }
  17538. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17539. auto count = sk_X509_num(sk);
  17540. for (decltype(count) i = 0; i < count; i++) {
  17541. auto x509 = sk_X509_value(sk, i);
  17542. X509_up_ref(x509);
  17543. certs.push_back(static_cast<cert_t>(x509));
  17544. }
  17545. }
  17546. return certs.size();
  17547. }
  17548. inline void free_cert(cert_t cert) {
  17549. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17550. }
  17551. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17552. if (!cert || !hostname) return false;
  17553. auto x509 = static_cast<X509 *>(cert);
  17554. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17555. if (detail::is_ip_address(hostname)) {
  17556. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17557. }
  17558. return X509_check_host(x509, hostname, strlen(hostname),
  17559. X509_CHECK_FLAG_NEVER_CHECK_SUBJECT, nullptr) == 1;
  17560. }
  17561. inline uint64_t hostname_mismatch_code() {
  17562. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17563. }
  17564. inline long get_verify_result(const_session_t session) {
  17565. if (!session) return X509_V_ERR_UNSPECIFIED;
  17566. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17567. }
  17568. inline std::string get_cert_subject_cn(cert_t cert) {
  17569. if (!cert) return "";
  17570. auto x509 = static_cast<X509 *>(cert);
  17571. auto subject_name = X509_get_subject_name(x509);
  17572. if (!subject_name) return "";
  17573. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17574. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17575. if (idx < 0) return "";
  17576. auto entry = X509_NAME_get_entry(subject_name, idx);
  17577. if (!entry) return "";
  17578. auto data = X509_NAME_ENTRY_get_data(entry);
  17579. if (!data) return "";
  17580. return std::string(
  17581. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17582. static_cast<size_t>(ASN1_STRING_length(data)));
  17583. }
  17584. inline std::string get_cert_issuer_name(cert_t cert) {
  17585. if (!cert) return "";
  17586. auto x509 = static_cast<X509 *>(cert);
  17587. auto issuer_name = X509_get_issuer_name(x509);
  17588. if (!issuer_name) return "";
  17589. char buf[256];
  17590. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17591. return std::string(buf);
  17592. }
  17593. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17594. sans.clear();
  17595. if (!cert) return false;
  17596. auto x509 = static_cast<X509 *>(cert);
  17597. auto names = static_cast<GENERAL_NAMES *>(
  17598. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17599. if (!names) return true; // No SANs is valid
  17600. auto count = sk_GENERAL_NAME_num(names);
  17601. for (decltype(count) i = 0; i < count; i++) {
  17602. auto gen = sk_GENERAL_NAME_value(names, i);
  17603. if (!gen) continue;
  17604. SanEntry entry;
  17605. switch (gen->type) {
  17606. case GEN_DNS:
  17607. entry.type = SanType::DNS;
  17608. if (gen->d.dNSName) {
  17609. entry.value = std::string(
  17610. reinterpret_cast<const char *>(
  17611. ASN1_STRING_get0_data(gen->d.dNSName)),
  17612. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17613. }
  17614. break;
  17615. case GEN_IPADD:
  17616. entry.type = SanType::IP;
  17617. if (gen->d.iPAddress) {
  17618. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17619. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17620. if (len == 4) {
  17621. // IPv4
  17622. char buf[INET_ADDRSTRLEN];
  17623. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17624. entry.value = buf;
  17625. } else if (len == 16) {
  17626. // IPv6
  17627. char buf[INET6_ADDRSTRLEN];
  17628. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17629. entry.value = buf;
  17630. }
  17631. }
  17632. break;
  17633. case GEN_EMAIL:
  17634. entry.type = SanType::EMAIL;
  17635. if (gen->d.rfc822Name) {
  17636. entry.value = std::string(
  17637. reinterpret_cast<const char *>(
  17638. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17639. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17640. }
  17641. break;
  17642. case GEN_URI:
  17643. entry.type = SanType::URI;
  17644. if (gen->d.uniformResourceIdentifier) {
  17645. entry.value = std::string(
  17646. reinterpret_cast<const char *>(
  17647. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17648. static_cast<size_t>(
  17649. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17650. }
  17651. break;
  17652. default: entry.type = SanType::OTHER; break;
  17653. }
  17654. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17655. }
  17656. GENERAL_NAMES_free(names);
  17657. return true;
  17658. }
  17659. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17660. time_t &not_after) {
  17661. if (!cert) return false;
  17662. auto x509 = static_cast<X509 *>(cert);
  17663. auto nb = X509_get0_notBefore(x509);
  17664. auto na = X509_get0_notAfter(x509);
  17665. if (!nb || !na) return false;
  17666. ASN1_TIME *epoch = ASN1_TIME_new();
  17667. if (!epoch) return false;
  17668. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17669. if (!ASN1_TIME_set(epoch, 0)) return false;
  17670. int pday, psec;
  17671. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17672. not_before = 86400 * (time_t)pday + psec;
  17673. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17674. not_after = 86400 * (time_t)pday + psec;
  17675. return true;
  17676. }
  17677. inline std::string get_cert_serial(cert_t cert) {
  17678. if (!cert) return "";
  17679. auto x509 = static_cast<X509 *>(cert);
  17680. auto serial = X509_get_serialNumber(x509);
  17681. if (!serial) return "";
  17682. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17683. if (!bn) return "";
  17684. auto hex = BN_bn2hex(bn);
  17685. BN_free(bn);
  17686. if (!hex) return "";
  17687. std::string result(hex);
  17688. OPENSSL_free(hex);
  17689. return result;
  17690. }
  17691. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17692. if (!cert) return false;
  17693. auto x509 = static_cast<X509 *>(cert);
  17694. auto len = i2d_X509(x509, nullptr);
  17695. if (len < 0) return false;
  17696. der.resize(static_cast<size_t>(len));
  17697. auto p = der.data();
  17698. i2d_X509(x509, &p);
  17699. return true;
  17700. }
  17701. inline const char *get_sni(const_session_t session) {
  17702. if (!session) return nullptr;
  17703. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17704. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17705. }
  17706. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17707. inline uint64_t get_error() { return ERR_get_error(); }
  17708. inline std::string error_string(uint64_t code) {
  17709. char buf[256];
  17710. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17711. sizeof(buf));
  17712. return std::string(buf);
  17713. }
  17714. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17715. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17716. if (!mem) { return nullptr; }
  17717. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17718. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17719. if (!inf) { return nullptr; }
  17720. auto store = X509_STORE_new();
  17721. if (store) {
  17722. auto count = sk_X509_INFO_num(inf);
  17723. for (decltype(count) i = 0; i < count; i++) {
  17724. auto itmp = sk_X509_INFO_value(inf, i);
  17725. if (!itmp) { continue; }
  17726. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17727. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17728. }
  17729. }
  17730. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17731. return static_cast<ca_store_t>(store);
  17732. }
  17733. inline void free_ca_store(ca_store_t store) {
  17734. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17735. }
  17736. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17737. if (!ctx || !store) { return false; }
  17738. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17739. auto x509_store = static_cast<X509_STORE *>(store);
  17740. // Check if same store is already set
  17741. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17742. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17743. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17744. return true;
  17745. }
  17746. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17747. certs.clear();
  17748. if (!ctx) { return 0; }
  17749. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17750. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17751. if (!store) { return 0; }
  17752. auto objs = impl::get_store_objects(store);
  17753. if (!objs) { return 0; }
  17754. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17755. auto count = sk_X509_OBJECT_num(objs);
  17756. for (decltype(count) i = 0; i < count; i++) {
  17757. auto obj = sk_X509_OBJECT_value(objs, i);
  17758. if (!obj) { continue; }
  17759. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17760. auto x509 = X509_OBJECT_get0_X509(obj);
  17761. if (x509) {
  17762. // Increment reference count so caller can free it
  17763. X509_up_ref(x509);
  17764. certs.push_back(static_cast<cert_t>(x509));
  17765. }
  17766. }
  17767. }
  17768. return certs.size();
  17769. }
  17770. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17771. std::vector<std::string> names;
  17772. if (!ctx) { return names; }
  17773. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17774. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17775. if (!store) { return names; }
  17776. auto objs = impl::get_store_objects(store);
  17777. if (!objs) { return names; }
  17778. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17779. auto count = sk_X509_OBJECT_num(objs);
  17780. for (decltype(count) i = 0; i < count; i++) {
  17781. auto obj = sk_X509_OBJECT_value(objs, i);
  17782. if (!obj) { continue; }
  17783. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17784. auto x509 = X509_OBJECT_get0_X509(obj);
  17785. if (x509) {
  17786. auto subject = X509_get_subject_name(x509);
  17787. if (subject) {
  17788. char buf[512];
  17789. X509_NAME_oneline(subject, buf, sizeof(buf));
  17790. names.push_back(buf);
  17791. }
  17792. }
  17793. }
  17794. }
  17795. return names;
  17796. }
  17797. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17798. const char *key_pem, const char *password) {
  17799. if (!ctx || !cert_pem || !key_pem) { return false; }
  17800. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17801. // Load certificate from PEM
  17802. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17803. if (!cert_bio) { return false; }
  17804. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17805. BIO_free(cert_bio);
  17806. if (!cert) { return false; }
  17807. // Load private key from PEM
  17808. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17809. if (!key_bio) {
  17810. X509_free(cert);
  17811. return false;
  17812. }
  17813. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17814. password ? const_cast<char *>(password)
  17815. : nullptr);
  17816. BIO_free(key_bio);
  17817. if (!key) {
  17818. X509_free(cert);
  17819. return false;
  17820. }
  17821. // Update certificate and key
  17822. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17823. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17824. X509_free(cert);
  17825. EVP_PKEY_free(key);
  17826. return ret;
  17827. }
  17828. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17829. if (!ctx || !ca_pem) { return false; }
  17830. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17831. // Create new X509_STORE from PEM
  17832. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17833. if (!store) { return false; }
  17834. // A resumed session is not verified again, so the ticket keys from before
  17835. // go, or a client verified under the old CAs could go on resuming.
  17836. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  17837. unsigned char ticket_keys[48];
  17838. #else
  17839. unsigned char ticket_keys[80];
  17840. #endif
  17841. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  17842. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  17843. sizeof(ticket_keys)) != 1) {
  17844. free_ca_store(store);
  17845. return false;
  17846. }
  17847. // SSL_CTX_set_cert_store takes ownership
  17848. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17849. // Set client CA list for client certificate request
  17850. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17851. if (ca_list) {
  17852. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17853. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17854. }
  17855. // The cached sessions go for the same reason.
  17856. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17857. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17858. #else
  17859. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17860. #endif
  17861. return true;
  17862. }
  17863. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17864. if (!ctx) { return false; }
  17865. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17866. auto index = impl::verify_callback_index();
  17867. if (index < 0) { return false; }
  17868. std::shared_ptr<VerifyCallback> *stored = nullptr;
  17869. if (callback) {
  17870. stored = new std::shared_ptr<VerifyCallback>(
  17871. std::make_shared<VerifyCallback>(std::move(callback)));
  17872. }
  17873. std::shared_ptr<VerifyCallback> *previous = nullptr;
  17874. {
  17875. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  17876. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  17877. SSL_CTX_get_ex_data(ssl_ctx, index));
  17878. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  17879. delete stored;
  17880. return false;
  17881. }
  17882. }
  17883. // A handshake running the previous callback keeps it until it returns.
  17884. delete previous;
  17885. // A resumed handshake shows no certificate to run the callback on.
  17886. if (stored) {
  17887. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  17888. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  17889. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  17890. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  17891. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  17892. #endif
  17893. }
  17894. // Keep requiring the peer's certificate if set_verify_client() asked for it
  17895. auto require =
  17896. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  17897. impl::apply_verify_mode(ssl_ctx, require);
  17898. return true;
  17899. }
  17900. inline long get_verify_error(const_session_t session) {
  17901. if (!session) { return -1; }
  17902. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17903. return SSL_get_verify_result(ssl);
  17904. }
  17905. inline std::string verify_error_string(long error_code) {
  17906. if (error_code == X509_V_OK) { return ""; }
  17907. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17908. return str ? str : "unknown error";
  17909. }
  17910. } // namespace tls
  17911. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17912. /*
  17913. * Group 9: TLS abstraction layer - Mbed TLS backend
  17914. */
  17915. /*
  17916. * Mbed TLS Backend Implementation
  17917. */
  17918. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17919. namespace tls {
  17920. namespace impl {
  17921. // Mbed TLS session wrapper
  17922. struct MbedTlsSession {
  17923. mbedtls_ssl_context ssl;
  17924. socket_t sock = INVALID_SOCKET;
  17925. std::string hostname; // For client: set via set_sni
  17926. std::string sni_hostname; // For server: received from client via SNI callback
  17927. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17928. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17929. // (e.g. a response that arrived while this side was still in its post-write
  17930. // check), the byte is pushed back here and served by the next read().
  17931. unsigned char peeked_byte = 0;
  17932. bool has_peeked_byte = false;
  17933. // Set by set_sni() when the caller disabled hostname verification, so the
  17934. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17935. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17936. // OpenSSL and wolfSSL keep them independent).
  17937. bool suppress_hostname_mismatch = false;
  17938. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17939. // ever runs the callback of its own context.
  17940. VerifyCallback verify_callback;
  17941. bool is_server = false;
  17942. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17943. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17944. MbedTlsSession(const MbedTlsSession &) = delete;
  17945. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17946. };
  17947. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17948. // queue)
  17949. inline int &mbedtls_last_error() {
  17950. static thread_local int err = 0;
  17951. return err;
  17952. }
  17953. // Helper to map Mbed TLS error to ErrorCode
  17954. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17955. uint32_t verify_flags) {
  17956. if (ret == 0) { return ErrorCode::Success; }
  17957. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17958. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17959. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17960. return ErrorCode::PeerClosed;
  17961. }
  17962. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17963. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17964. out_errno = errno;
  17965. return ErrorCode::SyscallError;
  17966. }
  17967. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17968. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17969. // the handshake's chain verification (see set_sni()); a mismatch there
  17970. // is reported the same way as any other verify_flags bit. Report it as
  17971. // HostnameMismatch, matching the other backends and the post-handshake
  17972. // identity check below, but only when naming is the sole problem -
  17973. // if the chain itself is also untrusted/expired/etc., that takes
  17974. // priority over the naming detail.
  17975. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17976. return ErrorCode::HostnameMismatch;
  17977. }
  17978. return ErrorCode::CertVerifyFailed;
  17979. }
  17980. return ErrorCode::Fatal;
  17981. }
  17982. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17983. // return value, including the verify-flags-dependent HostnameMismatch
  17984. // mapping; shared by connect() and connect_nonblocking() so the
  17985. // backend_code policy for that mapping only lives in one place.
  17986. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17987. int ret) {
  17988. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17989. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17990. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17991. ? static_cast<uint64_t>(verify_flags)
  17992. : static_cast<uint64_t>(-ret);
  17993. }
  17994. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17995. // non-fatal notification delivered between records, not an error and not
  17996. // application data, so I/O calls that see it should just be retried. Kept in
  17997. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17998. // splitting the closing brace across an #if.
  17999. inline bool mbedtls_is_session_ticket(int ret) {
  18000. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  18001. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  18002. #else
  18003. (void)ret;
  18004. return false;
  18005. #endif
  18006. }
  18007. // BIO-like send callback for Mbed TLS
  18008. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  18009. size_t len) {
  18010. auto sock = *static_cast<socket_t *>(ctx);
  18011. #ifdef _WIN32
  18012. auto ret =
  18013. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  18014. if (ret == SOCKET_ERROR) {
  18015. int err = WSAGetLastError();
  18016. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  18017. return MBEDTLS_ERR_NET_SEND_FAILED;
  18018. }
  18019. #else
  18020. auto ret = send(sock, buf, len, 0);
  18021. if (ret < 0) {
  18022. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18023. return MBEDTLS_ERR_SSL_WANT_WRITE;
  18024. }
  18025. return MBEDTLS_ERR_NET_SEND_FAILED;
  18026. }
  18027. #endif
  18028. return static_cast<int>(ret);
  18029. }
  18030. // BIO-like recv callback for Mbed TLS
  18031. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  18032. auto sock = *static_cast<socket_t *>(ctx);
  18033. #ifdef _WIN32
  18034. auto ret =
  18035. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  18036. if (ret == SOCKET_ERROR) {
  18037. int err = WSAGetLastError();
  18038. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  18039. return MBEDTLS_ERR_NET_RECV_FAILED;
  18040. }
  18041. #else
  18042. auto ret = recv(sock, buf, len, 0);
  18043. if (ret < 0) {
  18044. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18045. return MBEDTLS_ERR_SSL_WANT_READ;
  18046. }
  18047. return MBEDTLS_ERR_NET_RECV_FAILED;
  18048. }
  18049. #endif
  18050. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  18051. return static_cast<int>(ret);
  18052. }
  18053. // MbedTlsContext constructor/destructor implementations
  18054. inline MbedTlsContext::MbedTlsContext() {
  18055. mbedtls_ssl_config_init(&conf);
  18056. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18057. mbedtls_entropy_init(&entropy);
  18058. mbedtls_ctr_drbg_init(&ctr_drbg);
  18059. #endif
  18060. mbedtls_x509_crt_init(&ca_chain);
  18061. mbedtls_x509_crt_init(&own_cert);
  18062. mbedtls_pk_init(&own_key);
  18063. }
  18064. inline MbedTlsContext::~MbedTlsContext() {
  18065. mbedtls_pk_free(&own_key);
  18066. mbedtls_x509_crt_free(&own_cert);
  18067. mbedtls_x509_crt_free(&ca_chain);
  18068. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18069. mbedtls_ctr_drbg_free(&ctr_drbg);
  18070. mbedtls_entropy_free(&entropy);
  18071. #endif
  18072. mbedtls_ssl_config_free(&conf);
  18073. }
  18074. // Thread-local storage for SNI captured during handshake
  18075. // This is needed because the SNI callback doesn't have a way to pass
  18076. // session-specific data before the session is fully set up
  18077. inline std::string &mbedpending_sni() {
  18078. static thread_local std::string sni;
  18079. return sni;
  18080. }
  18081. // SNI callback for Mbed TLS server to capture client's SNI hostname
  18082. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  18083. const unsigned char *name, size_t name_len) {
  18084. (void)p_ctx;
  18085. (void)ssl;
  18086. // Store SNI name in thread-local storage
  18087. // It will be retrieved and stored in the session after handshake
  18088. if (name && name_len > 0) {
  18089. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  18090. } else {
  18091. mbedpending_sni().clear();
  18092. }
  18093. return 0; // Accept any SNI
  18094. }
  18095. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  18096. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  18097. }
  18098. // MbedTLS verify callback wrapper
  18099. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  18100. int cert_depth, uint32_t *flags) {
  18101. // data points to the MbedTlsSession
  18102. auto *session = static_cast<MbedTlsSession *>(data);
  18103. // set_sni() disabled hostname verification for this session: ignore the
  18104. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  18105. // pass/fail decision still comes from the remaining flags (and, below, from
  18106. // the user's own verify callback).
  18107. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  18108. const auto &callback = session->verify_callback;
  18109. if (!callback) { return 0; } // Continue with default verification
  18110. // Build context
  18111. VerifyContext verify_ctx;
  18112. verify_ctx.session = static_cast<session_t>(session);
  18113. verify_ctx.cert = static_cast<cert_t>(crt);
  18114. verify_ctx.depth = cert_depth;
  18115. verify_ctx.preverify_ok = (*flags == 0);
  18116. verify_ctx.error_code = static_cast<long>(*flags);
  18117. // Convert Mbed TLS flags to error string
  18118. static thread_local char error_buf[256];
  18119. if (*flags != 0) {
  18120. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  18121. verify_ctx.error_string = error_buf;
  18122. } else {
  18123. verify_ctx.error_string = nullptr;
  18124. }
  18125. bool accepted = run_verify_callback(callback, verify_ctx);
  18126. if (accepted) {
  18127. // Overrides the built-in verification only on a server, as on OpenSSL and
  18128. // wolfSSL, whose clients check the verify result after the handshake
  18129. if (session->is_server) { *flags = 0; }
  18130. return 0;
  18131. }
  18132. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  18133. }
  18134. // Sets the authentication mode from whether the peer's certificate is required
  18135. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  18136. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  18137. inline void apply_verify_mode(MbedTlsContext &mctx) {
  18138. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  18139. if (mctx.verify_client) {
  18140. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  18141. } else if (mctx.verify_callback) {
  18142. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  18143. }
  18144. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  18145. }
  18146. } // namespace impl
  18147. inline ctx_t create_client_context() {
  18148. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18149. if (!ctx) { return nullptr; }
  18150. ctx->is_server = false;
  18151. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18152. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18153. if (!detail::ensure_mbedtls_psa_crypto()) {
  18154. delete ctx;
  18155. return nullptr;
  18156. }
  18157. int ret;
  18158. #else
  18159. // Seed the random number generator
  18160. const char *pers = "httplib_client";
  18161. int ret = mbedtls_ctr_drbg_seed(
  18162. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18163. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18164. if (ret != 0) {
  18165. impl::mbedtls_last_error() = ret;
  18166. delete ctx;
  18167. return nullptr;
  18168. }
  18169. #endif
  18170. // Set up SSL config for client
  18171. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  18172. MBEDTLS_SSL_TRANSPORT_STREAM,
  18173. MBEDTLS_SSL_PRESET_DEFAULT);
  18174. if (ret != 0) {
  18175. impl::mbedtls_last_error() = ret;
  18176. delete ctx;
  18177. return nullptr;
  18178. }
  18179. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18180. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18181. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18182. #endif
  18183. // Default: verify peer certificate
  18184. ctx->verify_client = true;
  18185. impl::apply_verify_mode(*ctx);
  18186. // Set minimum TLS version to 1.2
  18187. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18188. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18189. #else
  18190. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18191. MBEDTLS_SSL_MINOR_VERSION_3);
  18192. #endif
  18193. return static_cast<ctx_t>(ctx);
  18194. }
  18195. inline ctx_t create_server_context() {
  18196. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18197. if (!ctx) { return nullptr; }
  18198. ctx->is_server = true;
  18199. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18200. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18201. if (!detail::ensure_mbedtls_psa_crypto()) {
  18202. delete ctx;
  18203. return nullptr;
  18204. }
  18205. int ret;
  18206. #else
  18207. // Seed the random number generator
  18208. const char *pers = "httplib_server";
  18209. int ret = mbedtls_ctr_drbg_seed(
  18210. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18211. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18212. if (ret != 0) {
  18213. impl::mbedtls_last_error() = ret;
  18214. delete ctx;
  18215. return nullptr;
  18216. }
  18217. #endif
  18218. // Set up SSL config for server
  18219. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18220. MBEDTLS_SSL_TRANSPORT_STREAM,
  18221. MBEDTLS_SSL_PRESET_DEFAULT);
  18222. if (ret != 0) {
  18223. impl::mbedtls_last_error() = ret;
  18224. delete ctx;
  18225. return nullptr;
  18226. }
  18227. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18228. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18229. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18230. #endif
  18231. // Default: don't verify client
  18232. impl::apply_verify_mode(*ctx);
  18233. // Set minimum TLS version to 1.2
  18234. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18235. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18236. #else
  18237. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18238. MBEDTLS_SSL_MINOR_VERSION_3);
  18239. #endif
  18240. // Set SNI callback to capture client's SNI hostname
  18241. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18242. return static_cast<ctx_t>(ctx);
  18243. }
  18244. inline void free_context(ctx_t ctx) {
  18245. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18246. }
  18247. inline bool set_min_version(ctx_t ctx, Version version) {
  18248. if (!ctx) { return false; }
  18249. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18250. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18251. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18252. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18253. if (version >= Version::TLS1_3) {
  18254. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18255. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18256. #endif
  18257. }
  18258. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18259. #else
  18260. // Mbed TLS 2.x uses major/minor version numbers
  18261. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18262. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18263. if (version >= Version::TLS1_3) {
  18264. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18265. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18266. #else
  18267. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18268. #endif
  18269. }
  18270. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18271. #endif
  18272. return true;
  18273. }
  18274. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18275. if (!ctx || !pem) { return false; }
  18276. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18277. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18278. // Add null terminator if not present
  18279. std::string pem_str(pem, len);
  18280. int ret = mbedtls_x509_crt_parse(
  18281. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18282. pem_str.size() + 1);
  18283. if (ret != 0) {
  18284. impl::mbedtls_last_error() = ret;
  18285. return false;
  18286. }
  18287. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18288. return true;
  18289. }
  18290. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18291. if (!ctx || !file_path) { return false; }
  18292. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18293. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18294. if (ret != 0) {
  18295. impl::mbedtls_last_error() = ret;
  18296. return false;
  18297. }
  18298. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18299. return true;
  18300. }
  18301. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18302. if (!ctx || !dir_path) { return false; }
  18303. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18304. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18305. if (ret < 0) { // Returns number of certs on success, negative on error
  18306. impl::mbedtls_last_error() = ret;
  18307. return false;
  18308. }
  18309. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18310. return true;
  18311. }
  18312. inline bool load_system_certs(ctx_t ctx) {
  18313. if (!ctx) { return false; }
  18314. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18315. bool loaded = false;
  18316. #ifdef _WIN32
  18317. loaded = impl::enumerate_windows_system_certs(
  18318. [&](const unsigned char *data, size_t len) {
  18319. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18320. });
  18321. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18322. loaded = impl::enumerate_macos_keychain_certs(
  18323. [&](const unsigned char *data, size_t len) {
  18324. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18325. });
  18326. #else
  18327. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18328. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18329. loaded = true;
  18330. break;
  18331. }
  18332. }
  18333. if (!loaded) {
  18334. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18335. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18336. loaded = true;
  18337. break;
  18338. }
  18339. }
  18340. }
  18341. #endif
  18342. if (loaded) {
  18343. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18344. }
  18345. return loaded;
  18346. }
  18347. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18348. const char *password) {
  18349. if (!ctx || !cert || !key) { return false; }
  18350. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18351. // Parse certificate
  18352. std::string cert_str(cert);
  18353. int ret = mbedtls_x509_crt_parse(
  18354. &mctx->own_cert,
  18355. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18356. cert_str.size() + 1);
  18357. if (ret != 0) {
  18358. impl::mbedtls_last_error() = ret;
  18359. return false;
  18360. }
  18361. // Parse private key
  18362. std::string key_str(key);
  18363. const unsigned char *pwd =
  18364. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18365. size_t pwd_len = password ? strlen(password) : 0;
  18366. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18367. ret = mbedtls_pk_parse_key(
  18368. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18369. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18370. &mctx->ctr_drbg);
  18371. #else
  18372. ret = mbedtls_pk_parse_key(
  18373. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18374. key_str.size() + 1, pwd, pwd_len);
  18375. #endif
  18376. if (ret != 0) {
  18377. impl::mbedtls_last_error() = ret;
  18378. return false;
  18379. }
  18380. // Verify that the certificate and private key match.
  18381. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18382. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18383. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18384. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18385. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18386. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18387. #else
  18388. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18389. #endif
  18390. if (ret != 0) {
  18391. impl::mbedtls_last_error() = ret;
  18392. return false;
  18393. }
  18394. #endif
  18395. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18396. if (ret != 0) {
  18397. impl::mbedtls_last_error() = ret;
  18398. return false;
  18399. }
  18400. return true;
  18401. }
  18402. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18403. const char *key_path, const char *password) {
  18404. if (!ctx || !cert_path || !key_path) { return false; }
  18405. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18406. // Parse certificate file
  18407. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18408. if (ret != 0) {
  18409. impl::mbedtls_last_error() = ret;
  18410. return false;
  18411. }
  18412. // Parse private key file
  18413. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18414. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18415. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18416. #else
  18417. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18418. #endif
  18419. if (ret != 0) {
  18420. impl::mbedtls_last_error() = ret;
  18421. return false;
  18422. }
  18423. // Verify that the certificate and private key match.
  18424. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18425. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18426. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18427. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18428. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18429. #else
  18430. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18431. #endif
  18432. if (ret != 0) {
  18433. impl::mbedtls_last_error() = ret;
  18434. return false;
  18435. }
  18436. #endif
  18437. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18438. if (ret != 0) {
  18439. impl::mbedtls_last_error() = ret;
  18440. return false;
  18441. }
  18442. return true;
  18443. }
  18444. inline void set_verify_client(ctx_t ctx, bool require) {
  18445. if (!ctx) { return; }
  18446. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18447. mctx->verify_client = require;
  18448. impl::apply_verify_mode(*mctx);
  18449. }
  18450. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18451. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18452. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18453. auto session = new (std::nothrow) impl::MbedTlsSession();
  18454. if (!session) { return nullptr; }
  18455. session->sock = sock;
  18456. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18457. if (ret != 0) {
  18458. impl::mbedtls_last_error() = ret;
  18459. delete session;
  18460. return nullptr;
  18461. }
  18462. // Explicitly opt out of in-handshake hostname verification by default;
  18463. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18464. // fails outright when no hostname was set. set_sni() installs the real
  18465. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18466. // caller verifies the certificate identity post-handshake via
  18467. // verify_hostname().
  18468. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18469. // Set BIO callbacks
  18470. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18471. impl::mbedtls_net_recv_cb, nullptr);
  18472. // Installed always, as it also masks the hostname mismatch that set_sni()
  18473. // may ask for. The session runs its own copy of the user's callback, which
  18474. // set_verify_callback() cannot replace under a handshake.
  18475. session->verify_callback = mctx->verify_callback;
  18476. session->is_server = mctx->is_server;
  18477. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18478. return static_cast<session_t>(session);
  18479. }
  18480. inline void free_session(session_t session) {
  18481. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18482. }
  18483. inline bool set_sni(session_t session, const char *hostname,
  18484. bool verify_hostname) {
  18485. if (!session || !hostname) { return false; }
  18486. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18487. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18488. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18489. // independently, so a disabled hostname check is handled below by masking
  18490. // the resulting mismatch flag instead of skipping this call.
  18491. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18492. if (ret != 0) {
  18493. impl::mbedtls_last_error() = ret;
  18494. return false;
  18495. }
  18496. msession->hostname = hostname;
  18497. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18498. return true;
  18499. }
  18500. inline TlsError connect(session_t session) {
  18501. TlsError err;
  18502. if (!session) {
  18503. err.code = ErrorCode::Fatal;
  18504. return err;
  18505. }
  18506. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18507. int ret;
  18508. do {
  18509. ret = mbedtls_ssl_handshake(&msession->ssl);
  18510. } while (impl::mbedtls_is_session_ticket(ret));
  18511. if (ret == 0) {
  18512. err.code = ErrorCode::Success;
  18513. } else {
  18514. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18515. impl::mbedtls_last_error() = ret;
  18516. }
  18517. return err;
  18518. }
  18519. inline TlsError accept(session_t session) {
  18520. // A failed handshake leaves its SNI behind, so start without it
  18521. impl::mbedpending_sni().clear();
  18522. // Same as connect for Mbed TLS - handshake works for both client and server
  18523. auto result = connect(session);
  18524. // After successful handshake, capture SNI from thread-local storage
  18525. if (result.code == ErrorCode::Success && session) {
  18526. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18527. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18528. }
  18529. return result;
  18530. }
  18531. inline bool connect_nonblocking(session_t session, socket_t sock,
  18532. time_t timeout_sec, time_t timeout_usec,
  18533. TlsError *err) {
  18534. if (!session) {
  18535. if (err) { err->code = ErrorCode::Fatal; }
  18536. return false;
  18537. }
  18538. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18539. // Set socket to non-blocking mode
  18540. detail::set_nonblocking(sock, true);
  18541. auto cleanup =
  18542. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18543. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18544. int ret;
  18545. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18546. // Non-fatal TLS 1.3 ticket; retry immediately.
  18547. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18548. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18549. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18550. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18551. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18552. }
  18553. // TlsError or timeout
  18554. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18555. impl::mbedtls_last_error() = ret;
  18556. return false;
  18557. }
  18558. if (err) { err->code = ErrorCode::Success; }
  18559. return true;
  18560. }
  18561. inline bool accept_nonblocking(session_t session, socket_t sock,
  18562. time_t timeout_sec, time_t timeout_usec,
  18563. TlsError *err) {
  18564. // A failed handshake leaves its SNI behind, so start without it
  18565. impl::mbedpending_sni().clear();
  18566. // Same implementation as connect for Mbed TLS
  18567. bool result =
  18568. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18569. // After successful handshake, capture SNI from thread-local storage
  18570. if (result && session) {
  18571. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18572. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18573. }
  18574. return result;
  18575. }
  18576. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18577. if (!session || !buf) {
  18578. err.code = ErrorCode::Fatal;
  18579. return -1;
  18580. }
  18581. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18582. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18583. if (msession->has_peeked_byte) {
  18584. if (len == 0) { return 0; }
  18585. auto p = static_cast<unsigned char *>(buf);
  18586. p[0] = msession->peeked_byte;
  18587. msession->has_peeked_byte = false;
  18588. size_t n = 1;
  18589. // Top up with any already-decrypted bytes without risking a block.
  18590. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18591. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18592. if (extra > 0) { n += static_cast<size_t>(extra); }
  18593. }
  18594. err.code = ErrorCode::Success;
  18595. return static_cast<ssize_t>(n);
  18596. }
  18597. int ret;
  18598. do {
  18599. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18600. len);
  18601. } while (impl::mbedtls_is_session_ticket(ret));
  18602. if (ret > 0) {
  18603. err.code = ErrorCode::Success;
  18604. return static_cast<ssize_t>(ret);
  18605. }
  18606. if (ret == 0) {
  18607. err.code = ErrorCode::PeerClosed;
  18608. return 0;
  18609. }
  18610. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18611. err.backend_code = static_cast<uint64_t>(-ret);
  18612. impl::mbedtls_last_error() = ret;
  18613. // mbedTLS signals a clean close_notify via a negative error code rather
  18614. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18615. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18616. return -1;
  18617. }
  18618. inline ssize_t write(session_t session, const void *buf, size_t len,
  18619. TlsError &err) {
  18620. if (!session || !buf) {
  18621. err.code = ErrorCode::Fatal;
  18622. return -1;
  18623. }
  18624. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18625. int ret;
  18626. do {
  18627. ret = mbedtls_ssl_write(&msession->ssl,
  18628. static_cast<const unsigned char *>(buf), len);
  18629. } while (impl::mbedtls_is_session_ticket(ret));
  18630. if (ret > 0) {
  18631. err.code = ErrorCode::Success;
  18632. return static_cast<ssize_t>(ret);
  18633. }
  18634. if (ret == 0) {
  18635. err.code = ErrorCode::PeerClosed;
  18636. return 0;
  18637. }
  18638. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18639. err.backend_code = static_cast<uint64_t>(-ret);
  18640. impl::mbedtls_last_error() = ret;
  18641. return -1;
  18642. }
  18643. inline int pending(const_session_t session) {
  18644. if (!session) { return 0; }
  18645. auto msession =
  18646. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18647. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18648. (msession->has_peeked_byte ? 1 : 0);
  18649. }
  18650. inline void shutdown(session_t session, bool graceful) {
  18651. if (!session) { return; }
  18652. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18653. if (graceful) {
  18654. // Try to send close_notify, but don't block forever
  18655. int ret;
  18656. int attempts = 0;
  18657. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18658. attempts < 3) {
  18659. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18660. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18661. break;
  18662. }
  18663. attempts++;
  18664. }
  18665. }
  18666. }
  18667. inline bool is_peer_closed(session_t session, socket_t sock) {
  18668. if (!session || sock == INVALID_SOCKET) { return true; }
  18669. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18670. // Check if there's already decrypted or pushed-back data available.
  18671. // If so, the connection is definitely alive.
  18672. if (msession->has_peeked_byte ||
  18673. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18674. return false;
  18675. }
  18676. // Set socket to non-blocking to avoid blocking on read
  18677. detail::set_nonblocking(sock, true);
  18678. auto cleanup =
  18679. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18680. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18681. // on application data — e.g. a response that already arrived — push the
  18682. // byte back so the next read() delivers it instead of losing it.
  18683. unsigned char buf;
  18684. int ret;
  18685. do {
  18686. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18687. } while (impl::mbedtls_is_session_ticket(ret));
  18688. // If we got data or WANT_READ (would block), connection is alive
  18689. if (ret > 0) {
  18690. msession->peeked_byte = buf;
  18691. msession->has_peeked_byte = true;
  18692. return false;
  18693. }
  18694. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18695. // If we get a peer close notify or a connection reset, the peer is closed
  18696. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18697. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18698. }
  18699. inline cert_t get_peer_cert(const_session_t session) {
  18700. if (!session) { return nullptr; }
  18701. auto msession =
  18702. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18703. // Mbed TLS returns a pointer to the internal peer cert chain.
  18704. // WARNING: This pointer is only valid while the session is active.
  18705. // Do not use the certificate after calling free_session().
  18706. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18707. return const_cast<mbedtls_x509_crt *>(cert);
  18708. }
  18709. inline size_t get_peer_certs(const_session_t session,
  18710. std::vector<cert_t> &certs) {
  18711. certs.clear();
  18712. // Mbed TLS parses the whole received chain into a list headed by the peer
  18713. // certificate, owned by the session like get_peer_cert()'s result
  18714. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18715. crt && crt->raw.len > 0; crt = crt->next) {
  18716. certs.push_back(static_cast<cert_t>(crt));
  18717. }
  18718. return certs.size();
  18719. }
  18720. inline void free_cert(cert_t cert) {
  18721. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18722. // chain, so there is nothing to free. Callers still call this for the other
  18723. // backends.
  18724. (void)cert;
  18725. }
  18726. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18727. if (!cert || !hostname) { return false; }
  18728. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18729. std::string host_str(hostname);
  18730. // Check if hostname is an IP address (IPv4 or IPv6)
  18731. unsigned char ip_bytes[16];
  18732. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18733. auto is_ip = ip_len > 0;
  18734. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18735. // in buf.tag and the raw value in buf.p / buf.len.
  18736. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  18737. if (!san->buf.p || san->buf.len == 0) { continue; }
  18738. const unsigned char *p = san->buf.p;
  18739. size_t len = san->buf.len;
  18740. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18741. if (is_ip) {
  18742. // For an IP host, only a matching iPAddress SAN of the same family
  18743. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18744. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18745. memcmp(p, ip_bytes, ip_len) == 0) {
  18746. return true;
  18747. }
  18748. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18749. std::string san_name(reinterpret_cast<const char *>(p), len);
  18750. if (detail::match_hostname(san_name, host_str)) { return true; }
  18751. }
  18752. }
  18753. return false;
  18754. }
  18755. inline uint64_t hostname_mismatch_code() {
  18756. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18757. }
  18758. inline long get_verify_result(const_session_t session) {
  18759. if (!session) { return -1; }
  18760. auto msession =
  18761. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18762. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18763. // Return 0 (X509_V_OK equivalent) if verification passed
  18764. return flags == 0 ? 0 : static_cast<long>(flags);
  18765. }
  18766. inline std::string get_cert_subject_cn(cert_t cert) {
  18767. if (!cert) return "";
  18768. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18769. // Find the CN in the subject
  18770. const mbedtls_x509_name *name = &x509->subject;
  18771. while (name != nullptr) {
  18772. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18773. return std::string(reinterpret_cast<const char *>(name->val.p),
  18774. name->val.len);
  18775. }
  18776. name = name->next;
  18777. }
  18778. return "";
  18779. }
  18780. inline std::string get_cert_issuer_name(cert_t cert) {
  18781. if (!cert) return "";
  18782. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18783. // Build a human-readable issuer name string
  18784. char buf[512];
  18785. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18786. if (ret < 0) return "";
  18787. return std::string(buf);
  18788. }
  18789. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18790. sans.clear();
  18791. if (!cert) return false;
  18792. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18793. // Parse the Subject Alternative Name extension
  18794. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18795. while (cur != nullptr) {
  18796. if (cur->buf.len > 0) {
  18797. const unsigned char *p = cur->buf.p;
  18798. size_t value_len = cur->buf.len;
  18799. SanEntry entry;
  18800. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18801. case MBEDTLS_X509_SAN_DNS_NAME:
  18802. entry.type = SanType::DNS;
  18803. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18804. break;
  18805. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18806. entry.type = SanType::IP;
  18807. if (value_len == 4) {
  18808. // IPv4
  18809. char buf[16];
  18810. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18811. entry.value = buf;
  18812. } else if (value_len == 16) {
  18813. // IPv6
  18814. char buf[64];
  18815. snprintf(buf, sizeof(buf),
  18816. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18817. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18818. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18819. p[10], p[11], p[12], p[13], p[14], p[15]);
  18820. entry.value = buf;
  18821. }
  18822. break;
  18823. case MBEDTLS_X509_SAN_RFC822_NAME:
  18824. entry.type = SanType::EMAIL;
  18825. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18826. break;
  18827. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18828. entry.type = SanType::URI;
  18829. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18830. break;
  18831. default: entry.type = SanType::OTHER; break;
  18832. }
  18833. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18834. }
  18835. cur = cur->next;
  18836. }
  18837. return true;
  18838. }
  18839. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18840. time_t &not_after) {
  18841. if (!cert) return false;
  18842. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18843. // Convert mbedtls_x509_time to time_t
  18844. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18845. struct tm tm_time = {};
  18846. tm_time.tm_year = t.year - 1900;
  18847. tm_time.tm_mon = t.mon - 1;
  18848. tm_time.tm_mday = t.day;
  18849. tm_time.tm_hour = t.hour;
  18850. tm_time.tm_min = t.min;
  18851. tm_time.tm_sec = t.sec;
  18852. #ifdef _WIN32
  18853. return _mkgmtime(&tm_time);
  18854. #else
  18855. return timegm(&tm_time);
  18856. #endif
  18857. };
  18858. not_before = to_time_t(x509->valid_from);
  18859. not_after = to_time_t(x509->valid_to);
  18860. return true;
  18861. }
  18862. inline std::string get_cert_serial(cert_t cert) {
  18863. if (!cert) return "";
  18864. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18865. // Convert serial number to hex string
  18866. std::string result;
  18867. result.reserve(x509->serial.len * 2);
  18868. for (size_t i = 0; i < x509->serial.len; i++) {
  18869. char hex[3];
  18870. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18871. result += hex;
  18872. }
  18873. return result;
  18874. }
  18875. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18876. if (!cert) return false;
  18877. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18878. if (!crt->raw.p || crt->raw.len == 0) return false;
  18879. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18880. return true;
  18881. }
  18882. inline const char *get_sni(const_session_t session) {
  18883. if (!session) return nullptr;
  18884. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18885. // For server: return SNI received from client during handshake
  18886. if (!msession->sni_hostname.empty()) {
  18887. return msession->sni_hostname.c_str();
  18888. }
  18889. // For client: return the hostname set via set_sni
  18890. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18891. return nullptr;
  18892. }
  18893. inline uint64_t peek_error() {
  18894. // Mbed TLS doesn't have an error queue, return the last error
  18895. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18896. }
  18897. inline uint64_t get_error() {
  18898. // Mbed TLS doesn't have an error queue, return and clear the last error
  18899. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18900. impl::mbedtls_last_error() = 0;
  18901. return err;
  18902. }
  18903. inline std::string error_string(uint64_t code) {
  18904. char buf[256];
  18905. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18906. return std::string(buf);
  18907. }
  18908. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18909. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18910. // Parsing certificates needs PSA Crypto, and no context may exist yet
  18911. if (!detail::ensure_mbedtls_psa_crypto()) { return nullptr; }
  18912. #endif
  18913. if (!pem) { return nullptr; }
  18914. // mbedtls_x509_crt_parse expects null-terminated PEM
  18915. std::string pem_str(pem, len);
  18916. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18917. if (!ca_chain) { return nullptr; }
  18918. mbedtls_x509_crt_init(ca_chain);
  18919. auto ret = mbedtls_x509_crt_parse(
  18920. ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18921. pem_str.size() + 1);
  18922. if (ret != 0) {
  18923. mbedtls_x509_crt_free(ca_chain);
  18924. delete ca_chain;
  18925. return nullptr;
  18926. }
  18927. return static_cast<ca_store_t>(ca_chain);
  18928. }
  18929. inline void free_ca_store(ca_store_t store) {
  18930. if (store) {
  18931. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18932. mbedtls_x509_crt_free(ca_chain);
  18933. delete ca_chain;
  18934. }
  18935. }
  18936. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18937. if (!ctx || !store) { return false; }
  18938. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18939. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18940. // Free existing CA chain
  18941. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18942. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18943. // Copy the CA chain (deep copy)
  18944. // Parse from the raw data of the source cert
  18945. mbedtls_x509_crt *src = ca_chain;
  18946. while (src != nullptr) {
  18947. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18948. src->raw.len);
  18949. if (ret != 0) {
  18950. free_ca_store(store);
  18951. return false;
  18952. }
  18953. src = src->next;
  18954. }
  18955. // This function takes ownership of the store; the chain was deep-copied
  18956. // above, so release the source
  18957. free_ca_store(store);
  18958. // Update the SSL config to use the new CA chain
  18959. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18960. return true;
  18961. }
  18962. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18963. certs.clear();
  18964. if (!ctx) { return 0; }
  18965. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18966. // Owned by the context; see free_cert()
  18967. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  18968. cert = cert->next) {
  18969. certs.push_back(static_cast<cert_t>(cert));
  18970. }
  18971. return certs.size();
  18972. }
  18973. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18974. std::vector<std::string> names;
  18975. if (!ctx) { return names; }
  18976. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18977. // Iterate through the CA chain
  18978. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18979. while (cert != nullptr && cert->raw.len > 0) {
  18980. char buf[512];
  18981. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18982. if (ret > 0) { names.push_back(buf); }
  18983. cert = cert->next;
  18984. }
  18985. return names;
  18986. }
  18987. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18988. const char *key_pem, const char *password) {
  18989. if (!ctx || !cert_pem || !key_pem) { return false; }
  18990. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18991. // Parse into new objects first, so that a bad pair leaves the old one in
  18992. // place, and swap them in after; the old ones are freed on the way out.
  18993. mbedtls_x509_crt cert;
  18994. mbedtls_pk_context key;
  18995. mbedtls_x509_crt_init(&cert);
  18996. mbedtls_pk_init(&key);
  18997. auto se = detail::scope_exit([&] {
  18998. mbedtls_x509_crt_free(&cert);
  18999. mbedtls_pk_free(&key);
  19000. });
  19001. // Parse certificate PEM
  19002. int ret = mbedtls_x509_crt_parse(
  19003. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  19004. strlen(cert_pem) + 1);
  19005. if (ret != 0) {
  19006. impl::mbedtls_last_error() = ret;
  19007. return false;
  19008. }
  19009. // Parse private key PEM
  19010. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19011. ret = mbedtls_pk_parse_key(
  19012. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19013. strlen(key_pem) + 1,
  19014. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19015. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  19016. &mbed_ctx->ctr_drbg);
  19017. #else
  19018. ret = mbedtls_pk_parse_key(
  19019. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19020. strlen(key_pem) + 1,
  19021. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19022. password ? strlen(password) : 0);
  19023. #endif
  19024. if (ret != 0) {
  19025. impl::mbedtls_last_error() = ret;
  19026. return false;
  19027. }
  19028. std::swap(mbed_ctx->own_cert, cert);
  19029. std::swap(mbed_ctx->own_key, key);
  19030. // Configure SSL to use the new certificate and key
  19031. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  19032. &mbed_ctx->own_key);
  19033. if (ret != 0) {
  19034. impl::mbedtls_last_error() = ret;
  19035. return false;
  19036. }
  19037. return true;
  19038. }
  19039. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19040. if (!ctx || !ca_pem) { return false; }
  19041. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19042. // Parse into a new chain first, so that a bad one leaves the old in place
  19043. mbedtls_x509_crt chain;
  19044. mbedtls_x509_crt_init(&chain);
  19045. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  19046. // Parse CA PEM
  19047. int ret = mbedtls_x509_crt_parse(
  19048. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  19049. strlen(ca_pem) + 1);
  19050. if (ret != 0) {
  19051. impl::mbedtls_last_error() = ret;
  19052. return false;
  19053. }
  19054. std::swap(mbed_ctx->ca_chain, chain);
  19055. // Update SSL config to use new CA chain
  19056. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19057. return true;
  19058. }
  19059. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19060. if (!ctx) { return false; }
  19061. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19062. // create_session() hands each session its own copy to run.
  19063. mbed_ctx->verify_callback = std::move(callback);
  19064. impl::apply_verify_mode(*mbed_ctx);
  19065. return true;
  19066. }
  19067. inline long get_verify_error(const_session_t session) {
  19068. if (!session) { return -1; }
  19069. auto *msession =
  19070. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19071. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  19072. }
  19073. inline std::string verify_error_string(long error_code) {
  19074. if (error_code == 0) { return ""; }
  19075. char buf[256];
  19076. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  19077. static_cast<uint32_t>(error_code));
  19078. // Remove trailing newline if present
  19079. std::string result(buf);
  19080. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  19081. result.pop_back();
  19082. }
  19083. return result;
  19084. }
  19085. } // namespace tls
  19086. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  19087. /*
  19088. * Group 10: TLS abstraction layer - wolfSSL backend
  19089. */
  19090. /*
  19091. * wolfSSL Backend Implementation
  19092. */
  19093. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  19094. namespace tls {
  19095. namespace impl {
  19096. // wolfSSL session wrapper
  19097. struct WolfSSLSession {
  19098. WOLFSSL *ssl = nullptr;
  19099. socket_t sock = INVALID_SOCKET;
  19100. std::string hostname; // For client: set via set_sni
  19101. std::string sni_hostname; // For server: received from client via SNI callback
  19102. WolfSSLSession() = default;
  19103. ~WolfSSLSession() {
  19104. if (ssl) { wolfSSL_free(ssl); }
  19105. }
  19106. WolfSSLSession(const WolfSSLSession &) = delete;
  19107. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  19108. };
  19109. // Thread-local error code accessor for wolfSSL
  19110. inline uint64_t &wolfssl_last_error() {
  19111. static thread_local uint64_t err = 0;
  19112. return err;
  19113. }
  19114. // Helper to map wolfSSL error to ErrorCode.
  19115. // ssl_error is the value from wolfSSL_get_error().
  19116. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  19117. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  19118. int &out_errno) {
  19119. switch (ssl_error) {
  19120. case SSL_ERROR_NONE: return ErrorCode::Success;
  19121. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  19122. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  19123. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  19124. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  19125. default:
  19126. if (ssl) {
  19127. // wolfSSL stores the low-level error code as a negative value.
  19128. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  19129. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  19130. if (low_err == DOMAIN_NAME_MISMATCH) {
  19131. return ErrorCode::HostnameMismatch;
  19132. }
  19133. // Check verify result to distinguish cert verification from generic SSL
  19134. // errors.
  19135. long vr = wolfSSL_get_verify_result(ssl);
  19136. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  19137. }
  19138. return ErrorCode::Fatal;
  19139. }
  19140. }
  19141. // WolfSSLContext constructor/destructor implementations
  19142. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  19143. inline WolfSSLContext::~WolfSSLContext() {
  19144. if (ctx) { wolfSSL_CTX_free(ctx); }
  19145. }
  19146. // Thread-local storage for SNI captured during handshake
  19147. inline std::string &wolfssl_pending_sni() {
  19148. static thread_local std::string sni;
  19149. return sni;
  19150. }
  19151. // SNI callback for wolfSSL server to capture client's SNI hostname
  19152. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  19153. (void)ret;
  19154. (void)exArg;
  19155. void *name_data = nullptr;
  19156. unsigned short name_len =
  19157. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  19158. if (name_data && name_len > 0) {
  19159. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  19160. name_len);
  19161. } else {
  19162. wolfssl_pending_sni().clear();
  19163. }
  19164. return 0; // Continue regardless
  19165. }
  19166. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  19167. // runs the verify callback of its own context.
  19168. inline int context_ex_data_index() {
  19169. static const auto index =
  19170. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19171. return index;
  19172. }
  19173. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  19174. // other tls:: function takes.
  19175. inline int session_ex_data_index() {
  19176. static const auto index =
  19177. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19178. return index;
  19179. }
  19180. // A resumed session skips the client's certificate, so a server that checks
  19181. // one would let in a certificate checked against another server's CA, as
  19182. // wolfSSL shares its session cache between contexts, or against a CA since
  19183. // replaced by update_server_client_ca().
  19184. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19185. if (!wctx->is_server) { return; }
  19186. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19187. #ifdef HAVE_SESSION_TICKET
  19188. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19189. #endif
  19190. }
  19191. // wolfSSL verify callback wrapper
  19192. inline int wolfssl_verify_callback(int preverify_ok,
  19193. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19194. // Get the WOLFSSL object from the X509_STORE_CTX
  19195. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19196. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19197. if (!ssl) { return preverify_ok; }
  19198. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19199. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19200. if (!wctx) { return preverify_ok; }
  19201. std::shared_ptr<VerifyCallback> callback;
  19202. {
  19203. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19204. callback = wctx->verify_callback;
  19205. }
  19206. if (!callback) { return preverify_ok; }
  19207. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19208. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19209. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19210. VerifyContext verify_ctx;
  19211. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19212. verify_ctx.cert = static_cast<cert_t>(cert);
  19213. verify_ctx.depth = depth;
  19214. verify_ctx.preverify_ok = (preverify_ok != 0);
  19215. verify_ctx.error_code = static_cast<long>(err);
  19216. if (err != 0) {
  19217. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19218. } else {
  19219. verify_ctx.error_string = nullptr;
  19220. }
  19221. auto accepted = run_verify_callback(*callback, verify_ctx);
  19222. // A client verifying the server during the handshake, which is what
  19223. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  19224. if (!wolfSSL_is_server(ssl) &&
  19225. (wolfSSL_get_verify_mode(ssl) & WOLFSSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  19226. accepted = accepted && preverify_ok;
  19227. }
  19228. return accepted ? 1 : 0;
  19229. }
  19230. // Sets the verify mode from whether the peer's certificate is required and
  19231. // whether a verify callback is set.
  19232. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19233. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19234. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19235. auto mode = wctx.verify_client
  19236. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19237. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19238. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19239. has_callback ? wolfssl_verify_callback : nullptr);
  19240. }
  19241. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19242. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19243. wolfSSL_CTX_set_default_passwd_cb(
  19244. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19245. auto *pwd = static_cast<const char *>(userdata);
  19246. if (!pwd) return 0;
  19247. auto len = static_cast<int>(strlen(pwd));
  19248. if (len > size) len = size;
  19249. memcpy(buf, pwd, static_cast<size_t>(len));
  19250. return len;
  19251. });
  19252. }
  19253. } // namespace impl
  19254. inline ctx_t create_client_context() {
  19255. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19256. if (!ctx) { return nullptr; }
  19257. ctx->is_server = false;
  19258. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19259. if (!method) {
  19260. delete ctx;
  19261. return nullptr;
  19262. }
  19263. ctx->ctx = wolfSSL_CTX_new(method);
  19264. if (!ctx->ctx ||
  19265. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19266. WOLFSSL_SUCCESS) {
  19267. delete ctx;
  19268. return nullptr;
  19269. }
  19270. // Default: verify peer certificate
  19271. ctx->verify_client = true;
  19272. impl::apply_verify_mode(*ctx);
  19273. return static_cast<ctx_t>(ctx);
  19274. }
  19275. inline ctx_t create_server_context() {
  19276. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19277. if (!ctx) { return nullptr; }
  19278. ctx->is_server = true;
  19279. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19280. if (!method) {
  19281. delete ctx;
  19282. return nullptr;
  19283. }
  19284. ctx->ctx = wolfSSL_CTX_new(method);
  19285. if (!ctx->ctx ||
  19286. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19287. WOLFSSL_SUCCESS) {
  19288. delete ctx;
  19289. return nullptr;
  19290. }
  19291. // Default: don't verify client
  19292. impl::apply_verify_mode(*ctx);
  19293. // Enable SNI on server
  19294. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19295. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19296. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19297. return static_cast<ctx_t>(ctx);
  19298. }
  19299. inline void free_context(ctx_t ctx) {
  19300. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19301. }
  19302. inline bool set_min_version(ctx_t ctx, Version version) {
  19303. if (!ctx) { return false; }
  19304. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19305. int min_ver = WOLFSSL_TLSV1_2;
  19306. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19307. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19308. }
  19309. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19310. if (!ctx || !pem) { return false; }
  19311. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19312. int ret = wolfSSL_CTX_load_verify_buffer(
  19313. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19314. static_cast<long>(len), SSL_FILETYPE_PEM);
  19315. if (ret != SSL_SUCCESS) {
  19316. impl::wolfssl_last_error() =
  19317. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19318. return false;
  19319. }
  19320. wctx->ca_pem_data_.append(pem, len);
  19321. return true;
  19322. }
  19323. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19324. if (!ctx || !file_path) { return false; }
  19325. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19326. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19327. if (ret != SSL_SUCCESS) {
  19328. impl::wolfssl_last_error() =
  19329. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19330. return false;
  19331. }
  19332. return true;
  19333. }
  19334. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19335. if (!ctx || !dir_path) { return false; }
  19336. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19337. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19338. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19339. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19340. // immediately. Return true even on failure since the CA file may have
  19341. // already been loaded, matching OpenSSL's lenient behavior.
  19342. (void)ret;
  19343. return true;
  19344. }
  19345. inline bool load_system_certs(ctx_t ctx) {
  19346. if (!ctx) { return false; }
  19347. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19348. bool loaded = false;
  19349. #ifdef _WIN32
  19350. loaded = impl::enumerate_windows_system_certs(
  19351. [&](const unsigned char *data, size_t len) {
  19352. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19353. static_cast<long>(len),
  19354. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19355. });
  19356. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19357. loaded = impl::enumerate_macos_keychain_certs(
  19358. [&](const unsigned char *data, size_t len) {
  19359. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19360. static_cast<long>(len),
  19361. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19362. });
  19363. #else
  19364. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19365. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19366. SSL_SUCCESS) {
  19367. loaded = true;
  19368. break;
  19369. }
  19370. }
  19371. if (!loaded) {
  19372. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19373. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19374. SSL_SUCCESS) {
  19375. loaded = true;
  19376. break;
  19377. }
  19378. }
  19379. }
  19380. #endif
  19381. return loaded;
  19382. }
  19383. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19384. const char *password) {
  19385. if (!ctx || !cert || !key) { return false; }
  19386. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19387. // Load certificate
  19388. int ret = wolfSSL_CTX_use_certificate_buffer(
  19389. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19390. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19391. if (ret != SSL_SUCCESS) {
  19392. impl::wolfssl_last_error() =
  19393. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19394. return false;
  19395. }
  19396. // Set password callback if password is provided
  19397. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19398. // Load private key
  19399. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19400. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19401. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19402. if (ret != SSL_SUCCESS) {
  19403. impl::wolfssl_last_error() =
  19404. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19405. return false;
  19406. }
  19407. // Verify that the certificate and private key match
  19408. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19409. }
  19410. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19411. const char *key_path, const char *password) {
  19412. if (!ctx || !cert_path || !key_path) { return false; }
  19413. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19414. // Load certificate file
  19415. int ret =
  19416. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19417. if (ret != SSL_SUCCESS) {
  19418. impl::wolfssl_last_error() =
  19419. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19420. return false;
  19421. }
  19422. // Set password callback if password is provided
  19423. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19424. // Load private key file
  19425. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19426. if (ret != SSL_SUCCESS) {
  19427. impl::wolfssl_last_error() =
  19428. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19429. return false;
  19430. }
  19431. // Verify that the certificate and private key match
  19432. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19433. }
  19434. inline void set_verify_client(ctx_t ctx, bool require) {
  19435. if (!ctx) { return; }
  19436. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19437. wctx->verify_client = require;
  19438. impl::apply_verify_mode(*wctx);
  19439. }
  19440. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19441. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19442. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19443. auto session = new (std::nothrow) impl::WolfSSLSession();
  19444. if (!session) { return nullptr; }
  19445. session->sock = sock;
  19446. session->ssl = wolfSSL_new(wctx->ctx);
  19447. if (!session->ssl) {
  19448. impl::wolfssl_last_error() =
  19449. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19450. delete session;
  19451. return nullptr;
  19452. }
  19453. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19454. session) != WOLFSSL_SUCCESS) {
  19455. delete session;
  19456. return nullptr;
  19457. }
  19458. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19459. return static_cast<session_t>(session);
  19460. }
  19461. inline void free_session(session_t session) {
  19462. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19463. }
  19464. inline bool set_sni(session_t session, const char *hostname,
  19465. bool verify_hostname) {
  19466. if (!session || !hostname) { return false; }
  19467. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19468. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19469. static_cast<word16>(strlen(hostname)));
  19470. if (ret != WOLFSSL_SUCCESS) {
  19471. impl::wolfssl_last_error() =
  19472. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19473. return false;
  19474. }
  19475. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19476. // separately from the SNI extension sent above; skip it when hostname
  19477. // verification is disabled so only the chain is checked, matching OpenSSL.
  19478. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19479. wsession->hostname = hostname;
  19480. return true;
  19481. }
  19482. inline TlsError connect(session_t session) {
  19483. TlsError err;
  19484. if (!session) {
  19485. err.code = ErrorCode::Fatal;
  19486. return err;
  19487. }
  19488. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19489. int ret = wolfSSL_connect(wsession->ssl);
  19490. if (ret == SSL_SUCCESS) {
  19491. err.code = ErrorCode::Success;
  19492. } else {
  19493. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19494. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19495. err.backend_code = static_cast<uint64_t>(ssl_error);
  19496. impl::wolfssl_last_error() = err.backend_code;
  19497. }
  19498. return err;
  19499. }
  19500. inline TlsError accept(session_t session) {
  19501. TlsError err;
  19502. if (!session) {
  19503. err.code = ErrorCode::Fatal;
  19504. return err;
  19505. }
  19506. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19507. int ret = wolfSSL_accept(wsession->ssl);
  19508. if (ret == SSL_SUCCESS) {
  19509. err.code = ErrorCode::Success;
  19510. // Capture SNI from thread-local storage after successful handshake
  19511. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19512. impl::wolfssl_pending_sni().clear();
  19513. } else {
  19514. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19515. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19516. err.backend_code = static_cast<uint64_t>(ssl_error);
  19517. impl::wolfssl_last_error() = err.backend_code;
  19518. }
  19519. return err;
  19520. }
  19521. inline bool connect_nonblocking(session_t session, socket_t sock,
  19522. time_t timeout_sec, time_t timeout_usec,
  19523. TlsError *err) {
  19524. if (!session) {
  19525. if (err) { err->code = ErrorCode::Fatal; }
  19526. return false;
  19527. }
  19528. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19529. // Set socket to non-blocking mode
  19530. detail::set_nonblocking(sock, true);
  19531. auto cleanup =
  19532. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19533. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19534. int ret;
  19535. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19536. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19537. if (ssl_error == SSL_ERROR_WANT_READ) {
  19538. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19539. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19540. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19541. }
  19542. // Error or timeout
  19543. if (err) {
  19544. err->code =
  19545. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19546. err->backend_code = static_cast<uint64_t>(ssl_error);
  19547. }
  19548. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19549. return false;
  19550. }
  19551. if (err) { err->code = ErrorCode::Success; }
  19552. return true;
  19553. }
  19554. inline bool accept_nonblocking(session_t session, socket_t sock,
  19555. time_t timeout_sec, time_t timeout_usec,
  19556. TlsError *err) {
  19557. if (!session) {
  19558. if (err) { err->code = ErrorCode::Fatal; }
  19559. return false;
  19560. }
  19561. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19562. // Set socket to non-blocking mode
  19563. detail::set_nonblocking(sock, true);
  19564. auto cleanup =
  19565. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19566. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19567. int ret;
  19568. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19569. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19570. if (ssl_error == SSL_ERROR_WANT_READ) {
  19571. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19572. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19573. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19574. }
  19575. // Error or timeout
  19576. if (err) {
  19577. err->code =
  19578. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19579. err->backend_code = static_cast<uint64_t>(ssl_error);
  19580. }
  19581. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19582. return false;
  19583. }
  19584. if (err) { err->code = ErrorCode::Success; }
  19585. // Capture SNI from thread-local storage after successful handshake
  19586. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19587. impl::wolfssl_pending_sni().clear();
  19588. return true;
  19589. }
  19590. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19591. if (!session || !buf) {
  19592. err.code = ErrorCode::Fatal;
  19593. return -1;
  19594. }
  19595. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19596. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19597. if (ret > 0) {
  19598. err.code = ErrorCode::Success;
  19599. return static_cast<ssize_t>(ret);
  19600. }
  19601. if (ret == 0) {
  19602. err.code = ErrorCode::PeerClosed;
  19603. return 0;
  19604. }
  19605. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19606. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19607. err.backend_code = static_cast<uint64_t>(ssl_error);
  19608. impl::wolfssl_last_error() = err.backend_code;
  19609. return -1;
  19610. }
  19611. inline ssize_t write(session_t session, const void *buf, size_t len,
  19612. TlsError &err) {
  19613. if (!session || !buf) {
  19614. err.code = ErrorCode::Fatal;
  19615. return -1;
  19616. }
  19617. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19618. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19619. if (ret > 0) {
  19620. err.code = ErrorCode::Success;
  19621. return static_cast<ssize_t>(ret);
  19622. }
  19623. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19624. // Treat this as an error (return -1) so callers don't spin in a
  19625. // write loop adding zero to the offset.
  19626. if (ret == 0) {
  19627. err.code = ErrorCode::PeerClosed;
  19628. return -1;
  19629. }
  19630. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19631. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19632. err.backend_code = static_cast<uint64_t>(ssl_error);
  19633. impl::wolfssl_last_error() = err.backend_code;
  19634. return -1;
  19635. }
  19636. inline int pending(const_session_t session) {
  19637. if (!session) { return 0; }
  19638. auto wsession =
  19639. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19640. return wolfSSL_pending(wsession->ssl);
  19641. }
  19642. inline void shutdown(session_t session, bool graceful) {
  19643. if (!session) { return; }
  19644. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19645. if (graceful) {
  19646. int ret;
  19647. int attempts = 0;
  19648. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19649. attempts < 3) {
  19650. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19651. if (ssl_error != SSL_ERROR_WANT_READ &&
  19652. ssl_error != SSL_ERROR_WANT_WRITE) {
  19653. break;
  19654. }
  19655. attempts++;
  19656. }
  19657. } else {
  19658. wolfSSL_shutdown(wsession->ssl);
  19659. }
  19660. }
  19661. inline bool is_peer_closed(session_t session, socket_t sock) {
  19662. if (!session || sock == INVALID_SOCKET) { return true; }
  19663. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19664. // Check if there's already decrypted data available
  19665. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19666. // Set socket to non-blocking to avoid blocking on read
  19667. detail::set_nonblocking(sock, true);
  19668. auto cleanup =
  19669. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19670. // Peek 1 byte to check connection status without consuming data
  19671. unsigned char buf;
  19672. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19673. // If we got data or WANT_READ (would block), connection is alive
  19674. if (ret > 0) { return false; }
  19675. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19676. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19677. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19678. ret == 0;
  19679. }
  19680. inline cert_t get_peer_cert(const_session_t session) {
  19681. if (!session) { return nullptr; }
  19682. auto wsession =
  19683. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19684. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19685. return static_cast<cert_t>(cert);
  19686. }
  19687. inline size_t get_peer_certs(const_session_t session,
  19688. std::vector<cert_t> &certs) {
  19689. certs.clear();
  19690. if (!session) { return 0; }
  19691. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19692. #ifdef SESSION_CERTS
  19693. auto wsession =
  19694. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19695. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19696. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19697. for (int i = 0; i < count; i++) {
  19698. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19699. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19700. }
  19701. #endif
  19702. return certs.size();
  19703. }
  19704. inline void free_cert(cert_t cert) {
  19705. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19706. }
  19707. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19708. if (!cert || !hostname) { return false; }
  19709. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19710. std::string host_str(hostname);
  19711. // Check if hostname is an IP address (IPv4 or IPv6)
  19712. unsigned char ip_bytes[16];
  19713. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19714. auto is_ip = ip_len > 0;
  19715. // Check Subject Alternative Names
  19716. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19717. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19718. if (san_names) {
  19719. int san_count = wolfSSL_sk_num(san_names);
  19720. for (int i = 0; i < san_count; i++) {
  19721. auto *names =
  19722. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19723. if (!names) continue;
  19724. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19725. // DNS name
  19726. unsigned char *dns_name = nullptr;
  19727. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19728. if (dns_name && dns_len > 0) {
  19729. std::string san_name(reinterpret_cast<char *>(dns_name),
  19730. static_cast<size_t>(dns_len));
  19731. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19732. if (detail::match_hostname(san_name, host_str)) {
  19733. wolfSSL_sk_free(san_names);
  19734. return true;
  19735. }
  19736. }
  19737. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19738. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19739. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19740. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19741. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19742. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19743. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19744. wolfSSL_sk_free(san_names);
  19745. return true;
  19746. }
  19747. }
  19748. }
  19749. wolfSSL_sk_free(san_names);
  19750. }
  19751. return false;
  19752. }
  19753. inline uint64_t hostname_mismatch_code() {
  19754. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19755. }
  19756. inline long get_verify_result(const_session_t session) {
  19757. if (!session) { return -1; }
  19758. auto wsession =
  19759. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19760. long result = wolfSSL_get_verify_result(wsession->ssl);
  19761. return result;
  19762. }
  19763. inline std::string get_cert_subject_cn(cert_t cert) {
  19764. if (!cert) return "";
  19765. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19766. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19767. if (!subject) return "";
  19768. char cn[256] = {};
  19769. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19770. sizeof(cn));
  19771. if (cn_len <= 0) return "";
  19772. return std::string(cn, static_cast<size_t>(cn_len));
  19773. }
  19774. inline std::string get_cert_issuer_name(cert_t cert) {
  19775. if (!cert) return "";
  19776. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19777. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19778. if (!issuer) return "";
  19779. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19780. if (!name_str) return "";
  19781. std::string result(name_str);
  19782. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19783. return result;
  19784. }
  19785. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19786. sans.clear();
  19787. if (!cert) return false;
  19788. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19789. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19790. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19791. if (!san_names) return true; // No SANs is not an error
  19792. int count = wolfSSL_sk_num(san_names);
  19793. for (int i = 0; i < count; i++) {
  19794. auto *name =
  19795. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19796. if (!name) continue;
  19797. SanEntry entry;
  19798. switch (name->type) {
  19799. case WOLFSSL_GEN_DNS: {
  19800. entry.type = SanType::DNS;
  19801. unsigned char *dns_name = nullptr;
  19802. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19803. if (dns_name && dns_len > 0) {
  19804. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19805. static_cast<size_t>(dns_len));
  19806. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19807. }
  19808. break;
  19809. }
  19810. case WOLFSSL_GEN_IPADD: {
  19811. entry.type = SanType::IP;
  19812. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19813. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19814. if (ip_data && ip_len == 4) {
  19815. char buf[16];
  19816. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19817. ip_data[2], ip_data[3]);
  19818. entry.value = buf;
  19819. } else if (ip_data && ip_len == 16) {
  19820. char buf[64];
  19821. snprintf(buf, sizeof(buf),
  19822. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19823. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19824. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19825. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19826. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19827. ip_data[14], ip_data[15]);
  19828. entry.value = buf;
  19829. }
  19830. break;
  19831. }
  19832. case WOLFSSL_GEN_EMAIL:
  19833. entry.type = SanType::EMAIL;
  19834. {
  19835. unsigned char *email = nullptr;
  19836. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19837. if (email && email_len > 0) {
  19838. entry.value = std::string(reinterpret_cast<char *>(email),
  19839. static_cast<size_t>(email_len));
  19840. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19841. }
  19842. }
  19843. break;
  19844. case WOLFSSL_GEN_URI:
  19845. entry.type = SanType::URI;
  19846. {
  19847. unsigned char *uri = nullptr;
  19848. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19849. &uri, name->d.uniformResourceIdentifier);
  19850. if (uri && uri_len > 0) {
  19851. entry.value = std::string(reinterpret_cast<char *>(uri),
  19852. static_cast<size_t>(uri_len));
  19853. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19854. }
  19855. }
  19856. break;
  19857. default: entry.type = SanType::OTHER; break;
  19858. }
  19859. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19860. }
  19861. wolfSSL_sk_free(san_names);
  19862. return true;
  19863. }
  19864. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19865. time_t &not_after) {
  19866. if (!cert) return false;
  19867. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19868. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19869. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19870. if (!nb || !na) return false;
  19871. // wolfSSL_ASN1_TIME_to_tm is available
  19872. struct tm tm_nb = {}, tm_na = {};
  19873. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19874. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19875. #ifdef _WIN32
  19876. not_before = _mkgmtime(&tm_nb);
  19877. not_after = _mkgmtime(&tm_na);
  19878. #else
  19879. not_before = timegm(&tm_nb);
  19880. not_after = timegm(&tm_na);
  19881. #endif
  19882. return true;
  19883. }
  19884. inline std::string get_cert_serial(cert_t cert) {
  19885. if (!cert) return "";
  19886. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19887. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19888. if (!serial_asn1) return "";
  19889. // Get the serial number data
  19890. int len = serial_asn1->length;
  19891. unsigned char *data = serial_asn1->data;
  19892. if (!data || len <= 0) return "";
  19893. std::string result;
  19894. result.reserve(static_cast<size_t>(len) * 2);
  19895. for (int i = 0; i < len; i++) {
  19896. char hex[3];
  19897. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19898. result += hex;
  19899. }
  19900. return result;
  19901. }
  19902. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19903. if (!cert) return false;
  19904. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19905. int der_len = 0;
  19906. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19907. if (!der_data || der_len <= 0) return false;
  19908. der.assign(der_data, der_data + der_len);
  19909. return true;
  19910. }
  19911. inline const char *get_sni(const_session_t session) {
  19912. if (!session) return nullptr;
  19913. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19914. // For server: return SNI received from client during handshake
  19915. if (!wsession->sni_hostname.empty()) {
  19916. return wsession->sni_hostname.c_str();
  19917. }
  19918. // For client: return the hostname set via set_sni
  19919. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19920. return nullptr;
  19921. }
  19922. inline uint64_t peek_error() {
  19923. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19924. }
  19925. inline uint64_t get_error() {
  19926. uint64_t err = impl::wolfssl_last_error();
  19927. impl::wolfssl_last_error() = 0;
  19928. return err;
  19929. }
  19930. inline std::string error_string(uint64_t code) {
  19931. char buf[256];
  19932. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19933. return std::string(buf);
  19934. }
  19935. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19936. if (!pem || len == 0) { return nullptr; }
  19937. // Validate by attempting to load into a temporary ctx
  19938. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19939. if (!tmp_ctx) { return nullptr; }
  19940. int ret = wolfSSL_CTX_load_verify_buffer(
  19941. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19942. static_cast<long>(len), SSL_FILETYPE_PEM);
  19943. wolfSSL_CTX_free(tmp_ctx);
  19944. if (ret != SSL_SUCCESS) { return nullptr; }
  19945. return static_cast<ca_store_t>(
  19946. new impl::WolfSSLCAStore{std::string(pem, len)});
  19947. }
  19948. inline void free_ca_store(ca_store_t store) {
  19949. delete static_cast<impl::WolfSSLCAStore *>(store);
  19950. }
  19951. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19952. if (!ctx || !store) { return false; }
  19953. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19954. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19955. int ret = wolfSSL_CTX_load_verify_buffer(
  19956. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19957. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19958. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19959. // This function takes ownership of the store; the PEM data was copied into
  19960. // the context, so release the source
  19961. free_ca_store(store);
  19962. return ret == SSL_SUCCESS;
  19963. }
  19964. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19965. certs.clear();
  19966. if (!ctx) { return 0; }
  19967. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19968. if (wctx->ca_pem_data_.empty()) { return 0; }
  19969. const std::string &pem = wctx->ca_pem_data_;
  19970. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19971. const std::string end_marker = "-----END CERTIFICATE-----";
  19972. size_t pos = 0;
  19973. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19974. size_t end_pos = pem.find(end_marker, pos);
  19975. if (end_pos == std::string::npos) { break; }
  19976. end_pos += end_marker.size();
  19977. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19978. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19979. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19980. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19981. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19982. pos = end_pos;
  19983. }
  19984. return certs.size();
  19985. }
  19986. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19987. std::vector<std::string> names;
  19988. if (!ctx) { return names; }
  19989. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19990. if (wctx->ca_pem_data_.empty()) { return names; }
  19991. const std::string &pem = wctx->ca_pem_data_;
  19992. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19993. const std::string end_marker = "-----END CERTIFICATE-----";
  19994. size_t pos = 0;
  19995. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19996. size_t end_pos = pem.find(end_marker, pos);
  19997. if (end_pos == std::string::npos) { break; }
  19998. end_pos += end_marker.size();
  19999. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20000. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20001. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20002. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20003. if (x509) {
  20004. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20005. if (subject) {
  20006. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  20007. if (name_str) {
  20008. names.push_back(name_str);
  20009. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20010. }
  20011. }
  20012. wolfSSL_X509_free(x509);
  20013. }
  20014. pos = end_pos;
  20015. }
  20016. return names;
  20017. }
  20018. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  20019. const char *key_pem, const char *password) {
  20020. if (!ctx || !cert_pem || !key_pem) { return false; }
  20021. // Try the pair on a scratch context first, so that a bad one leaves the
  20022. // server's certificate and key as they were
  20023. auto tmp = create_server_context();
  20024. if (!tmp) { return false; }
  20025. auto se = detail::scope_exit([&] { free_context(tmp); });
  20026. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  20027. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  20028. }
  20029. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  20030. if (!ctx || !ca_pem) { return false; }
  20031. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20032. // Replace the CAs rather than add to them, as the other backends do, once
  20033. // the new ones are known to load
  20034. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  20035. if (!store) { return false; }
  20036. free_ca_store(store);
  20037. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  20038. wctx->ca_pem_data_.clear();
  20039. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  20040. }
  20041. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  20042. if (!ctx) { return false; }
  20043. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20044. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  20045. : nullptr;
  20046. {
  20047. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  20048. // A handshake running the previous callback keeps it until it returns.
  20049. wctx->verify_callback.swap(stored);
  20050. }
  20051. impl::apply_verify_mode(*wctx);
  20052. return true;
  20053. }
  20054. inline long get_verify_error(const_session_t session) {
  20055. if (!session) { return -1; }
  20056. auto *wsession =
  20057. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20058. return wolfSSL_get_verify_result(wsession->ssl);
  20059. }
  20060. inline std::string verify_error_string(long error_code) {
  20061. if (error_code == 0) { return ""; }
  20062. const char *str =
  20063. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  20064. return str ? std::string(str) : std::string();
  20065. }
  20066. } // namespace tls
  20067. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  20068. // WebSocket implementation
  20069. namespace ws {
  20070. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  20071. bool fin) {
  20072. std::lock_guard<std::mutex> lock(write_mutex_);
  20073. if (closed_) { return false; }
  20074. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  20075. }
  20076. inline ReadResult WebSocket::read(std::string &msg) {
  20077. // Answers a control frame; any other opcode here is a protocol error.
  20078. // Returns false when the connection is done.
  20079. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  20080. switch (op) {
  20081. case Opcode::Ping: {
  20082. std::lock_guard<std::mutex> lock(write_mutex_);
  20083. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  20084. payload.size(), true, !is_server_);
  20085. return true;
  20086. }
  20087. case Opcode::Pong: {
  20088. std::lock_guard<std::mutex> lock(ping_mutex_);
  20089. unacked_pings_ = 0;
  20090. return true;
  20091. }
  20092. case Opcode::Close: {
  20093. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  20094. // malformed, which is answered with a protocol error instead.
  20095. if (closed_.exchange(true)) { return false; }
  20096. auto reply = payload;
  20097. if (!impl::is_valid_close_payload(payload)) {
  20098. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  20099. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  20100. }
  20101. std::lock_guard<std::mutex> lock(write_mutex_);
  20102. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  20103. reply.size(), true, !is_server_);
  20104. return false;
  20105. }
  20106. default: closed_ = true; return false;
  20107. }
  20108. };
  20109. std::unique_lock<std::mutex> read_lock(read_mutex_);
  20110. while (!closed_) {
  20111. Opcode opcode;
  20112. std::string payload;
  20113. bool fin;
  20114. impl::FrameRead r =
  20115. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  20116. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  20117. // A timeout landed on a frame boundary of an open connection: it is
  20118. // untouched and still usable, so hand control back without closing it.
  20119. // That is only useful to a caller who asked for the timeout; the
  20120. // compile-time default is a backstop against a peer gone quiet, and
  20121. // elapsing it closes the connection so a plain `while (ws.read(msg))` loop
  20122. // ends. A wait that a pong timeout cut short finds the connection closed.
  20123. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  20124. return Timeout;
  20125. }
  20126. if (r != impl::FrameRead::Ok) {
  20127. closed_ = true;
  20128. return Fail;
  20129. }
  20130. switch (opcode) {
  20131. case Opcode::Text:
  20132. case Opcode::Binary: {
  20133. auto result = opcode == Opcode::Text ? Text : Binary;
  20134. msg = std::move(payload);
  20135. // Handle fragmentation
  20136. if (!fin) {
  20137. while (true) {
  20138. Opcode cont_opcode;
  20139. std::string cont_payload;
  20140. bool cont_fin;
  20141. // Only what is left of the limit, but room for a control frame,
  20142. // which may come between the fragments.
  20143. auto max_len =
  20144. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  20145. ? size_t(0)
  20146. : (std::max)(size_t(125),
  20147. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  20148. msg.size());
  20149. // A timeout is not reportable here: half of a fragmented message is
  20150. // already in `msg` and read() has no way to resume it, so it is a
  20151. // failure like any other. Timeouts are only ever seen on a message
  20152. // boundary.
  20153. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  20154. cont_fin, is_server_,
  20155. max_len) != impl::FrameRead::Ok) {
  20156. closed_ = true;
  20157. return Fail;
  20158. }
  20159. // RFC 6455 5.4: the fragments are continuation frames, with only
  20160. // control frames between them.
  20161. if (cont_opcode != Opcode::Continuation) {
  20162. if (handle_control(cont_opcode, cont_payload)) { continue; }
  20163. return Fail;
  20164. }
  20165. msg += cont_payload;
  20166. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  20167. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  20168. closed_ = true;
  20169. return Fail;
  20170. }
  20171. if (cont_fin) { break; }
  20172. }
  20173. }
  20174. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  20175. if (result == Text && !impl::is_valid_utf8(msg)) {
  20176. // close() takes the read lock to wait for the peer's Close reply, so
  20177. // it must not run while this thread still holds it.
  20178. read_lock.unlock();
  20179. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20180. return Fail;
  20181. }
  20182. return result;
  20183. }
  20184. default:
  20185. if (handle_control(opcode, payload)) { continue; }
  20186. return Fail;
  20187. }
  20188. }
  20189. return Fail;
  20190. }
  20191. inline bool WebSocket::send(const std::string &data) {
  20192. return send_frame(Opcode::Text, data.data(), data.size());
  20193. }
  20194. inline bool WebSocket::send(const char *data, size_t len) {
  20195. return send_frame(Opcode::Binary, data, len);
  20196. }
  20197. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20198. if (closed_.exchange(true)) { return; }
  20199. ping_cv_.notify_all();
  20200. std::string payload;
  20201. auto code = static_cast<uint16_t>(status);
  20202. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20203. payload.push_back(static_cast<char>(code & 0xFF));
  20204. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20205. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20206. // cut back to a whole UTF-8 character
  20207. auto short_reason = reason.substr(0, 123);
  20208. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20209. short_reason.pop_back();
  20210. }
  20211. payload += short_reason;
  20212. // A code that may not be sent, such as NoStatus, goes without a payload
  20213. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20214. {
  20215. std::lock_guard<std::mutex> lock(write_mutex_);
  20216. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20217. payload.size(), true, !is_server_);
  20218. }
  20219. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20220. // Close response before closing the TCP connection.
  20221. //
  20222. // Wait only when no other thread is parsing frames. When one is, it is the
  20223. // thread positioned to see the peer's reply, and reading here would take
  20224. // bytes out of the message it is assembling. Bailing out also leaves the
  20225. // stream, including its read timeout, entirely to that thread.
  20226. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20227. if (!read_lock.owns_lock()) { return; }
  20228. // Use a short timeout to avoid hanging if the peer doesn't respond.
  20229. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20230. Opcode op;
  20231. std::string resp;
  20232. bool fin;
  20233. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20234. impl::FrameRead::Ok) {
  20235. if (op == Opcode::Close) { break; }
  20236. }
  20237. }
  20238. inline WebSocket::~WebSocket() {
  20239. {
  20240. std::lock_guard<std::mutex> lock(ping_mutex_);
  20241. closed_ = true;
  20242. }
  20243. ping_cv_.notify_all();
  20244. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20245. // A server's stream outlives this object
  20246. strm_.set_read_interrupt(nullptr);
  20247. }
  20248. inline void WebSocket::start_heartbeat() {
  20249. if (ping_interval_sec_ <= 0) { return; }
  20250. // A pong timeout ends a read() blocked on the silent peer
  20251. if (max_missed_pongs_ > 0) {
  20252. strm_.set_read_interrupt([this] { return pong_timed_out_.load(); });
  20253. }
  20254. ping_thread_ = std::thread([this]() {
  20255. std::unique_lock<std::mutex> lock(ping_mutex_);
  20256. // The predicate keeps a spurious wakeup from sending a ping early
  20257. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20258. [this]() { return closed_.load(); })) {
  20259. // If the peer has failed to respond to the previous pings, give up.
  20260. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20261. // opt-in liveness check controlled by max_missed_pongs_.
  20262. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20263. lock.unlock();
  20264. close(CloseStatus::GoingAway, "pong timeout");
  20265. pong_timed_out_ = true;
  20266. return;
  20267. }
  20268. lock.unlock();
  20269. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20270. lock.lock();
  20271. closed_ = true;
  20272. break;
  20273. }
  20274. lock.lock();
  20275. unacked_pings_++;
  20276. }
  20277. });
  20278. }
  20279. inline const Request &WebSocket::request() const { return req_; }
  20280. inline bool WebSocket::is_open() const { return !closed_; }
  20281. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20282. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20283. // poll(), where 0 would instead mean "return immediately", so hand it the
  20284. // negative poll uses for an unbounded wait.
  20285. if (sec == 0 && usec == 0) { sec = -1; }
  20286. strm_.set_read_timeout(sec, usec);
  20287. read_timeout_set_ = true;
  20288. }
  20289. // WebSocketClient implementation
  20290. inline WebSocketClient::WebSocketClient(
  20291. const std::string &scheme_host_port_path, const Headers &headers)
  20292. : headers_(headers) {
  20293. detail::UrlComponents uc;
  20294. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20295. !uc.host.empty() && !uc.path.empty()) {
  20296. auto &scheme = uc.scheme;
  20297. #ifdef CPPHTTPLIB_SSL_ENABLED
  20298. if (scheme != "ws" && scheme != "wss") {
  20299. #else
  20300. if (scheme != "ws") {
  20301. #endif
  20302. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20303. std::string msg = "'" + scheme + "' scheme is not supported.";
  20304. throw std::invalid_argument(msg);
  20305. #endif
  20306. return;
  20307. }
  20308. auto is_ssl = scheme == "wss";
  20309. host_ = std::move(uc.host);
  20310. port_ = is_ssl ? 443 : 80;
  20311. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20312. path_ = std::move(uc.path);
  20313. if (!uc.query.empty()) { path_ += uc.query; }
  20314. #ifdef CPPHTTPLIB_SSL_ENABLED
  20315. is_ssl_ = is_ssl;
  20316. if (is_ssl_) {
  20317. // The context lives as long as the client so that CA configuration
  20318. // survives reconnects; sessions are created per connection.
  20319. tls_ctx_ = tls::create_client_context();
  20320. if (!tls_ctx_) { return; }
  20321. }
  20322. #else
  20323. if (is_ssl) { return; }
  20324. #endif
  20325. is_valid_ = true;
  20326. }
  20327. }
  20328. #ifdef CPPHTTPLIB_SSL_ENABLED
  20329. inline WebSocketClient::WebSocketClient(
  20330. const std::string &scheme_host_port_path, const PemMemory &pem,
  20331. const Headers &headers)
  20332. : WebSocketClient(scheme_host_port_path, headers) {
  20333. // For ws:// URLs the client certificate is silently ignored, consistent
  20334. // with the TLS-only setters such as set_ca_cert_path().
  20335. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20336. std::string cert_buf, key_buf;
  20337. if (!tls::set_client_cert_pem(
  20338. tls_ctx_,
  20339. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20340. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20341. pem.private_key_password)) {
  20342. tls::free_context(tls_ctx_);
  20343. tls_ctx_ = nullptr;
  20344. is_valid_ = false;
  20345. }
  20346. }
  20347. }
  20348. #endif
  20349. inline WebSocketClient::~WebSocketClient() {
  20350. shutdown_and_close();
  20351. #ifdef CPPHTTPLIB_SSL_ENABLED
  20352. if (tls_ctx_) {
  20353. tls::free_context(tls_ctx_);
  20354. tls_ctx_ = nullptr;
  20355. }
  20356. #endif
  20357. }
  20358. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20359. inline void WebSocketClient::shutdown_and_close() {
  20360. // Send the close frame while the TLS session is still alive: ws_ holds an
  20361. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20362. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20363. if (ws_ && ws_->is_open()) { ws_->close(); }
  20364. ws_.reset();
  20365. #ifdef CPPHTTPLIB_SSL_ENABLED
  20366. if (is_ssl_) {
  20367. if (tls_session_) {
  20368. tls::shutdown(tls_session_, true);
  20369. tls::free_session(tls_session_);
  20370. tls_session_ = nullptr;
  20371. }
  20372. }
  20373. #endif
  20374. if (sock_ != INVALID_SOCKET) {
  20375. detail::shutdown_socket(sock_);
  20376. detail::close_socket(sock_);
  20377. sock_ = INVALID_SOCKET;
  20378. }
  20379. }
  20380. // The handshakes belong to establishing the connection, so an unset read
  20381. // timeout leaves them bounded by the connection timeout instead of forever.
  20382. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20383. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20384. return {connection_timeout_sec_, connection_timeout_usec_};
  20385. }
  20386. return {read_timeout_sec_, read_timeout_usec_};
  20387. }
  20388. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20389. Error &error, int &ssl_error,
  20390. uint64_t &ssl_backend_error) {
  20391. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20392. // The streams wait with poll(), where 0 instead means "return immediately",
  20393. // so they are given the negative poll uses for an unbounded wait.
  20394. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20395. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20396. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20397. #ifdef CPPHTTPLIB_SSL_ENABLED
  20398. if (is_ssl_) {
  20399. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20400. // is not safe to call concurrently on one client to begin with, since
  20401. // nothing else here is guarded either.
  20402. if (server_certificate_verification_ && !certs_loaded_) {
  20403. uint64_t backend_error = 0;
  20404. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20405. ca_cert_dir_path_, custom_ca_loaded_,
  20406. system_ca_mode_, backend_error);
  20407. certs_loaded_ = true;
  20408. }
  20409. detail::ClientTlsSessionOptions options;
  20410. options.server_hostname_verification = server_hostname_verification_;
  20411. options.session_verifier = session_verifier_;
  20412. auto timeout = handshake_timeout();
  20413. detail::ClientTlsSessionError tls_error;
  20414. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20415. server_certificate_verification_,
  20416. timeout.first, timeout.second,
  20417. &tls_error, options)) {
  20418. error = tls_error.error;
  20419. ssl_error = tls_error.ssl_error;
  20420. ssl_backend_error = tls_error.backend_error;
  20421. return false;
  20422. }
  20423. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20424. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20425. write_timeout_usec_));
  20426. return true;
  20427. }
  20428. #else
  20429. (void)error;
  20430. (void)ssl_error;
  20431. (void)ssl_backend_error;
  20432. #endif
  20433. strm = std::unique_ptr<Stream>(
  20434. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20435. write_timeout_sec_, write_timeout_usec_));
  20436. return true;
  20437. }
  20438. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20439. #ifdef CPPHTTPLIB_SSL_ENABLED
  20440. auto is_ssl = is_ssl_;
  20441. #else
  20442. auto is_ssl = false;
  20443. #endif
  20444. if (!req.has_header("Host")) {
  20445. req.headers.emplace("Host", detail::make_default_host_header_value(
  20446. host_, port_, is_ssl, address_family_));
  20447. }
  20448. detail::add_default_user_agent_header(req);
  20449. }
  20450. inline Result WebSocketClient::connect() {
  20451. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20452. shutdown_and_close();
  20453. auto error = Error::Success;
  20454. if (!create_and_connect_socket(error)) {
  20455. return Result{error, -1, Headers{}};
  20456. }
  20457. if (is_proxy_enabled()) {
  20458. Response proxy_res;
  20459. if (!connect_with_proxy(proxy_res, error)) {
  20460. shutdown_and_close();
  20461. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20462. }
  20463. }
  20464. std::unique_ptr<Stream> strm;
  20465. auto stream_error = Error::SSLConnection;
  20466. int ssl_error = 0;
  20467. uint64_t ssl_backend_error = 0;
  20468. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20469. shutdown_and_close();
  20470. #ifdef CPPHTTPLIB_SSL_ENABLED
  20471. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20472. #else
  20473. return Result{stream_error, -1, Headers{}};
  20474. #endif
  20475. }
  20476. Request req;
  20477. req.method = "GET";
  20478. req.path = path_;
  20479. req.headers = headers_;
  20480. prepare_default_headers(req);
  20481. detail::WebSocketUpgradeResponse upgrade;
  20482. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20483. shutdown_and_close();
  20484. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20485. }
  20486. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20487. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20488. websocket_ping_interval_sec_,
  20489. websocket_max_missed_pongs_));
  20490. // The stream was created with the timeout already; tell the WebSocket
  20491. // whether it came from the caller, so read() knows to report it as Timeout.
  20492. ws_->read_timeout_set_ = read_timeout_set_;
  20493. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20494. }
  20495. inline ReadResult WebSocketClient::read(std::string &msg) {
  20496. if (!ws_) { return Fail; }
  20497. return ws_->read(msg);
  20498. }
  20499. inline bool WebSocketClient::send(const std::string &data) {
  20500. if (!ws_) { return false; }
  20501. return ws_->send(data);
  20502. }
  20503. inline bool WebSocketClient::send(const char *data, size_t len) {
  20504. if (!ws_) { return false; }
  20505. return ws_->send(data, len);
  20506. }
  20507. inline void WebSocketClient::close(CloseStatus status,
  20508. const std::string &reason) {
  20509. if (ws_) { ws_->close(status, reason); }
  20510. }
  20511. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20512. inline const std::string &WebSocketClient::subprotocol() const {
  20513. return subprotocol_;
  20514. }
  20515. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20516. read_timeout_sec_ = sec;
  20517. read_timeout_usec_ = usec;
  20518. read_timeout_set_ = true;
  20519. // The members above only seed the next connect(); read() consults the
  20520. // stream, so an already-open connection has to be told directly.
  20521. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20522. }
  20523. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20524. write_timeout_sec_ = sec;
  20525. write_timeout_usec_ = usec;
  20526. }
  20527. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20528. websocket_ping_interval_sec_ = sec;
  20529. }
  20530. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20531. websocket_max_missed_pongs_ = count;
  20532. }
  20533. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20534. inline void WebSocketClient::set_address_family(int family) {
  20535. address_family_ = family;
  20536. }
  20537. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20538. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20539. socket_options_ = std::move(socket_options);
  20540. }
  20541. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20542. connection_timeout_sec_ = sec;
  20543. connection_timeout_usec_ = usec;
  20544. }
  20545. inline void WebSocketClient::set_interface(const std::string &intf) {
  20546. interface_ = intf;
  20547. }
  20548. inline void WebSocketClient::set_hostname_addr_map(
  20549. std::map<std::string, std::string> addr_map) {
  20550. addr_map_ = std::move(addr_map);
  20551. }
  20552. inline bool WebSocketClient::is_proxy_enabled() const {
  20553. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20554. if (no_proxy_entries_.empty()) { return true; }
  20555. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20556. no_proxy_entries_);
  20557. }
  20558. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20559. std::string connect_host;
  20560. std::string ip;
  20561. auto port = port_;
  20562. if (is_proxy_enabled()) {
  20563. connect_host = proxy_host_;
  20564. port = proxy_port_;
  20565. } else {
  20566. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20567. }
  20568. sock_ = detail::create_client_socket(
  20569. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20570. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20571. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20572. write_timeout_usec_, interface_, error);
  20573. if (sock_ != INVALID_SOCKET) { return true; }
  20574. if (error == Error::Success) { error = Error::Connection; }
  20575. return false;
  20576. }
  20577. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20578. Response &proxy_res,
  20579. Error &error) {
  20580. auto timeout = handshake_timeout();
  20581. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20582. write_timeout_sec_, write_timeout_usec_);
  20583. if (!detail::write_request_head(strm, req, error)) { return false; }
  20584. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20585. error = Error::Read;
  20586. return false;
  20587. }
  20588. return true;
  20589. }
  20590. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20591. // forward an Upgrade request.
  20592. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20593. Error &error) {
  20594. Request req;
  20595. req.method = "CONNECT";
  20596. req.path = detail::make_host_and_port_string_always_port(host_, port_);
  20597. req.headers.emplace("Host", req.path);
  20598. detail::add_default_user_agent_header(req);
  20599. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20600. proxy_basic_auth_password_,
  20601. proxy_bearer_token_auth_token_, true);
  20602. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20603. #ifdef CPPHTTPLIB_SSL_ENABLED
  20604. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20605. std::map<std::string, std::string> auth;
  20606. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20607. !proxy_digest_auth_username_.empty() &&
  20608. !proxy_digest_auth_password_.empty() &&
  20609. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20610. proxy_res = Response();
  20611. shutdown_and_close();
  20612. if (!create_and_connect_socket(error)) { return false; }
  20613. req.headers.erase("Proxy-Authorization");
  20614. req.headers.insert(detail::make_digest_authentication_header(
  20615. req, req.path, auth, 1, detail::random_string(10),
  20616. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20617. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20618. }
  20619. #endif
  20620. if (proxy_res.status != StatusCode::OK_200) {
  20621. error = Error::ProxyConnection;
  20622. return false;
  20623. }
  20624. return true;
  20625. }
  20626. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20627. proxy_host_ = host;
  20628. proxy_port_ = port;
  20629. }
  20630. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20631. const std::string &password) {
  20632. proxy_basic_auth_username_ = username;
  20633. proxy_basic_auth_password_ = password;
  20634. }
  20635. inline void
  20636. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20637. proxy_bearer_token_auth_token_ = token;
  20638. }
  20639. inline void
  20640. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20641. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20642. }
  20643. #ifdef CPPHTTPLIB_SSL_ENABLED
  20644. inline void
  20645. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20646. const std::string &ca_cert_dir_path) {
  20647. ca_cert_file_path_ = ca_cert_file_path;
  20648. ca_cert_dir_path_ = ca_cert_dir_path;
  20649. }
  20650. inline void
  20651. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20652. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20653. }
  20654. inline void WebSocketClient::set_session_verifier(
  20655. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20656. session_verifier_ = std::move(verifier);
  20657. }
  20658. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20659. if (store && tls_ctx_) {
  20660. // set_ca_store takes ownership of store
  20661. tls::set_ca_store(tls_ctx_, store);
  20662. } else if (store) {
  20663. tls::free_ca_store(store);
  20664. }
  20665. custom_ca_loaded_ = true;
  20666. }
  20667. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20668. std::size_t size) {
  20669. if (tls_ctx_ && ca_cert && size > 0) {
  20670. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20671. }
  20672. custom_ca_loaded_ = true;
  20673. }
  20674. inline void
  20675. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20676. server_certificate_verification_ = enabled;
  20677. }
  20678. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20679. server_hostname_verification_ = enabled;
  20680. }
  20681. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20682. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20683. }
  20684. inline void
  20685. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  20686. const std::string &password) {
  20687. proxy_digest_auth_username_ = username;
  20688. proxy_digest_auth_password_ = password;
  20689. }
  20690. #endif // CPPHTTPLIB_SSL_ENABLED
  20691. } // namespace ws
  20692. // ----------------------------------------------------------------------------
  20693. } // namespace httplib
  20694. #endif // CPPHTTPLIB_HTTPLIB_H