httplib.h 823 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937
  1. //
  2. // httplib.h
  3. //
  4. // Copyright (c) 2026 Yuji Hirose. All rights reserved.
  5. // MIT License
  6. //
  7. #ifndef CPPHTTPLIB_HTTPLIB_H
  8. #define CPPHTTPLIB_HTTPLIB_H
  9. #define CPPHTTPLIB_VERSION "0.61.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003d00"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_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. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  113. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  114. #endif
  115. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  116. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  117. #endif
  118. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  119. // 1400 rather than a round number: a body that already fits in one 1500-byte
  120. // MTU gains nothing from being made smaller.
  121. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  122. #endif
  123. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  124. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  125. #endif
  126. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  127. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  128. #endif
  129. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  130. // recurses roughly once per matched character for quantified patterns such
  131. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  132. // a default ~8MB thread stack that has been observed to take on the order of
  133. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  134. // margin below that (well under the 8192-byte request URI limit) while still
  135. // fitting any realistic route segment; raise it if a route legitimately needs
  136. // longer paths. Regex routes are never applied to paths longer than this.
  137. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  138. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  139. #endif
  140. #ifndef CPPHTTPLIB_TCP_NODELAY
  141. #define CPPHTTPLIB_TCP_NODELAY false
  142. #endif
  143. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  144. #define CPPHTTPLIB_IPV6_V6ONLY false
  145. #endif
  146. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  147. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  148. #endif
  149. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  150. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  151. #endif
  152. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  153. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  154. #endif
  155. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  156. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  157. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  158. ? std::thread::hardware_concurrency() - 1 \
  159. : 0))
  160. #endif
  161. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  162. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  163. #endif
  164. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  165. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  166. #endif
  167. #ifndef CPPHTTPLIB_RECV_FLAGS
  168. #define CPPHTTPLIB_RECV_FLAGS 0
  169. #endif
  170. #ifndef CPPHTTPLIB_SEND_FLAGS
  171. #define CPPHTTPLIB_SEND_FLAGS 0
  172. #endif
  173. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  174. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  175. #endif
  176. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  177. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  178. #endif
  179. // These bound the parsing of every request, so 0 cannot lift them.
  180. static_assert(CPPHTTPLIB_REQUEST_URI_MAX_LENGTH > 0,
  181. "CPPHTTPLIB_REQUEST_URI_MAX_LENGTH must be positive");
  182. static_assert(CPPHTTPLIB_HEADER_MAX_LENGTH > 0,
  183. "CPPHTTPLIB_HEADER_MAX_LENGTH must be positive");
  184. static_assert(CPPHTTPLIB_HEADER_MAX_COUNT > 0,
  185. "CPPHTTPLIB_HEADER_MAX_COUNT must be positive");
  186. static_assert(CPPHTTPLIB_MAX_LINE_LENGTH > 0,
  187. "CPPHTTPLIB_MAX_LINE_LENGTH must be positive");
  188. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  189. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  190. #endif
  191. // One macro used to set the read timeout for both sides. They want different
  192. // defaults: a client's read timeout is the caller's own tool (it waits forever
  193. // until asked not to), while a server keeps a ceiling that reclaims a worker
  194. // from a peer that has gone quiet. The old name still works and sets both.
  195. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  196. #pragma message( \
  197. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  198. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  199. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  200. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  201. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  202. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  203. #endif
  204. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  205. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  206. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  207. #endif
  208. #endif
  209. // 0 waits forever. A read timeout is how a caller gets control back to send on
  210. // the same connection; it is not a liveness check (that is ping/pong). Only a
  211. // timeout set at runtime through set_read_timeout() is reported as
  212. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  213. // ws::Fail and closes the connection.
  214. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  215. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  216. #endif
  217. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  218. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  219. #endif
  220. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  221. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  222. #endif
  223. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  224. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  225. #endif
  226. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  227. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  228. #endif
  229. /*
  230. * Headers
  231. */
  232. #ifdef _WIN32
  233. #ifndef _CRT_SECURE_NO_WARNINGS
  234. #define _CRT_SECURE_NO_WARNINGS
  235. #endif //_CRT_SECURE_NO_WARNINGS
  236. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  237. #define _CRT_NONSTDC_NO_DEPRECATE
  238. #endif //_CRT_NONSTDC_NO_DEPRECATE
  239. #if defined(_MSC_VER)
  240. #if _MSC_VER < 1900
  241. #error Sorry, Visual Studio versions prior to 2015 are not supported
  242. #endif
  243. #pragma comment(lib, "ws2_32.lib")
  244. #ifndef _SSIZE_T_DEFINED
  245. using ssize_t = __int64;
  246. #define _SSIZE_T_DEFINED
  247. #endif
  248. #endif // _MSC_VER
  249. #ifndef S_ISREG
  250. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  251. #endif // S_ISREG
  252. #ifndef S_ISDIR
  253. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  254. #endif // S_ISDIR
  255. #ifndef NOMINMAX
  256. #define NOMINMAX
  257. #endif // NOMINMAX
  258. #include <io.h>
  259. #include <winsock2.h>
  260. #include <ws2tcpip.h>
  261. #if defined(__has_include)
  262. #if __has_include(<afunix.h>)
  263. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  264. #include <afunix.h>
  265. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  266. #endif
  267. #endif
  268. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  269. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  270. #endif
  271. using nfds_t = unsigned long;
  272. using socket_t = SOCKET;
  273. using socklen_t = int;
  274. #else // not _WIN32
  275. #include <arpa/inet.h>
  276. #if !defined(_AIX) && !defined(__MVS__)
  277. #include <ifaddrs.h>
  278. #endif
  279. #ifdef __MVS__
  280. #include <strings.h>
  281. #ifndef NI_MAXHOST
  282. #define NI_MAXHOST 1025
  283. #endif
  284. #endif
  285. #include <net/if.h>
  286. #include <netdb.h>
  287. #include <netinet/in.h>
  288. #ifdef __linux__
  289. #include <resolv.h>
  290. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  291. #endif
  292. #include <csignal>
  293. #include <netinet/tcp.h>
  294. #include <poll.h>
  295. #include <pthread.h>
  296. #include <sys/socket.h>
  297. #include <sys/un.h>
  298. #include <unistd.h>
  299. using socket_t = int;
  300. #ifndef INVALID_SOCKET
  301. #define INVALID_SOCKET (-1)
  302. #endif
  303. #endif //_WIN32
  304. #if defined(__APPLE__)
  305. #include <TargetConditionals.h>
  306. #endif
  307. #include <algorithm>
  308. #include <array>
  309. #include <atomic>
  310. #include <cassert>
  311. #include <chrono>
  312. #include <climits>
  313. #include <condition_variable>
  314. #include <cstdlib>
  315. #include <cstring>
  316. #include <errno.h>
  317. #include <exception>
  318. #include <fcntl.h>
  319. #include <fstream>
  320. #include <functional>
  321. #include <iomanip>
  322. #include <iostream>
  323. #include <iterator>
  324. #include <list>
  325. #include <map>
  326. #include <memory>
  327. #include <mutex>
  328. #include <random>
  329. #include <regex>
  330. #include <set>
  331. #include <sstream>
  332. #include <string>
  333. #include <sys/stat.h>
  334. #include <system_error>
  335. #include <thread>
  336. #include <type_traits>
  337. #include <unordered_map>
  338. #include <unordered_set>
  339. #include <utility>
  340. #include <vector>
  341. // On macOS with a TLS backend, enable Keychain root certificates by default
  342. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  343. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  344. // only; on those platforms the user must provide a CA bundle explicitly.
  345. #if defined(__APPLE__) && defined(__clang__) && \
  346. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  347. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  348. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  349. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  350. #if TARGET_OS_OSX
  351. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  352. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  353. #endif
  354. #endif
  355. #endif
  356. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  357. defined(__APPLE__) && !TARGET_OS_OSX
  358. #error \
  359. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  360. #endif
  361. // On Windows, enable Schannel certificate verification by default
  362. // unless the user explicitly opts out.
  363. #if defined(_WIN32) && \
  364. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  365. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  366. #endif
  367. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  368. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  369. #if TARGET_OS_MAC && defined(__clang__)
  370. #include <CFNetwork/CFHost.h>
  371. #include <CoreFoundation/CoreFoundation.h>
  372. #endif
  373. #endif
  374. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  375. #ifdef _WIN32
  376. #include <wincrypt.h>
  377. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  378. // used
  379. #undef X509_NAME
  380. #undef X509_CERT_PAIR
  381. #undef X509_EXTENSIONS
  382. #undef PKCS7_SIGNER_INFO
  383. #ifdef _MSC_VER
  384. #pragma comment(lib, "crypt32.lib")
  385. #endif
  386. #endif // _WIN32
  387. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  388. #if TARGET_OS_OSX
  389. #include <Security/Security.h>
  390. #endif
  391. #endif
  392. #include <openssl/err.h>
  393. #include <openssl/evp.h>
  394. #include <openssl/rand.h>
  395. #include <openssl/ssl.h>
  396. #include <openssl/x509v3.h>
  397. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  398. #include <openssl/applink.c>
  399. #endif
  400. #include <iostream>
  401. #include <sstream>
  402. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  403. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  404. #error Please use OpenSSL or a current version of BoringSSL
  405. #endif
  406. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  407. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  408. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  409. #endif
  410. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  411. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  412. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  413. // in with this first include group so the version gating below can use it.
  414. #include <mbedtls/error.h>
  415. #include <mbedtls/net_sockets.h>
  416. #include <mbedtls/oid.h>
  417. #include <mbedtls/pk.h>
  418. #include <mbedtls/ssl.h>
  419. #include <mbedtls/version.h>
  420. #include <mbedtls/x509_crt.h>
  421. #if MBEDTLS_VERSION_MAJOR >= 4
  422. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  423. #include <psa/crypto.h>
  424. #else
  425. #include <mbedtls/ctr_drbg.h>
  426. #include <mbedtls/entropy.h>
  427. #include <mbedtls/md5.h>
  428. #include <mbedtls/sha1.h>
  429. #include <mbedtls/sha256.h>
  430. #include <mbedtls/sha512.h>
  431. #endif
  432. #ifdef _WIN32
  433. #include <wincrypt.h>
  434. #ifdef _MSC_VER
  435. #pragma comment(lib, "crypt32.lib")
  436. #endif
  437. #endif // _WIN32
  438. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  439. #if TARGET_OS_OSX
  440. #include <Security/Security.h>
  441. #endif
  442. #endif
  443. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  444. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  445. #if MBEDTLS_VERSION_MAJOR >= 4
  446. #define CPPHTTPLIB_MBEDTLS_V4
  447. #endif
  448. #if MBEDTLS_VERSION_MAJOR >= 3
  449. #define CPPHTTPLIB_MBEDTLS_V3
  450. #endif
  451. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  452. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  453. #include <wolfssl/options.h>
  454. #include <wolfssl/openssl/x509v3.h>
  455. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  456. #ifndef WOLFSSL_GEN_EMAIL
  457. #define WOLFSSL_GEN_EMAIL 1
  458. #endif
  459. #ifndef WOLFSSL_GEN_DNS
  460. #define WOLFSSL_GEN_DNS 2
  461. #endif
  462. #ifndef WOLFSSL_GEN_URI
  463. #define WOLFSSL_GEN_URI 6
  464. #endif
  465. #ifndef WOLFSSL_GEN_IPADD
  466. #define WOLFSSL_GEN_IPADD 7
  467. #endif
  468. #include <wolfssl/ssl.h>
  469. #include <wolfssl/wolfcrypt/hash.h>
  470. #include <wolfssl/wolfcrypt/md5.h>
  471. #include <wolfssl/wolfcrypt/sha256.h>
  472. #include <wolfssl/wolfcrypt/sha512.h>
  473. #ifdef _WIN32
  474. #include <wincrypt.h>
  475. #ifdef _MSC_VER
  476. #pragma comment(lib, "crypt32.lib")
  477. #endif
  478. #endif // _WIN32
  479. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  480. #if TARGET_OS_OSX
  481. #include <Security/Security.h>
  482. #endif
  483. #endif
  484. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  485. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  486. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  487. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  488. #define CPPHTTPLIB_SSL_ENABLED
  489. #endif
  490. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  491. #include <zlib.h>
  492. #endif
  493. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  494. #include <brotli/decode.h>
  495. #include <brotli/encode.h>
  496. #endif
  497. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  498. #include <zstd.h>
  499. #endif
  500. /*
  501. * Declaration
  502. */
  503. namespace httplib {
  504. namespace ws {
  505. class WebSocket;
  506. } // namespace ws
  507. namespace sse {
  508. class SSEClient;
  509. } // namespace sse
  510. namespace detail {
  511. /*
  512. * Backport std::make_unique from C++14.
  513. *
  514. * NOTE: This code came up with the following stackoverflow post:
  515. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  516. *
  517. */
  518. template <class T, class... Args>
  519. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  520. make_unique(Args &&...args) {
  521. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  522. }
  523. template <class T>
  524. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  525. make_unique(std::size_t n) {
  526. typedef typename std::remove_extent<T>::type RT;
  527. return std::unique_ptr<T>(new RT[n]);
  528. }
  529. // Locale-independent ASCII character classification. The <cctype>
  530. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  531. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  532. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  533. // classified without regard to the locale.
  534. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  535. inline bool is_ascii_alpha(char c) {
  536. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  537. }
  538. inline bool is_ascii_alnum(char c) {
  539. return is_ascii_digit(c) || is_ascii_alpha(c);
  540. }
  541. namespace case_ignore {
  542. inline unsigned char to_lower(int c) {
  543. const static unsigned char table[256] = {
  544. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  545. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  546. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  547. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  548. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  549. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  550. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  551. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  552. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  553. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  554. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  555. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  556. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  557. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  558. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  559. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  560. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  561. 255,
  562. };
  563. return table[(unsigned char)(char)c];
  564. }
  565. inline std::string to_lower(const std::string &s) {
  566. std::string result = s;
  567. std::transform(
  568. result.begin(), result.end(), result.begin(),
  569. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  570. return result;
  571. }
  572. inline bool equal(const std::string &a, const std::string &b) {
  573. return a.size() == b.size() &&
  574. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  575. return to_lower(ca) == to_lower(cb);
  576. });
  577. }
  578. // For a literal, without building a std::string from it.
  579. template <size_t N>
  580. inline bool equal(const std::string &a, const char (&b)[N]) {
  581. return a.size() == N - 1 &&
  582. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  583. return to_lower(ca) == to_lower(cb);
  584. });
  585. }
  586. struct equal_to {
  587. bool operator()(const std::string &a, const std::string &b) const {
  588. return equal(a, b);
  589. }
  590. };
  591. struct hash {
  592. size_t operator()(const std::string &key) const {
  593. size_t h = 0;
  594. for (auto c : key) {
  595. // Unsets the 6 high bits of h, therefore no overflow happens
  596. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  597. static_cast<unsigned char>(to_lower(c));
  598. }
  599. return h;
  600. }
  601. };
  602. template <typename T>
  603. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  604. detail::case_ignore::equal_to>;
  605. } // namespace case_ignore
  606. // This is based on
  607. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  608. struct scope_exit {
  609. explicit scope_exit(std::function<void(void)> &&f)
  610. : exit_function(std::move(f)), execute_on_destruction{true} {}
  611. scope_exit(scope_exit &&rhs) noexcept
  612. : exit_function(std::move(rhs.exit_function)),
  613. execute_on_destruction{rhs.execute_on_destruction} {
  614. rhs.release();
  615. }
  616. ~scope_exit() {
  617. if (execute_on_destruction) { this->exit_function(); }
  618. }
  619. void release() { this->execute_on_destruction = false; }
  620. private:
  621. scope_exit(const scope_exit &) = delete;
  622. void operator=(const scope_exit &) = delete;
  623. scope_exit &operator=(scope_exit &&) = delete;
  624. std::function<void(void)> exit_function;
  625. bool execute_on_destruction;
  626. };
  627. // Simple from_chars implementation for integer and double types (C++17
  628. // substitute)
  629. template <typename T> struct from_chars_result {
  630. const char *ptr;
  631. std::errc ec;
  632. };
  633. template <typename T>
  634. inline from_chars_result<T> from_chars(const char *first, const char *last,
  635. T &value, int base = 10) {
  636. value = 0;
  637. const char *p = first;
  638. bool negative = false;
  639. if (p != last && *p == '-') {
  640. negative = true;
  641. ++p;
  642. }
  643. if (p == last) { return {first, std::errc::invalid_argument}; }
  644. auto radix = static_cast<T>(base);
  645. T result = 0;
  646. for (; p != last; ++p) {
  647. char c = *p;
  648. int digit = -1;
  649. if (is_ascii_digit(c)) {
  650. digit = c - '0';
  651. } else if ('a' <= c && c <= 'z') {
  652. digit = c - 'a' + 10;
  653. } else if ('A' <= c && c <= 'Z') {
  654. digit = c - 'A' + 10;
  655. } else {
  656. break;
  657. }
  658. if (digit < 0 || digit >= base) { break; }
  659. auto d = static_cast<T>(digit);
  660. if (result > ((std::numeric_limits<T>::max)() - d) / radix) {
  661. return {p, std::errc::result_out_of_range};
  662. }
  663. result = result * radix + d;
  664. }
  665. if (p == first || (negative && p == first + 1)) {
  666. return {first, std::errc::invalid_argument};
  667. }
  668. value = negative ? T(0) - result : result;
  669. return {p, std::errc{}};
  670. }
  671. // from_chars for double (hand-written, locale-independent)
  672. //
  673. // The only double consumed by this library is the HTTP quality value, whose
  674. // grammar is (RFC 9110 12.4.2):
  675. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  676. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  677. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  678. // '.' always the decimal separator (std::strtod would instead read it from the
  679. // global C locale, mis-parsing q-values once an embedder calls
  680. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  681. // the result to [0, 1], so inputs outside that range need not be distinguished
  682. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  683. // cases that exponent and wide-range handling would introduce.
  684. inline from_chars_result<double> from_chars(const char *first, const char *last,
  685. double &value) {
  686. value = 0.0;
  687. const char *p = first;
  688. // Each 1eN is exactly representable, so a single final division by the
  689. // matching entry yields a correctly-rounded result.
  690. static const double powers_of_ten[] = {
  691. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  692. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  693. const int max_frac_digits =
  694. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  695. // Accumulate digits into a 64-bit integer and remember how many were
  696. // fractional. Two independent caps keep this bounded and safe:
  697. // * accumulation saturates before mantissa could overflow uint64_t, and
  698. // * frac_digits is capped at max_frac_digits so it is always a valid index
  699. // into powers_of_ten (without this an input like "0.000...0" would never
  700. // grow mantissa, so the saturation cap alone would not bound it).
  701. // Both caps only drop digits far beyond the precision a q-value needs; any
  702. // value they would change is well outside [0, 1] and rejected by the caller.
  703. uint64_t mantissa = 0;
  704. int frac_digits = 0;
  705. bool seen_digit = false;
  706. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  707. auto accumulate = [&](char c) {
  708. if (mantissa <= limit) {
  709. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  710. return true;
  711. }
  712. return false;
  713. };
  714. for (; p != last && is_ascii_digit(*p); ++p) {
  715. seen_digit = true;
  716. accumulate(*p);
  717. }
  718. if (p != last && *p == '.') {
  719. ++p;
  720. for (; p != last && is_ascii_digit(*p); ++p) {
  721. seen_digit = true;
  722. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  723. }
  724. }
  725. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  726. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  727. return {p, std::errc{}};
  728. }
  729. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  730. int &out) {
  731. int val = 0;
  732. auto r = from_chars(s, s + len, val);
  733. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  734. return false;
  735. }
  736. out = val;
  737. return true;
  738. }
  739. inline bool parse_port(const char *s, size_t len, int &port) {
  740. return parse_int_in_range(s, len, 1, 65535, port);
  741. }
  742. inline bool parse_port(const std::string &s, int &port) {
  743. return parse_port(s.data(), s.size(), port);
  744. }
  745. struct UrlComponents {
  746. std::string scheme;
  747. std::string host;
  748. std::string port;
  749. std::string path;
  750. std::string query;
  751. };
  752. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  753. uc = {};
  754. size_t pos = 0;
  755. auto sep = url.find("://");
  756. if (sep != std::string::npos) {
  757. uc.scheme = url.substr(0, sep);
  758. // Scheme must be [a-z]+ only
  759. if (uc.scheme.empty()) { return false; }
  760. for (auto c : uc.scheme) {
  761. if (c < 'a' || c > 'z') { return false; }
  762. }
  763. pos = sep + 3;
  764. } else if (url.compare(0, 2, "//") == 0) {
  765. pos = 2;
  766. }
  767. auto has_authority_prefix = pos > 0;
  768. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  769. url[0] != '?' && url[0] != '#');
  770. if (has_authority) {
  771. // userinfo is not supported, and a backslash that some parsers take for
  772. // '/' would leave them seeing another host than this one.
  773. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  774. return false;
  775. }
  776. if (pos < url.size() && url[pos] == '[') {
  777. auto close = url.find(']', pos);
  778. if (close == std::string::npos) { return false; }
  779. uc.host = url.substr(pos + 1, close - pos - 1);
  780. // IPv6 host must be [a-fA-F0-9:]+ only
  781. if (uc.host.empty()) { return false; }
  782. for (auto c : uc.host) {
  783. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  784. (c >= 'A' && c <= 'F') || c == ':')) {
  785. return false;
  786. }
  787. }
  788. pos = close + 1;
  789. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  790. // path, query or fragment delimiter (or the end of input). Otherwise the
  791. // trailing bytes would be folded into the path while the connection
  792. // still targets the bracketed address.
  793. if (pos < url.size()) {
  794. auto c = url[pos];
  795. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  796. }
  797. } else {
  798. auto end = url.find_first_of(":/?#", pos);
  799. if (end == std::string::npos) { end = url.size(); }
  800. uc.host = url.substr(pos, end - pos);
  801. pos = end;
  802. }
  803. if (pos < url.size() && url[pos] == ':') {
  804. ++pos;
  805. auto end = url.find_first_of("/?#", pos);
  806. if (end == std::string::npos) { end = url.size(); }
  807. uc.port = url.substr(pos, end - pos);
  808. pos = end;
  809. }
  810. // Without :// or //, the entire input must be consumed as host[:port].
  811. // If there is leftover (path, query, etc.), this is not a valid
  812. // host[:port] string — clear and reparse as a plain path.
  813. if (!has_authority_prefix && pos < url.size()) {
  814. uc.host.clear();
  815. uc.port.clear();
  816. pos = 0;
  817. }
  818. }
  819. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  820. auto end = url.find_first_of("?#", pos);
  821. if (end == std::string::npos) { end = url.size(); }
  822. uc.path = url.substr(pos, end - pos);
  823. pos = end;
  824. }
  825. if (pos < url.size() && url[pos] == '?') {
  826. auto end = url.find('#', pos);
  827. if (end == std::string::npos) { end = url.size(); }
  828. uc.query = url.substr(pos, end - pos);
  829. }
  830. return true;
  831. }
  832. // Resolves a relative-path or query-only Location value against the path of
  833. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  834. // references starting with '/' are returned unchanged.
  835. inline std::string resolve_relative_location(const std::string &location,
  836. const std::string &base) {
  837. if (location.empty() || location[0] == '/') { return location; }
  838. // A ':' in the first segment means the value has a scheme.
  839. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  840. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  841. auto base_path = base.substr(0, base.find_first_of("?#"));
  842. if (location[0] == '?') { return base_path + location; }
  843. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  844. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  845. // Remove "." and ".." segments from the merged path.
  846. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  847. std::string path;
  848. size_t i = 0;
  849. while (i < path_end) {
  850. auto next = (std::min)(merged.find('/', i + 1), path_end);
  851. auto segment = merged.substr(i + 1, next - i - 1);
  852. auto is_last = next == path_end;
  853. if (segment == "." || segment == "..") {
  854. if (segment == "..") {
  855. path.erase((std::min)(path.rfind('/'), path.size()));
  856. }
  857. if (is_last) { path += '/'; }
  858. } else {
  859. path += '/';
  860. path += segment;
  861. }
  862. i = next;
  863. }
  864. if (path.empty()) { path = "/"; }
  865. return path + merged.substr(path_end);
  866. }
  867. } // namespace detail
  868. enum class SSLVerifierResponse {
  869. // no decision has been made, use the built-in certificate verifier
  870. NoDecisionMade,
  871. // connection certificate is verified and accepted
  872. CertificateAccepted,
  873. // connection certificate was processed but is rejected
  874. CertificateRejected
  875. };
  876. // System CA loading policy for SSL clients. Auto (the default) loads system
  877. // CA certs only when no custom CA is configured; enable_system_ca() switches
  878. // to an explicit policy.
  879. enum class SystemCAMode { Auto, Enabled, Disabled };
  880. enum StatusCode {
  881. // Information responses
  882. Continue_100 = 100,
  883. SwitchingProtocol_101 = 101,
  884. Processing_102 = 102,
  885. EarlyHints_103 = 103,
  886. // Successful responses
  887. OK_200 = 200,
  888. Created_201 = 201,
  889. Accepted_202 = 202,
  890. NonAuthoritativeInformation_203 = 203,
  891. NoContent_204 = 204,
  892. ResetContent_205 = 205,
  893. PartialContent_206 = 206,
  894. MultiStatus_207 = 207,
  895. AlreadyReported_208 = 208,
  896. IMUsed_226 = 226,
  897. // Redirection messages
  898. MultipleChoices_300 = 300,
  899. MovedPermanently_301 = 301,
  900. Found_302 = 302,
  901. SeeOther_303 = 303,
  902. NotModified_304 = 304,
  903. UseProxy_305 = 305,
  904. unused_306 = 306,
  905. TemporaryRedirect_307 = 307,
  906. PermanentRedirect_308 = 308,
  907. // Client error responses
  908. BadRequest_400 = 400,
  909. Unauthorized_401 = 401,
  910. PaymentRequired_402 = 402,
  911. Forbidden_403 = 403,
  912. NotFound_404 = 404,
  913. MethodNotAllowed_405 = 405,
  914. NotAcceptable_406 = 406,
  915. ProxyAuthenticationRequired_407 = 407,
  916. RequestTimeout_408 = 408,
  917. Conflict_409 = 409,
  918. Gone_410 = 410,
  919. LengthRequired_411 = 411,
  920. PreconditionFailed_412 = 412,
  921. PayloadTooLarge_413 = 413,
  922. UriTooLong_414 = 414,
  923. UnsupportedMediaType_415 = 415,
  924. RangeNotSatisfiable_416 = 416,
  925. ExpectationFailed_417 = 417,
  926. ImATeapot_418 = 418,
  927. MisdirectedRequest_421 = 421,
  928. UnprocessableContent_422 = 422,
  929. Locked_423 = 423,
  930. FailedDependency_424 = 424,
  931. TooEarly_425 = 425,
  932. UpgradeRequired_426 = 426,
  933. PreconditionRequired_428 = 428,
  934. TooManyRequests_429 = 429,
  935. RequestHeaderFieldsTooLarge_431 = 431,
  936. UnavailableForLegalReasons_451 = 451,
  937. // Server error responses
  938. InternalServerError_500 = 500,
  939. NotImplemented_501 = 501,
  940. BadGateway_502 = 502,
  941. ServiceUnavailable_503 = 503,
  942. GatewayTimeout_504 = 504,
  943. HttpVersionNotSupported_505 = 505,
  944. VariantAlsoNegotiates_506 = 506,
  945. InsufficientStorage_507 = 507,
  946. LoopDetected_508 = 508,
  947. NotExtended_510 = 510,
  948. NetworkAuthenticationRequired_511 = 511,
  949. };
  950. namespace detail {
  951. // A multimap that keeps its entries in the order they were inserted.
  952. //
  953. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  954. // fields sharing a field name significant and forbids a proxy from reordering
  955. // them, and a query string's parameters are meaningful in the order the caller
  956. // wrote them. Neither standard container expresses it: std::unordered_multimap
  957. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  958. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  959. // key, which would drop control data such as Host behind whatever else the
  960. // message carries and alphabetise a query string.
  961. //
  962. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  963. // scan, which beats hashing for the handful of entries a message carries
  964. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  965. //
  966. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  967. // Params, whose parameter names are case-sensitive, not.
  968. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  969. public:
  970. using key_type = std::string;
  971. using mapped_type = Mapped;
  972. using value_type = std::pair<std::string, Mapped>;
  973. using size_type = std::size_t;
  974. using difference_type = std::ptrdiff_t;
  975. using reference = value_type &;
  976. using const_reference = const value_type &;
  977. private:
  978. static size_type npos() { return static_cast<size_type>(-1); }
  979. static bool keys_equal(const std::string &a, const std::string &b) {
  980. return KeyEqual()(a, b);
  981. }
  982. // Iterating yields every entry in insertion order, but equal_range() and
  983. // find() have to walk only the entries sharing one key, which are not
  984. // adjacent. Both are the same iterator type: key_idx_ selects between the
  985. // two traversals, and since equality compares only the position, an iterator
  986. // restricted to one key still compares equal to end().
  987. template <typename V> class iterator_t {
  988. public:
  989. using iterator_category = std::bidirectional_iterator_tag;
  990. using value_type = insertion_ordered_multimap::value_type;
  991. using difference_type = insertion_ordered_multimap::difference_type;
  992. using pointer = V *;
  993. using reference = V &;
  994. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  995. template <typename U,
  996. typename std::enable_if<std::is_convertible<U *, V *>::value,
  997. int>::type = 0>
  998. iterator_t(const iterator_t<U> &rhs)
  999. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  1000. key_idx_(rhs.key_idx_) {}
  1001. reference operator*() const { return data_[idx_]; }
  1002. pointer operator->() const { return data_ + idx_; }
  1003. iterator_t &operator++() {
  1004. // Saturating, so that advancing past the last entry of a key stays at
  1005. // end() instead of running off the container.
  1006. if (idx_ >= size_) { return *this; }
  1007. ++idx_;
  1008. if (key_idx_ != npos()) {
  1009. while (idx_ < size_ && !matches(idx_)) {
  1010. ++idx_;
  1011. }
  1012. }
  1013. return *this;
  1014. }
  1015. iterator_t operator++(int) {
  1016. auto tmp = *this;
  1017. ++*this;
  1018. return tmp;
  1019. }
  1020. iterator_t &operator--() {
  1021. if (idx_ == 0) { return *this; }
  1022. --idx_;
  1023. if (key_idx_ != npos()) {
  1024. while (idx_ > 0 && !matches(idx_)) {
  1025. --idx_;
  1026. }
  1027. }
  1028. return *this;
  1029. }
  1030. iterator_t operator--(int) {
  1031. auto tmp = *this;
  1032. --*this;
  1033. return tmp;
  1034. }
  1035. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1036. return idx_ == rhs.idx_;
  1037. }
  1038. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1039. return idx_ != rhs.idx_;
  1040. }
  1041. private:
  1042. friend class insertion_ordered_multimap;
  1043. template <typename> friend class iterator_t;
  1044. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1045. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1046. bool matches(size_type i) const {
  1047. return keys_equal(data_[i].first, data_[key_idx_].first);
  1048. }
  1049. V *data_;
  1050. size_type idx_;
  1051. size_type size_;
  1052. size_type key_idx_;
  1053. };
  1054. public:
  1055. using iterator = iterator_t<value_type>;
  1056. using const_iterator = iterator_t<const value_type>;
  1057. insertion_ordered_multimap() = default;
  1058. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1059. : entries_(il) {}
  1060. template <typename InputIt>
  1061. insertion_ordered_multimap(InputIt first, InputIt last)
  1062. : entries_(first, last) {}
  1063. iterator begin() { return make_iter(0, npos()); }
  1064. iterator end() { return make_iter(entries_.size(), npos()); }
  1065. const_iterator begin() const { return make_citer(0, npos()); }
  1066. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1067. const_iterator cbegin() const { return begin(); }
  1068. const_iterator cend() const { return end(); }
  1069. bool empty() const { return entries_.empty(); }
  1070. size_type size() const { return entries_.size(); }
  1071. void clear() { entries_.clear(); }
  1072. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1073. iterator insert(const value_type &val) {
  1074. entries_.push_back(val);
  1075. return make_iter(entries_.size() - 1, npos());
  1076. }
  1077. iterator insert(value_type &&val) {
  1078. entries_.push_back(std::move(val));
  1079. return make_iter(entries_.size() - 1, npos());
  1080. }
  1081. template <typename... Args> iterator emplace(Args &&...args) {
  1082. entries_.emplace_back(std::forward<Args>(args)...);
  1083. return make_iter(entries_.size() - 1, npos());
  1084. }
  1085. // For entries that have to lead the message, such as the Host header field
  1086. // (RFC 9110 5.3 recommends sending control data first).
  1087. template <typename... Args> iterator emplace_front(Args &&...args) {
  1088. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1089. return make_iter(0, npos());
  1090. }
  1091. iterator find(const std::string &key) {
  1092. auto i = index_of(key);
  1093. return i == npos() ? end() : make_iter(i, i);
  1094. }
  1095. const_iterator find(const std::string &key) const {
  1096. auto i = index_of(key);
  1097. return i == npos() ? end() : make_citer(i, i);
  1098. }
  1099. size_type count(const std::string &key) const {
  1100. size_type n = 0;
  1101. for (const auto &entry : entries_) {
  1102. if (keys_equal(entry.first, key)) { n++; }
  1103. }
  1104. return n;
  1105. }
  1106. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1107. auto i = index_of(key);
  1108. return i == npos() ? std::make_pair(end(), end())
  1109. : std::make_pair(make_iter(i, i), end());
  1110. }
  1111. std::pair<const_iterator, const_iterator>
  1112. equal_range(const std::string &key) const {
  1113. auto i = index_of(key);
  1114. return i == npos() ? std::make_pair(end(), end())
  1115. : std::make_pair(make_citer(i, i), end());
  1116. }
  1117. size_type erase(const std::string &key) {
  1118. auto before = entries_.size();
  1119. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1120. [&](const value_type &entry) {
  1121. return keys_equal(entry.first, key);
  1122. }),
  1123. entries_.end());
  1124. return before - entries_.size();
  1125. }
  1126. iterator erase(const_iterator pos) {
  1127. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1128. return make_iter(pos.idx_, npos());
  1129. }
  1130. // Erases what iterating [first, last) would actually visit, so erasing an
  1131. // equal_range() removes only the entries with that key, not everything
  1132. // positioned between them.
  1133. iterator erase(const_iterator first, const_iterator last) {
  1134. auto from = first.idx_;
  1135. auto to = last.idx_;
  1136. if (from >= to) { return make_iter(from, npos()); }
  1137. auto begin_it = entries_.begin();
  1138. auto from_it = begin_it + static_cast<difference_type>(from);
  1139. auto to_it = begin_it + static_cast<difference_type>(to);
  1140. if (first.key_idx_ == npos()) {
  1141. entries_.erase(from_it, to_it);
  1142. } else {
  1143. auto key = entries_[first.key_idx_].first;
  1144. auto keep = from_it;
  1145. for (auto it = from_it; it != to_it; ++it) {
  1146. if (!keys_equal(it->first, key)) {
  1147. if (keep != it) { *keep = std::move(*it); }
  1148. ++keep;
  1149. }
  1150. }
  1151. if (keep != to_it) {
  1152. keep = std::move(to_it, entries_.end(), keep);
  1153. } else {
  1154. keep = entries_.end();
  1155. }
  1156. entries_.erase(keep, entries_.end());
  1157. }
  1158. return make_iter(from, npos());
  1159. }
  1160. friend bool operator==(const insertion_ordered_multimap &lhs,
  1161. const insertion_ordered_multimap &rhs) {
  1162. return lhs.entries_ == rhs.entries_;
  1163. }
  1164. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1165. const insertion_ordered_multimap &rhs) {
  1166. return !(lhs == rhs);
  1167. }
  1168. private:
  1169. size_type index_of(const std::string &key) const {
  1170. for (size_type i = 0; i < entries_.size(); i++) {
  1171. if (keys_equal(entries_[i].first, key)) { return i; }
  1172. }
  1173. return npos();
  1174. }
  1175. iterator make_iter(size_type idx, size_type key_idx) {
  1176. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1177. }
  1178. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1179. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1180. }
  1181. std::vector<value_type> entries_;
  1182. };
  1183. } // namespace detail
  1184. using Headers =
  1185. detail::insertion_ordered_multimap<std::string,
  1186. detail::case_ignore::equal_to>;
  1187. // Query parameter names are case-sensitive, unlike header field names.
  1188. using Params =
  1189. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1190. using Match = std::smatch;
  1191. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1192. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1193. /*
  1194. * detail: type-erased storage used by UserData.
  1195. * ABI-stable regardless of C++ standard — always uses this custom
  1196. * implementation instead of std::any.
  1197. */
  1198. namespace detail {
  1199. using any_type_id = const void *;
  1200. template <typename T> any_type_id any_typeid() noexcept {
  1201. static const char id = 0;
  1202. return &id;
  1203. }
  1204. struct any_storage {
  1205. virtual ~any_storage() = default;
  1206. virtual std::unique_ptr<any_storage> clone() const = 0;
  1207. virtual any_type_id type_id() const noexcept = 0;
  1208. };
  1209. template <typename T> struct any_value final : any_storage {
  1210. T value;
  1211. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1212. std::unique_ptr<any_storage> clone() const override {
  1213. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1214. }
  1215. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1216. };
  1217. } // namespace detail
  1218. class UserData {
  1219. public:
  1220. UserData() = default;
  1221. UserData(UserData &&) noexcept = default;
  1222. UserData &operator=(UserData &&) noexcept = default;
  1223. UserData(const UserData &o) {
  1224. for (const auto &e : o.entries_) {
  1225. if (e.second) { entries_[e.first] = e.second->clone(); }
  1226. }
  1227. }
  1228. UserData &operator=(const UserData &o) {
  1229. if (this != &o) {
  1230. entries_.clear();
  1231. for (const auto &e : o.entries_) {
  1232. if (e.second) { entries_[e.first] = e.second->clone(); }
  1233. }
  1234. }
  1235. return *this;
  1236. }
  1237. template <typename T> void set(const std::string &key, T &&value) {
  1238. using D = typename std::decay<T>::type;
  1239. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1240. }
  1241. template <typename T> T *get(const std::string &key) noexcept {
  1242. auto it = entries_.find(key);
  1243. if (it == entries_.end() || !it->second) { return nullptr; }
  1244. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1245. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1246. }
  1247. template <typename T> const T *get(const std::string &key) const noexcept {
  1248. auto it = entries_.find(key);
  1249. if (it == entries_.end() || !it->second) { return nullptr; }
  1250. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1251. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1252. }
  1253. bool has(const std::string &key) const noexcept {
  1254. return entries_.find(key) != entries_.end();
  1255. }
  1256. void erase(const std::string &key) { entries_.erase(key); }
  1257. void clear() noexcept { entries_.clear(); }
  1258. private:
  1259. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1260. entries_;
  1261. };
  1262. struct Response;
  1263. using ResponseHandler = std::function<bool(const Response &response)>;
  1264. struct FormData {
  1265. std::string name;
  1266. std::string content;
  1267. std::string filename;
  1268. std::string content_type;
  1269. Headers headers;
  1270. };
  1271. struct FormField {
  1272. std::string name;
  1273. std::string content;
  1274. Headers headers;
  1275. };
  1276. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1277. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1278. // should see the parts as they were sent. A std::multimap sorts by field name
  1279. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1280. // than the case-insensitive predicate Headers uses.
  1281. using FormFields =
  1282. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1283. using FormFiles =
  1284. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1285. struct MultipartFormData {
  1286. FormFields fields; // Text fields from multipart
  1287. FormFiles files; // Files from multipart
  1288. // Text field access
  1289. std::string get_field(const std::string &key, size_t id = 0) const;
  1290. std::vector<std::string> get_fields(const std::string &key) const;
  1291. bool has_field(const std::string &key) const;
  1292. size_t get_field_count(const std::string &key) const;
  1293. // File access
  1294. FormData get_file(const std::string &key, size_t id = 0) const;
  1295. std::vector<FormData> get_files(const std::string &key) const;
  1296. bool has_file(const std::string &key) const;
  1297. size_t get_file_count(const std::string &key) const;
  1298. };
  1299. struct UploadFormData {
  1300. std::string name;
  1301. std::string content;
  1302. std::string filename;
  1303. std::string content_type;
  1304. };
  1305. using UploadFormDataItems = std::vector<UploadFormData>;
  1306. class DataSink {
  1307. public:
  1308. DataSink() : os(&sb_), sb_(*this) {}
  1309. DataSink(const DataSink &) = delete;
  1310. DataSink &operator=(const DataSink &) = delete;
  1311. DataSink(DataSink &&) = delete;
  1312. DataSink &operator=(DataSink &&) = delete;
  1313. std::function<bool(const char *data, size_t data_len)> write;
  1314. // Only `write` is mandatory. The rest are defaulted so that a provider
  1315. // calling one on a writer that does not set it gets sensible behaviour
  1316. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1317. // `this` is safe: DataSink is neither copyable nor movable.
  1318. std::function<bool()> is_writable = []() { return true; };
  1319. std::function<void()> done = []() {};
  1320. std::function<void(const Headers &trailer)> done_with_trailer =
  1321. [this](const Headers & /*trailer*/) { done(); };
  1322. std::ostream os;
  1323. private:
  1324. class data_sink_streambuf final : public std::streambuf {
  1325. public:
  1326. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1327. protected:
  1328. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1329. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1330. return 0;
  1331. }
  1332. private:
  1333. DataSink &sink_;
  1334. };
  1335. data_sink_streambuf sb_;
  1336. };
  1337. using ContentProvider =
  1338. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1339. using ContentProviderWithoutLength =
  1340. std::function<bool(size_t offset, DataSink &sink)>;
  1341. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1342. struct FormDataProvider {
  1343. std::string name;
  1344. ContentProviderWithoutLength provider;
  1345. std::string filename;
  1346. std::string content_type;
  1347. };
  1348. using FormDataProviderItems = std::vector<FormDataProvider>;
  1349. inline FormDataProvider
  1350. make_file_provider(const std::string &name, const std::string &filepath,
  1351. const std::string &filename = std::string(),
  1352. const std::string &content_type = std::string()) {
  1353. FormDataProvider fdp;
  1354. fdp.name = name;
  1355. fdp.filename = filename.empty() ? filepath : filename;
  1356. fdp.content_type = content_type;
  1357. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1358. std::ifstream f(filepath, std::ios::binary);
  1359. if (!f) { return false; }
  1360. if (offset > 0) {
  1361. f.seekg(static_cast<std::streamoff>(offset));
  1362. if (!f.good()) {
  1363. sink.done();
  1364. return true;
  1365. }
  1366. }
  1367. char buf[8192];
  1368. f.read(buf, sizeof(buf));
  1369. auto n = static_cast<size_t>(f.gcount());
  1370. if (n > 0) { return sink.write(buf, n); }
  1371. sink.done(); // EOF
  1372. return true;
  1373. };
  1374. return fdp;
  1375. }
  1376. inline std::pair<size_t, ContentProvider>
  1377. make_file_body(const std::string &filepath) {
  1378. size_t size = 0;
  1379. {
  1380. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1381. if (!f) { return {0, ContentProvider{}}; }
  1382. size = static_cast<size_t>(f.tellg());
  1383. }
  1384. ContentProvider provider = [filepath](size_t offset, size_t length,
  1385. DataSink &sink) -> bool {
  1386. std::ifstream f(filepath, std::ios::binary);
  1387. if (!f) { return false; }
  1388. f.seekg(static_cast<std::streamoff>(offset));
  1389. if (!f.good()) { return false; }
  1390. char buf[8192];
  1391. while (length > 0) {
  1392. auto to_read = (std::min)(sizeof(buf), length);
  1393. f.read(buf, static_cast<std::streamsize>(to_read));
  1394. auto n = static_cast<size_t>(f.gcount());
  1395. // The file is shorter than the size make_file_body() measured, which the
  1396. // caller has already committed to as Content-Length. The body cannot be
  1397. // completed, so fail as every other error here does.
  1398. if (n == 0) { return false; }
  1399. if (!sink.write(buf, n)) { return false; }
  1400. length -= n;
  1401. }
  1402. return true;
  1403. };
  1404. return {size, std::move(provider)};
  1405. }
  1406. using ContentReceiverWithProgress = std::function<bool(
  1407. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1408. using ContentReceiver =
  1409. std::function<bool(const char *data, size_t data_length)>;
  1410. using FormDataHeader = std::function<bool(const FormData &file)>;
  1411. class ContentReader {
  1412. public:
  1413. using Reader = std::function<bool(ContentReceiver receiver)>;
  1414. using FormDataReader =
  1415. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1416. ContentReader(Reader reader, FormDataReader multipart_reader)
  1417. : reader_(std::move(reader)),
  1418. formdata_reader_(std::move(multipart_reader)) {}
  1419. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1420. return formdata_reader_(std::move(header), std::move(receiver));
  1421. }
  1422. bool operator()(ContentReceiver receiver) const {
  1423. return reader_(std::move(receiver));
  1424. }
  1425. Reader reader_;
  1426. FormDataReader formdata_reader_;
  1427. };
  1428. using Range = std::pair<ssize_t, ssize_t>;
  1429. using Ranges = std::vector<Range>;
  1430. #ifdef CPPHTTPLIB_SSL_ENABLED
  1431. // TLS abstraction layer - public type definitions and API
  1432. namespace tls {
  1433. // Opaque handles (defined as void* for abstraction)
  1434. using ctx_t = void *;
  1435. using session_t = void *;
  1436. using const_session_t = const void *; // For read-only session access
  1437. using cert_t = void *;
  1438. using ca_store_t = void *;
  1439. // TLS versions
  1440. enum class Version {
  1441. TLS1_2 = 0x0303,
  1442. TLS1_3 = 0x0304,
  1443. };
  1444. // Subject Alternative Names (SAN) entry types
  1445. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1446. // SAN entry structure
  1447. struct SanEntry {
  1448. SanType type;
  1449. std::string value;
  1450. };
  1451. // Verification context for certificate verification callback
  1452. struct VerifyContext {
  1453. session_t session; // TLS session handle
  1454. cert_t cert; // Current certificate being verified
  1455. int depth; // Certificate chain depth (0 = leaf)
  1456. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1457. long error_code; // Backend-specific error code (0 = no error)
  1458. const char *error_string; // Human-readable error description
  1459. // Certificate introspection methods
  1460. std::string subject_cn() const;
  1461. std::string issuer_name() const;
  1462. bool check_hostname(const char *hostname) const;
  1463. std::vector<SanEntry> sans() const;
  1464. bool validity(time_t &not_before, time_t &not_after) const;
  1465. std::string serial() const;
  1466. };
  1467. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1468. // TlsError codes for TLS operations (backend-independent)
  1469. enum class ErrorCode : int {
  1470. Success = 0,
  1471. WantRead, // Non-blocking: need to wait for read
  1472. WantWrite, // Non-blocking: need to wait for write
  1473. PeerClosed, // Peer closed the connection
  1474. Fatal, // Unrecoverable error
  1475. SyscallError, // System call error (check sys_errno)
  1476. CertVerifyFailed, // Certificate verification failed
  1477. HostnameMismatch, // Hostname verification failed
  1478. };
  1479. // TLS error information
  1480. struct TlsError {
  1481. ErrorCode code = ErrorCode::Fatal;
  1482. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1483. int sys_errno = 0; // errno when SyscallError
  1484. // Convert verification error code to human-readable string
  1485. static std::string verify_error_to_string(long error_code);
  1486. };
  1487. // RAII wrapper for peer certificate
  1488. class PeerCert {
  1489. public:
  1490. PeerCert();
  1491. PeerCert(PeerCert &&other) noexcept;
  1492. PeerCert &operator=(PeerCert &&other) noexcept;
  1493. ~PeerCert();
  1494. PeerCert(const PeerCert &) = delete;
  1495. PeerCert &operator=(const PeerCert &) = delete;
  1496. explicit operator bool() const;
  1497. std::string subject_cn() const;
  1498. std::string issuer_name() const;
  1499. bool check_hostname(const char *hostname) const;
  1500. std::vector<SanEntry> sans() const;
  1501. bool validity(time_t &not_before, time_t &not_after) const;
  1502. std::string serial() const;
  1503. private:
  1504. explicit PeerCert(cert_t cert);
  1505. cert_t cert_ = nullptr;
  1506. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1507. };
  1508. // Callback for TLS context setup (used by SSLServer constructor)
  1509. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1510. } // namespace tls
  1511. #endif
  1512. struct Request {
  1513. std::string method;
  1514. std::string path;
  1515. std::string matched_route;
  1516. Params params;
  1517. Headers headers;
  1518. Headers trailers;
  1519. std::string body;
  1520. std::string remote_addr;
  1521. int remote_port = -1;
  1522. std::string local_addr;
  1523. int local_port = -1;
  1524. // for server
  1525. std::string version;
  1526. std::string target;
  1527. MultipartFormData form;
  1528. Ranges ranges;
  1529. Match matches;
  1530. std::unordered_map<std::string, std::string> path_params;
  1531. std::function<bool()> is_connection_closed = []() { return true; };
  1532. // for client
  1533. std::vector<std::string> accept_content_types;
  1534. ResponseHandler response_handler;
  1535. ContentReceiverWithProgress content_receiver;
  1536. DownloadProgress download_progress;
  1537. UploadProgress upload_progress;
  1538. bool has_header(const std::string &key) const;
  1539. std::string get_header_value(const std::string &key, const char *def = "",
  1540. size_t id = 0) const;
  1541. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1542. size_t id = 0) const;
  1543. size_t get_header_value_count(const std::string &key) const;
  1544. void set_header(const std::string &key, const std::string &val);
  1545. bool has_trailer(const std::string &key) const;
  1546. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1547. size_t get_trailer_value_count(const std::string &key) const;
  1548. bool has_param(const std::string &key) const;
  1549. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1550. std::vector<std::string> get_param_values(const std::string &key) const;
  1551. size_t get_param_value_count(const std::string &key) const;
  1552. bool is_multipart_form_data() const;
  1553. // private members...
  1554. bool body_read_started_ = false;
  1555. bool body_consumed_ = false;
  1556. bool expect_100_continue_pending_ = false;
  1557. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1558. size_t content_length_ = 0;
  1559. ContentProvider content_provider_;
  1560. bool is_chunked_content_provider_ = false;
  1561. size_t authorization_count_ = 0;
  1562. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1563. (std::chrono::steady_clock::time_point::min)();
  1564. #ifdef CPPHTTPLIB_SSL_ENABLED
  1565. tls::const_session_t ssl = nullptr;
  1566. tls::PeerCert peer_cert() const;
  1567. std::string sni() const;
  1568. #endif
  1569. };
  1570. namespace detail {
  1571. // Declared up here, away from the rest of the compression helpers, because
  1572. // `Response` stores one.
  1573. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1574. } // namespace detail
  1575. struct Response {
  1576. std::string version;
  1577. int status = -1;
  1578. std::string reason;
  1579. Headers headers;
  1580. Headers trailers;
  1581. std::string body;
  1582. std::string location; // Redirect location
  1583. // User-defined context — set by pre-routing/pre-request handlers and read
  1584. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1585. UserData user_data;
  1586. bool has_header(const std::string &key) const;
  1587. std::string get_header_value(const std::string &key, const char *def = "",
  1588. size_t id = 0) const;
  1589. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1590. size_t id = 0) const;
  1591. size_t get_header_value_count(const std::string &key) const;
  1592. void set_header(const std::string &key, const std::string &val);
  1593. bool has_trailer(const std::string &key) const;
  1594. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1595. size_t get_trailer_value_count(const std::string &key) const;
  1596. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1597. void set_content(const char *s, size_t n, const std::string &content_type);
  1598. void set_content(const std::string &s, const std::string &content_type);
  1599. void set_content(std::string &&s, const std::string &content_type);
  1600. void set_content_provider(
  1601. size_t length, const std::string &content_type, ContentProvider provider,
  1602. ContentProviderResourceReleaser resource_releaser = nullptr);
  1603. void set_content_provider(
  1604. const std::string &content_type, ContentProviderWithoutLength provider,
  1605. ContentProviderResourceReleaser resource_releaser = nullptr);
  1606. void set_chunked_content_provider(
  1607. const std::string &content_type, ContentProviderWithoutLength provider,
  1608. ContentProviderResourceReleaser resource_releaser = nullptr);
  1609. void set_file_content(const std::string &path,
  1610. const std::string &content_type);
  1611. void set_file_content(const std::string &path);
  1612. Response() = default;
  1613. Response(const Response &) = default;
  1614. Response &operator=(const Response &) = default;
  1615. Response(Response &&) = default;
  1616. Response &operator=(Response &&) = default;
  1617. ~Response() {
  1618. if (content_provider_resource_releaser_) {
  1619. content_provider_resource_releaser_(content_provider_success_);
  1620. }
  1621. }
  1622. // private members...
  1623. size_t content_length_ = 0;
  1624. ContentProvider content_provider_;
  1625. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1626. bool is_chunked_content_provider_ = false;
  1627. bool is_file_content_provider_ = false;
  1628. bool content_provider_success_ = false;
  1629. std::string file_content_path_;
  1630. std::string file_content_content_type_;
  1631. // Content coding chosen for the response body, decided once so that the
  1632. // headers and the body cannot disagree: where the file is opened for a
  1633. // file-backed content provider (keeping the ETag honest), and in
  1634. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1635. // for every other kind of response.
  1636. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1637. };
  1638. enum class Error {
  1639. Success = 0,
  1640. Unknown,
  1641. Connection,
  1642. BindIPAddress,
  1643. Read,
  1644. Write,
  1645. ExceedRedirectCount,
  1646. Canceled,
  1647. SSLConnection,
  1648. SSLLoadingCerts,
  1649. SSLServerVerification,
  1650. SSLServerHostnameVerification,
  1651. UnsupportedMultipartBoundaryChars,
  1652. Compression,
  1653. ConnectionTimeout,
  1654. ProxyConnection,
  1655. ConnectionClosed,
  1656. Timeout,
  1657. ResourceExhaustion,
  1658. TooManyFormDataFiles,
  1659. ExceedMaxPayloadSize,
  1660. ExceedUriMaxLength,
  1661. ExceedMaxSocketDescriptorCount,
  1662. InvalidRequestLine,
  1663. InvalidHTTPMethod,
  1664. InvalidHTTPVersion,
  1665. InvalidHeaders,
  1666. MultipartParsing,
  1667. OpenFile,
  1668. Listen,
  1669. GetSockName,
  1670. UnsupportedAddressFamily,
  1671. HTTPParsing,
  1672. InvalidRangeHeader,
  1673. UnsupportedContentEncoding,
  1674. WebSocketHandshake,
  1675. UserCallbackException,
  1676. // For internal use only
  1677. SSLPeerCouldBeClosed_,
  1678. };
  1679. std::string to_string(Error error);
  1680. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1681. class Stream {
  1682. public:
  1683. virtual ~Stream() = default;
  1684. virtual bool is_readable() const = 0;
  1685. virtual bool wait_readable() const = 0;
  1686. virtual bool wait_writable() const = 0;
  1687. virtual bool is_peer_alive() const { return wait_writable(); }
  1688. virtual ssize_t read(char *ptr, size_t size) = 0;
  1689. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1690. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1691. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1692. virtual socket_t socket() const = 0;
  1693. virtual time_t duration() const = 0;
  1694. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1695. (void)sec;
  1696. (void)usec;
  1697. }
  1698. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1699. // each one. 0 lifts the bound.
  1700. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1701. // Bytes already pulled off the socket and sitting in this stream's own
  1702. // buffer. Exposing them lets a line reader scan for a terminator in one
  1703. // pass instead of asking for a byte at a time. A stream that does no
  1704. // buffering of its own reports none, and readers fall back to read().
  1705. virtual const char *buffered_data(size_t &size) const {
  1706. size = 0;
  1707. return nullptr;
  1708. }
  1709. // Discards `size` bytes previously returned by buffered_data().
  1710. virtual void consume_buffered(size_t size) { (void)size; }
  1711. ssize_t write(const char *ptr);
  1712. ssize_t write(const std::string &s);
  1713. Error get_error() const { return error_; }
  1714. protected:
  1715. Error error_ = Error::Success;
  1716. };
  1717. class TaskQueue {
  1718. public:
  1719. TaskQueue() = default;
  1720. virtual ~TaskQueue() = default;
  1721. virtual bool enqueue(std::function<void()> fn) = 0;
  1722. virtual void shutdown() = 0;
  1723. virtual void on_idle() {}
  1724. };
  1725. class ThreadPool final : public TaskQueue {
  1726. public:
  1727. explicit ThreadPool(
  1728. size_t n, size_t max_n = 0, size_t mqr = 0,
  1729. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1730. ThreadPool(const ThreadPool &) = delete;
  1731. ~ThreadPool() override = default;
  1732. bool enqueue(std::function<void()> fn) override;
  1733. void shutdown() override;
  1734. private:
  1735. void worker(bool is_dynamic);
  1736. void move_to_finished(std::thread::id id);
  1737. void cleanup_finished_threads();
  1738. size_t base_thread_count_;
  1739. size_t max_thread_count_;
  1740. size_t max_queued_requests_;
  1741. time_t idle_timeout_sec_;
  1742. size_t idle_thread_count_;
  1743. bool shutdown_;
  1744. std::list<std::function<void()>> jobs_;
  1745. std::vector<std::thread> threads_; // base threads
  1746. std::list<std::thread> dynamic_threads_; // dynamic threads
  1747. std::vector<std::thread>
  1748. finished_threads_; // exited dynamic threads awaiting join
  1749. std::condition_variable cond_;
  1750. std::mutex mutex_;
  1751. };
  1752. using Logger = std::function<void(const Request &, const Response &)>;
  1753. // Forward declaration for Error type
  1754. enum class Error;
  1755. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1756. using SocketOptions = std::function<void(socket_t sock)>;
  1757. void default_socket_options(socket_t sock);
  1758. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1759. const char *status_message(int status);
  1760. std::string to_string(Error error);
  1761. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1762. std::string get_bearer_token_auth(const Request &req);
  1763. namespace detail {
  1764. class MatcherBase {
  1765. public:
  1766. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1767. virtual ~MatcherBase() = default;
  1768. const std::string &pattern() const { return pattern_; }
  1769. // Match request path and populate its matches and
  1770. virtual bool match(Request &request) const = 0;
  1771. private:
  1772. std::string pattern_;
  1773. };
  1774. /**
  1775. * Captures parameters in request path and stores them in Request::path_params
  1776. *
  1777. * Capture name is a substring of a pattern from : to /.
  1778. * The rest of the pattern is matched against the request path directly
  1779. * Parameters are captured starting from the next character after
  1780. * the end of the last matched static pattern fragment until the next /.
  1781. *
  1782. * Example pattern:
  1783. * "/path/fragments/:capture/more/fragments/:second_capture"
  1784. * Static fragments:
  1785. * "/path/fragments/", "more/fragments/"
  1786. *
  1787. * Given the following request path:
  1788. * "/path/fragments/:1/more/fragments/:2"
  1789. * the resulting capture will be
  1790. * {{"capture", "1"}, {"second_capture", "2"}}
  1791. */
  1792. class PathParamsMatcher final : public MatcherBase {
  1793. public:
  1794. PathParamsMatcher(const std::string &pattern);
  1795. bool match(Request &request) const override;
  1796. private:
  1797. // Treat segment separators as the end of path parameter capture
  1798. // Does not need to handle query parameters as they are parsed before path
  1799. // matching
  1800. static constexpr char separator = '/';
  1801. // Contains static path fragments to match against, excluding the '/' after
  1802. // path params
  1803. // Fragments are separated by path params
  1804. std::vector<std::string> static_fragments_;
  1805. // Stores the names of the path parameters to be used as keys in the
  1806. // Request::path_params map
  1807. std::vector<std::string> param_names_;
  1808. };
  1809. /**
  1810. * Performs std::regex_match on request path
  1811. * and stores the result in Request::matches
  1812. *
  1813. * Note that regex match is performed directly on the whole request.
  1814. * This means that wildcard patterns may match multiple path segments with /:
  1815. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1816. */
  1817. class RegexMatcher final : public MatcherBase {
  1818. public:
  1819. RegexMatcher(const std::string &pattern)
  1820. : MatcherBase(pattern), regex_(pattern) {}
  1821. bool match(Request &request) const override;
  1822. private:
  1823. std::regex regex_;
  1824. };
  1825. int close_socket(socket_t sock) noexcept;
  1826. bool is_accept_resource_error();
  1827. bool is_accept_transient_error();
  1828. ssize_t write_headers(Stream &strm, const Headers &headers);
  1829. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1830. time_t usec);
  1831. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1832. const std::string &boundary);
  1833. ContentProvider
  1834. make_multipart_content_provider(const UploadFormDataItems &items,
  1835. const std::string &boundary);
  1836. } // namespace detail
  1837. bool is_valid_multipart_boundary(const std::string &boundary);
  1838. // Serializer for multipart/form-data request bodies. The boundary is owned
  1839. // by the writer so that per-part framing and the final terminator always
  1840. // agree. Field names and filenames are escaped following the WHATWG HTML
  1841. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1842. // in content types.
  1843. class MultipartFormDataWriter {
  1844. public:
  1845. MultipartFormDataWriter();
  1846. // precondition: is_valid_multipart_boundary(boundary)
  1847. explicit MultipartFormDataWriter(std::string boundary);
  1848. const std::string &boundary() const;
  1849. std::string content_type() const;
  1850. // In-memory items -> whole body (known length)
  1851. std::string serialize(const UploadFormDataItems &items) const;
  1852. size_t content_length(const UploadFormDataItems &items) const;
  1853. // Per-part framing for streaming via a content provider
  1854. std::string item_begin(const UploadFormData &item) const;
  1855. static std::string item_end();
  1856. std::string finish() const;
  1857. private:
  1858. std::string boundary_;
  1859. };
  1860. class Server {
  1861. public:
  1862. using Handler = std::function<void(const Request &, Response &)>;
  1863. using ExceptionHandler =
  1864. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1865. enum class HandlerResponse {
  1866. Handled,
  1867. Unhandled,
  1868. };
  1869. using HandlerWithResponse =
  1870. std::function<HandlerResponse(const Request &, Response &)>;
  1871. using HandlerWithContentReader = std::function<void(
  1872. const Request &, Response &, const ContentReader &content_reader)>;
  1873. using Expect100ContinueHandler =
  1874. std::function<int(const Request &, Response &)>;
  1875. using StartHandler = std::function<void()>;
  1876. using WebSocketHandler =
  1877. std::function<void(const Request &, ws::WebSocket &)>;
  1878. using SubProtocolSelector =
  1879. std::function<std::string(const std::vector<std::string> &protocols)>;
  1880. Server();
  1881. virtual ~Server();
  1882. virtual bool is_valid() const;
  1883. Server &Get(const std::string &pattern, Handler handler);
  1884. Server &Post(const std::string &pattern, Handler handler);
  1885. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1886. Server &Put(const std::string &pattern, Handler handler);
  1887. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1888. Server &Patch(const std::string &pattern, Handler handler);
  1889. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1890. Server &Delete(const std::string &pattern, Handler handler);
  1891. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1892. Server &Options(const std::string &pattern, Handler handler);
  1893. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1894. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1895. // server accept it; an unregistered method is still rejected with 400.
  1896. // `method` must be a valid HTTP method token and must not be one of the
  1897. // built-in methods, which have their own registration functions above. A
  1898. // rejected registration makes is_valid() return false, so listen() fails.
  1899. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1900. Handler handler);
  1901. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1902. HandlerWithContentReader handler);
  1903. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1904. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1905. SubProtocolSelector sub_protocol_selector);
  1906. bool set_base_dir(const std::string &dir,
  1907. const std::string &mount_point = std::string());
  1908. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1909. Headers headers = Headers());
  1910. bool remove_mount_point(const std::string &mount_point);
  1911. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1912. const std::string &mime);
  1913. Server &set_default_file_mimetype(const std::string &mime);
  1914. Server &set_file_request_handler(Handler handler);
  1915. template <class ErrorHandlerFunc>
  1916. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1917. return set_error_handler_core(
  1918. std::forward<ErrorHandlerFunc>(handler),
  1919. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1920. }
  1921. Server &set_exception_handler(ExceptionHandler handler);
  1922. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1923. Server &set_post_routing_handler(Handler handler);
  1924. Server &set_pre_request_handler(HandlerWithResponse handler);
  1925. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1926. Server &set_start_handler(StartHandler handler);
  1927. Server &set_logger(Logger logger);
  1928. Server &set_pre_compression_logger(Logger logger);
  1929. Server &set_error_logger(ErrorLogger error_logger);
  1930. Server &set_address_family(int family);
  1931. Server &set_tcp_nodelay(bool on);
  1932. Server &set_ipv6_v6only(bool on);
  1933. Server &set_socket_options(SocketOptions socket_options);
  1934. Server &set_default_headers(Headers headers);
  1935. Server &
  1936. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1937. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1938. Server &set_keep_alive_max_count(size_t count);
  1939. Server &set_keep_alive_timeout(time_t sec);
  1940. template <class Rep, class Period>
  1941. Server &
  1942. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1943. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1944. template <class Rep, class Period>
  1945. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1946. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1947. template <class Rep, class Period>
  1948. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1949. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1950. template <class Rep, class Period>
  1951. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1952. Server &set_payload_max_length(size_t length);
  1953. Server &set_static_file_compression(bool on);
  1954. Server &set_static_file_compression_min_length(size_t length);
  1955. Server &set_static_file_compression_max_length(size_t length);
  1956. Server &set_websocket_ping_interval(time_t sec);
  1957. template <class Rep, class Period>
  1958. Server &set_websocket_ping_interval(
  1959. const std::chrono::duration<Rep, Period> &duration);
  1960. Server &set_websocket_max_missed_pongs(int count);
  1961. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1962. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1963. bool listen_after_bind();
  1964. bool listen(const std::string &host, int port, int socket_flags = 0);
  1965. bool is_running() const;
  1966. void wait_until_ready() const;
  1967. void stop() noexcept;
  1968. void decommission();
  1969. std::function<TaskQueue *(void)> new_task_queue;
  1970. protected:
  1971. bool process_request(Stream &strm, const std::string &remote_addr,
  1972. int remote_port, const std::string &local_addr,
  1973. int local_port, bool close_connection,
  1974. bool &connection_closed,
  1975. const std::function<void(Request &)> &setup_request,
  1976. bool *websocket_upgraded = nullptr);
  1977. // Runs the per-connection serving loop and stops an exception thrown by a
  1978. // user callback from escaping the worker thread.
  1979. //
  1980. // process_request() wraps only routing() in a try/catch. Content providers,
  1981. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1982. // handlers all run outside it, and the task queue calls the job without a
  1983. // catch, so an exception from any of those would terminate the process.
  1984. //
  1985. // No 500 is possible here: by the time a content provider runs, the status
  1986. // line and headers are already on the wire. Report it through the error
  1987. // logger and drop the connection, which is what the peer observes either
  1988. // way. Other connections are unaffected.
  1989. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1990. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1991. return serve();
  1992. #else
  1993. try {
  1994. return serve();
  1995. } catch (...) {
  1996. // The error logger is a user callback too, so it must not be able to
  1997. // throw the guard back open.
  1998. try {
  1999. output_error_log(Error::UserCallbackException, nullptr);
  2000. } catch (...) {}
  2001. return false;
  2002. }
  2003. #endif
  2004. }
  2005. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2006. std::vector<std::string> trusted_proxies_;
  2007. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2008. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2009. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2010. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2011. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2012. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2013. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2014. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2015. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2016. bool static_file_compression_ = false;
  2017. size_t static_file_compression_min_length_ =
  2018. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2019. size_t static_file_compression_max_length_ =
  2020. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2021. time_t websocket_ping_interval_sec_ =
  2022. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2023. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2024. private:
  2025. using Handlers =
  2026. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2027. using HandlersForContentReader =
  2028. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2029. HandlerWithContentReader>>;
  2030. // Both handler tables for one custom method live in a single entry, so that
  2031. // routing() needs only one map lookup per request to reach either of them.
  2032. struct CustomHandlerEntry {
  2033. Handlers handlers;
  2034. HandlersForContentReader handlers_for_content_reader;
  2035. };
  2036. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2037. static std::unique_ptr<detail::MatcherBase>
  2038. make_matcher(const std::string &pattern);
  2039. static const std::set<std::string> &builtin_methods();
  2040. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2041. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2042. template <typename H>
  2043. Server &add_handler(
  2044. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2045. const std::string &pattern, H handler) {
  2046. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2047. return *this;
  2048. }
  2049. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2050. Server &set_error_handler_core(Handler handler, std::false_type);
  2051. socket_t create_server_socket(const std::string &host, int port,
  2052. int socket_flags,
  2053. SocketOptions socket_options) const;
  2054. int bind_internal(const std::string &host, int port, int socket_flags);
  2055. bool listen_internal();
  2056. bool routing(Request &req, Response &res, Stream &strm);
  2057. bool handle_file_request(Request &req, Response &res);
  2058. bool check_if_not_modified(const Request &req, Response &res,
  2059. const std::string &etag, time_t mtime) const;
  2060. bool check_if_range(Request &req, const std::string &etag,
  2061. time_t mtime) const;
  2062. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2063. Stream &strm);
  2064. bool dispatch_request_for_content_reader(
  2065. Request &req, Response &res, ContentReader content_reader,
  2066. const HandlersForContentReader &handlers) const;
  2067. bool parse_request_line(const char *s, Request &req) const;
  2068. detail::EncodingType static_file_encoding(const Request &req,
  2069. const Response &res,
  2070. const std::string &content_type,
  2071. size_t length) const;
  2072. bool apply_static_file_compression(const Request &req, Response &res) const;
  2073. void apply_ranges(const Request &req, Response &res,
  2074. std::string &content_type, std::string &boundary) const;
  2075. bool write_response(Stream &strm, bool close_connection, Request &req,
  2076. Response &res);
  2077. bool write_response_with_content(Stream &strm, bool close_connection,
  2078. const Request &req, Response &res);
  2079. bool write_response_core(Stream &strm, bool close_connection,
  2080. const Request &req, Response &res,
  2081. bool need_apply_ranges);
  2082. bool write_content_with_provider(Stream &strm, const Request &req,
  2083. Response &res, const std::string &boundary,
  2084. const std::string &content_type);
  2085. bool read_content(Stream &strm, Request &req, Response &res);
  2086. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2087. Response &res,
  2088. ContentReceiver receiver,
  2089. FormDataHeader multipart_header,
  2090. ContentReceiver multipart_receiver);
  2091. bool read_content_core(Stream &strm, Request &req, Response &res,
  2092. ContentReceiver receiver,
  2093. FormDataHeader multipart_header,
  2094. ContentReceiver multipart_receiver) const;
  2095. virtual bool process_and_close_socket(socket_t sock);
  2096. void output_log(const Request &req, const Response &res) const;
  2097. void output_pre_compression_log(const Request &req,
  2098. const Response &res) const;
  2099. void output_error_log(const Error &err, const Request *req) const;
  2100. std::atomic<bool> is_running_{false};
  2101. std::atomic<bool> is_decommissioned{false};
  2102. // Set when CustomRoute() refuses a registration. Written before listen(),
  2103. // read by is_valid() on the same thread, so it needs no synchronization.
  2104. bool has_invalid_registration_ = false;
  2105. struct MountPointEntry {
  2106. std::string mount_point;
  2107. std::string base_dir;
  2108. std::string resolved_base_dir;
  2109. Headers headers;
  2110. };
  2111. std::vector<MountPointEntry> base_dirs_;
  2112. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2113. std::string default_file_mimetype_ = "application/octet-stream";
  2114. Handler file_request_handler_;
  2115. Handlers get_handlers_;
  2116. Handlers post_handlers_;
  2117. HandlersForContentReader post_handlers_for_content_reader_;
  2118. Handlers put_handlers_;
  2119. HandlersForContentReader put_handlers_for_content_reader_;
  2120. Handlers patch_handlers_;
  2121. HandlersForContentReader patch_handlers_for_content_reader_;
  2122. Handlers delete_handlers_;
  2123. HandlersForContentReader delete_handlers_for_content_reader_;
  2124. Handlers options_handlers_;
  2125. CustomHandlers custom_handlers_;
  2126. struct WebSocketHandlerEntry {
  2127. std::unique_ptr<detail::MatcherBase> matcher;
  2128. WebSocketHandler handler;
  2129. SubProtocolSelector sub_protocol_selector;
  2130. };
  2131. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2132. WebSocketHandlers websocket_handlers_;
  2133. HandlerWithResponse error_handler_;
  2134. ExceptionHandler exception_handler_;
  2135. HandlerWithResponse pre_routing_handler_;
  2136. Handler post_routing_handler_;
  2137. HandlerWithResponse pre_request_handler_;
  2138. Expect100ContinueHandler expect_100_continue_handler_;
  2139. StartHandler start_handler_;
  2140. mutable std::mutex logger_mutex_;
  2141. Logger logger_;
  2142. Logger pre_compression_logger_;
  2143. ErrorLogger error_logger_;
  2144. int address_family_ = AF_UNSPEC;
  2145. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2146. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2147. SocketOptions socket_options_ = default_socket_options;
  2148. Headers default_headers_;
  2149. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2150. detail::write_headers;
  2151. };
  2152. class Result {
  2153. public:
  2154. Result() = default;
  2155. Result(std::unique_ptr<Response> &&res, Error err,
  2156. Headers &&request_headers = Headers{})
  2157. : res_(std::move(res)), err_(err),
  2158. request_headers_(std::move(request_headers)) {}
  2159. // Response
  2160. operator bool() const { return res_ != nullptr; }
  2161. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2162. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2163. const Response &value() const { return *res_; }
  2164. Response &value() { return *res_; }
  2165. const Response &operator*() const { return *res_; }
  2166. Response &operator*() { return *res_; }
  2167. const Response *operator->() const { return res_.get(); }
  2168. Response *operator->() { return res_.get(); }
  2169. // Error
  2170. Error error() const { return err_; }
  2171. // Request Headers
  2172. bool has_request_header(const std::string &key) const;
  2173. std::string get_request_header_value(const std::string &key,
  2174. const char *def = "",
  2175. size_t id = 0) const;
  2176. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2177. size_t id = 0) const;
  2178. size_t get_request_header_value_count(const std::string &key) const;
  2179. private:
  2180. std::unique_ptr<Response> res_;
  2181. Error err_ = Error::Unknown;
  2182. Headers request_headers_;
  2183. #ifdef CPPHTTPLIB_SSL_ENABLED
  2184. public:
  2185. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2186. int ssl_error)
  2187. : res_(std::move(res)), err_(err),
  2188. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2189. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2190. int ssl_error, uint64_t ssl_backend_error)
  2191. : res_(std::move(res)), err_(err),
  2192. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2193. ssl_backend_error_(ssl_backend_error) {}
  2194. int ssl_error() const { return ssl_error_; }
  2195. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2196. private:
  2197. int ssl_error_ = 0;
  2198. uint64_t ssl_backend_error_ = 0;
  2199. #endif
  2200. };
  2201. struct ClientConnection {
  2202. socket_t sock = INVALID_SOCKET;
  2203. bool is_open() const { return sock != INVALID_SOCKET; }
  2204. ClientConnection() = default;
  2205. ~ClientConnection();
  2206. ClientConnection(const ClientConnection &) = delete;
  2207. ClientConnection &operator=(const ClientConnection &) = delete;
  2208. ClientConnection(ClientConnection &&other) noexcept
  2209. : sock(other.sock)
  2210. #ifdef CPPHTTPLIB_SSL_ENABLED
  2211. ,
  2212. session(other.session)
  2213. #endif
  2214. {
  2215. other.sock = INVALID_SOCKET;
  2216. #ifdef CPPHTTPLIB_SSL_ENABLED
  2217. other.session = nullptr;
  2218. #endif
  2219. }
  2220. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2221. if (this != &other) {
  2222. sock = other.sock;
  2223. other.sock = INVALID_SOCKET;
  2224. #ifdef CPPHTTPLIB_SSL_ENABLED
  2225. session = other.session;
  2226. other.session = nullptr;
  2227. #endif
  2228. }
  2229. return *this;
  2230. }
  2231. #ifdef CPPHTTPLIB_SSL_ENABLED
  2232. tls::session_t session = nullptr;
  2233. #endif
  2234. };
  2235. namespace detail {
  2236. struct ChunkedDecoder;
  2237. struct BodyReader {
  2238. Stream *stream = nullptr;
  2239. bool has_content_length = false;
  2240. size_t content_length = 0;
  2241. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2242. size_t bytes_read = 0;
  2243. bool chunked = false;
  2244. bool eof = false;
  2245. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2246. Error last_error = Error::Success;
  2247. ssize_t read(char *buf, size_t len);
  2248. bool has_error() const { return last_error != Error::Success; }
  2249. };
  2250. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2251. size_t len) {
  2252. (void)stream;
  2253. return br.read(buf, len);
  2254. }
  2255. class decompressor;
  2256. enum class NoProxyKind {
  2257. Wildcard, // "*"
  2258. HostnameSuffix, // "example.com" or ".example.com"
  2259. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2260. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2261. };
  2262. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2263. // Lets one CIDR matcher cover both families.
  2264. using IPBytes = std::array<uint8_t, 16>;
  2265. struct NoProxyEntry {
  2266. NoProxyKind kind = NoProxyKind::Wildcard;
  2267. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2268. IPBytes net{};
  2269. int prefix_bits = 0;
  2270. };
  2271. struct NormalizedTarget {
  2272. std::string hostname; // lowercase; brackets and trailing dot removed
  2273. bool is_ipv4 = false;
  2274. bool is_ipv6 = false;
  2275. IPBytes ip{};
  2276. };
  2277. } // namespace detail
  2278. class ClientImpl {
  2279. public:
  2280. explicit ClientImpl(const std::string &host);
  2281. explicit ClientImpl(const std::string &host, int port);
  2282. explicit ClientImpl(const std::string &host, int port,
  2283. const std::string &client_cert_path,
  2284. const std::string &client_key_path);
  2285. virtual ~ClientImpl();
  2286. virtual bool is_valid() const;
  2287. struct StreamHandle {
  2288. std::unique_ptr<Response> response;
  2289. Error error = Error::Success;
  2290. StreamHandle() = default;
  2291. StreamHandle(const StreamHandle &) = delete;
  2292. StreamHandle &operator=(const StreamHandle &) = delete;
  2293. StreamHandle(StreamHandle &&) = default;
  2294. StreamHandle &operator=(StreamHandle &&) = default;
  2295. ~StreamHandle() = default;
  2296. bool is_valid() const {
  2297. return response != nullptr && error == Error::Success;
  2298. }
  2299. ssize_t read(char *buf, size_t len);
  2300. void parse_trailers_if_needed();
  2301. Error get_read_error() const { return body_reader_.last_error; }
  2302. bool has_read_error() const { return body_reader_.has_error(); }
  2303. bool trailers_parsed_ = false;
  2304. private:
  2305. friend class ClientImpl;
  2306. friend class sse::SSEClient;
  2307. ssize_t read_with_decompression(char *buf, size_t len);
  2308. std::unique_ptr<ClientConnection> connection_;
  2309. std::unique_ptr<Stream> socket_stream_;
  2310. Stream *stream_ = nullptr;
  2311. detail::BodyReader body_reader_;
  2312. std::unique_ptr<detail::decompressor> decompressor_;
  2313. std::string decompress_buffer_;
  2314. size_t decompress_offset_ = 0;
  2315. size_t decompressed_bytes_read_ = 0;
  2316. };
  2317. // clang-format off
  2318. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2319. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2320. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2321. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2322. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2323. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2324. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2325. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2326. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2327. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2328. Result Head(const std::string &path);
  2329. Result Head(const std::string &path, const Headers &headers);
  2330. Result Post(const std::string &path);
  2331. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2332. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2333. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2334. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2335. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2336. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2337. Result Post(const std::string &path, const Params &params);
  2338. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2339. Result Post(const std::string &path, const Headers &headers);
  2340. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2341. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2342. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2343. 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);
  2344. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2345. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2346. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2347. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2348. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2349. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2350. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2351. Result Put(const std::string &path);
  2352. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2353. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2354. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2355. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2356. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2357. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2358. Result Put(const std::string &path, const Params &params);
  2359. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2360. Result Put(const std::string &path, const Headers &headers);
  2361. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2362. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2363. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2364. 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);
  2365. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2366. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2367. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2368. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2369. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2370. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2371. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2372. Result Patch(const std::string &path);
  2373. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2374. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2375. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2376. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2377. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2378. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2379. Result Patch(const std::string &path, const Params &params);
  2380. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2381. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2382. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2383. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2384. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2385. 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);
  2386. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2387. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2388. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2389. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2390. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2391. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2392. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2393. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2394. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2395. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2396. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2397. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2398. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2399. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2400. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2401. Result Options(const std::string &path);
  2402. Result Options(const std::string &path, const Headers &headers);
  2403. // clang-format on
  2404. // Streaming API: Open a stream for reading response body incrementally
  2405. // Socket ownership is transferred to StreamHandle for true streaming
  2406. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2407. StreamHandle open_stream(const std::string &method, const std::string &path,
  2408. const Params &params = {},
  2409. const Headers &headers = {},
  2410. const std::string &body = {},
  2411. const std::string &content_type = {});
  2412. bool send(Request &req, Response &res, Error &error);
  2413. Result send(const Request &req);
  2414. void stop();
  2415. std::string host() const;
  2416. int port() const;
  2417. size_t is_socket_open() const;
  2418. socket_t socket() const;
  2419. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2420. void set_default_headers(Headers headers);
  2421. void
  2422. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2423. void set_address_family(int family);
  2424. void set_tcp_nodelay(bool on);
  2425. void set_ipv6_v6only(bool on);
  2426. void set_socket_options(SocketOptions socket_options);
  2427. void set_connection_timeout(time_t sec, time_t usec = 0);
  2428. template <class Rep, class Period>
  2429. void
  2430. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2431. void set_read_timeout(time_t sec, time_t usec = 0);
  2432. template <class Rep, class Period>
  2433. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2434. void set_write_timeout(time_t sec, time_t usec = 0);
  2435. template <class Rep, class Period>
  2436. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2437. void set_max_timeout(time_t msec);
  2438. template <class Rep, class Period>
  2439. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2440. void set_basic_auth(const std::string &username, const std::string &password);
  2441. void set_bearer_token_auth(const std::string &token);
  2442. void set_keep_alive(bool on);
  2443. void set_follow_location(bool on);
  2444. void set_path_encode(bool on);
  2445. void set_compress(bool on);
  2446. void set_decompress(bool on);
  2447. void set_payload_max_length(size_t length);
  2448. void set_interface(const std::string &intf);
  2449. void set_proxy(const std::string &host, int port);
  2450. void set_proxy_basic_auth(const std::string &username,
  2451. const std::string &password);
  2452. void set_proxy_bearer_token_auth(const std::string &token);
  2453. void set_no_proxy(const std::vector<std::string> &patterns);
  2454. void set_logger(Logger logger);
  2455. void set_error_logger(ErrorLogger error_logger);
  2456. protected:
  2457. struct Socket {
  2458. socket_t sock = INVALID_SOCKET;
  2459. // For Mbed TLS compatibility: start_time for request timeout tracking
  2460. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2461. bool is_open() const { return sock != INVALID_SOCKET; }
  2462. #ifdef CPPHTTPLIB_SSL_ENABLED
  2463. tls::session_t ssl = nullptr;
  2464. #endif
  2465. };
  2466. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2467. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2468. virtual bool setup_proxy_connection(
  2469. Socket &socket,
  2470. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2471. Response &res, bool &success, Error &error);
  2472. bool is_proxy_enabled_for_host(const std::string &host) const;
  2473. // All of:
  2474. // shutdown_ssl
  2475. // shutdown_socket
  2476. // close_socket
  2477. // disconnect
  2478. // should ONLY be called when socket_mutex_ is locked, and only when
  2479. // no other thread is using the socket.
  2480. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2481. void shutdown_socket(Socket &socket) const;
  2482. void close_socket(Socket &socket);
  2483. void disconnect(bool gracefully);
  2484. std::string make_request_target(const Request &req) const;
  2485. bool process_request(Stream &strm, Request &req, Response &res,
  2486. bool close_connection, Error &error);
  2487. bool write_content_with_provider(Stream &strm, const Request &req,
  2488. Error &error) const;
  2489. void output_log(const Request &req, const Response &res) const;
  2490. void output_error_log(const Error &err, const Request *req) const;
  2491. // Socket endpoint information
  2492. const std::string host_;
  2493. const int port_;
  2494. // Current open socket
  2495. Socket socket_;
  2496. mutable std::mutex socket_mutex_;
  2497. std::recursive_mutex request_mutex_;
  2498. // These are all protected under socket_mutex
  2499. size_t socket_requests_in_flight_ = 0;
  2500. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2501. bool socket_should_be_closed_when_request_is_done_ = false;
  2502. // Hostname to connection target map. The value is an IP literal or another
  2503. // hostname; only the connection target changes, never the identity.
  2504. std::map<std::string, std::string> addr_map_;
  2505. // Default headers
  2506. Headers default_headers_;
  2507. // Header writer
  2508. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2509. detail::write_headers;
  2510. // Settings
  2511. std::string client_cert_path_;
  2512. std::string client_key_path_;
  2513. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2514. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2515. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2516. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2517. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2518. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2519. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2520. std::string basic_auth_username_;
  2521. std::string basic_auth_password_;
  2522. std::string bearer_token_auth_token_;
  2523. bool keep_alive_ = false;
  2524. bool follow_location_ = false;
  2525. bool path_encode_ = true;
  2526. int address_family_ = AF_UNSPEC;
  2527. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2528. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2529. SocketOptions socket_options_ = nullptr;
  2530. bool compress_ = false;
  2531. bool decompress_ = true;
  2532. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2533. bool has_payload_max_length_ = false;
  2534. std::string interface_;
  2535. std::string proxy_host_;
  2536. int proxy_port_ = -1;
  2537. std::string proxy_basic_auth_username_;
  2538. std::string proxy_basic_auth_password_;
  2539. std::string proxy_bearer_token_auth_token_;
  2540. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2541. mutable detail::NormalizedTarget host_normalized_;
  2542. mutable bool host_normalized_valid_ = false;
  2543. mutable std::mutex logger_mutex_;
  2544. Logger logger_;
  2545. ErrorLogger error_logger_;
  2546. private:
  2547. bool send_(Request &req, Response &res, Error &error);
  2548. Result send_(Request &&req);
  2549. socket_t create_client_socket(Error &error) const;
  2550. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2551. bool skip_100_continue = true) const;
  2552. bool write_request(Stream &strm, Request &req, bool close_connection,
  2553. Error &error, bool skip_body, bool &rejected_locally);
  2554. bool write_request_body(Stream &strm, Request &req, Error &error);
  2555. void prepare_default_headers(Request &r, bool for_stream,
  2556. const std::string &ct);
  2557. bool redirect(Request &req, Response &res, Error &error);
  2558. bool create_redirect_client(const std::string &scheme,
  2559. const std::string &host, int port, Request &req,
  2560. Response &res, const std::string &path,
  2561. const std::string &location, Error &error);
  2562. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2563. bool handle_request(Stream &strm, Request &req, Response &res,
  2564. bool close_connection, Error &error);
  2565. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2566. Request &req, const char *body, size_t content_length,
  2567. ContentProvider content_provider,
  2568. ContentProviderWithoutLength content_provider_without_length,
  2569. const std::string &content_type, ContentReceiver content_receiver,
  2570. Error &error);
  2571. Result send_with_content_provider_and_receiver(
  2572. const std::string &method, const std::string &path,
  2573. const Headers &headers, const char *body, size_t content_length,
  2574. ContentProvider content_provider,
  2575. ContentProviderWithoutLength content_provider_without_length,
  2576. const std::string &content_type, ContentReceiver content_receiver,
  2577. UploadProgress progress);
  2578. ContentProviderWithoutLength get_multipart_content_provider(
  2579. const std::string &boundary, const UploadFormDataItems &items,
  2580. const FormDataProviderItems &provider_items) const;
  2581. virtual bool
  2582. process_socket(const Socket &socket,
  2583. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2584. std::function<bool(Stream &strm)> callback);
  2585. virtual bool is_ssl() const;
  2586. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2587. #ifdef CPPHTTPLIB_SSL_ENABLED
  2588. public:
  2589. void set_digest_auth(const std::string &username,
  2590. const std::string &password);
  2591. void set_proxy_digest_auth(const std::string &username,
  2592. const std::string &password);
  2593. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2594. const std::string &ca_cert_dir_path = std::string());
  2595. void enable_server_certificate_verification(bool enabled);
  2596. void enable_server_hostname_verification(bool enabled);
  2597. void enable_system_ca(bool enabled);
  2598. protected:
  2599. std::string digest_auth_username_;
  2600. std::string digest_auth_password_;
  2601. std::string proxy_digest_auth_username_;
  2602. std::string proxy_digest_auth_password_;
  2603. std::string ca_cert_file_path_;
  2604. std::string ca_cert_dir_path_;
  2605. bool server_certificate_verification_ = true;
  2606. bool server_hostname_verification_ = true;
  2607. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2608. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2609. int last_ssl_error_ = 0;
  2610. uint64_t last_backend_error_ = 0;
  2611. #endif
  2612. };
  2613. namespace detail {
  2614. // Stands in for a client that Client could not make from its arguments, so a
  2615. // request fails rather than going through a null pointer.
  2616. class InvalidClientImpl final : public ClientImpl {
  2617. public:
  2618. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2619. bool is_valid() const override { return false; }
  2620. private:
  2621. bool create_and_connect_socket(Socket &, Error &error) override {
  2622. error = Error::Connection;
  2623. return false;
  2624. }
  2625. };
  2626. } // namespace detail
  2627. class Client {
  2628. public:
  2629. // Universal interface
  2630. explicit Client(const std::string &scheme_host_port);
  2631. explicit Client(const std::string &scheme_host_port,
  2632. const std::string &client_cert_path,
  2633. const std::string &client_key_path);
  2634. // HTTP only interface
  2635. explicit Client(const std::string &host, int port);
  2636. explicit Client(const std::string &host, int port,
  2637. const std::string &client_cert_path,
  2638. const std::string &client_key_path);
  2639. Client(Client &&) = default;
  2640. Client &operator=(Client &&) = default;
  2641. ~Client();
  2642. bool is_valid() const;
  2643. // clang-format off
  2644. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2645. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2646. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2647. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2648. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2649. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2650. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2651. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2652. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2653. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2654. Result Head(const std::string &path);
  2655. Result Head(const std::string &path, const Headers &headers);
  2656. Result Post(const std::string &path);
  2657. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2658. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2659. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2660. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2661. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2662. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2663. Result Post(const std::string &path, const Params &params);
  2664. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2665. Result Post(const std::string &path, const Headers &headers);
  2666. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2667. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2668. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2669. 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);
  2670. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2671. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2672. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2673. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2674. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2675. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2676. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2677. Result Put(const std::string &path);
  2678. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2679. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2680. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2681. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2682. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2683. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2684. Result Put(const std::string &path, const Params &params);
  2685. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2686. Result Put(const std::string &path, const Headers &headers);
  2687. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2688. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2689. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2690. 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);
  2691. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2692. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2693. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2694. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2695. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2696. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2697. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2698. Result Patch(const std::string &path);
  2699. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2700. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2701. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2702. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2703. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2704. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2705. Result Patch(const std::string &path, const Params &params);
  2706. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2707. Result Patch(const std::string &path, const Headers &headers);
  2708. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2709. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2710. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2711. 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);
  2712. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2713. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2714. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2715. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2716. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2717. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2718. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2719. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2720. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2721. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2722. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2723. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2724. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2725. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2726. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2727. Result Options(const std::string &path);
  2728. Result Options(const std::string &path, const Headers &headers);
  2729. // clang-format on
  2730. // Streaming API: Open a stream for reading response body incrementally
  2731. // Socket ownership is transferred to StreamHandle for true streaming
  2732. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2733. ClientImpl::StreamHandle open_stream(const std::string &method,
  2734. const std::string &path,
  2735. const Params &params = {},
  2736. const Headers &headers = {},
  2737. const std::string &body = {},
  2738. const std::string &content_type = {});
  2739. bool send(Request &req, Response &res, Error &error);
  2740. Result send(const Request &req);
  2741. void stop();
  2742. std::string host() const;
  2743. int port() const;
  2744. size_t is_socket_open() const;
  2745. socket_t socket() const;
  2746. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2747. void set_default_headers(Headers headers);
  2748. void
  2749. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2750. void set_address_family(int family);
  2751. void set_tcp_nodelay(bool on);
  2752. void set_socket_options(SocketOptions socket_options);
  2753. void set_connection_timeout(time_t sec, time_t usec = 0);
  2754. template <class Rep, class Period>
  2755. void
  2756. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2757. void set_read_timeout(time_t sec, time_t usec = 0);
  2758. template <class Rep, class Period>
  2759. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2760. void set_write_timeout(time_t sec, time_t usec = 0);
  2761. template <class Rep, class Period>
  2762. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2763. void set_max_timeout(time_t msec);
  2764. template <class Rep, class Period>
  2765. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2766. void set_basic_auth(const std::string &username, const std::string &password);
  2767. void set_bearer_token_auth(const std::string &token);
  2768. void set_keep_alive(bool on);
  2769. void set_follow_location(bool on);
  2770. void set_path_encode(bool on);
  2771. void set_compress(bool on);
  2772. void set_decompress(bool on);
  2773. void set_payload_max_length(size_t length);
  2774. void set_interface(const std::string &intf);
  2775. void set_proxy(const std::string &host, int port);
  2776. void set_proxy_basic_auth(const std::string &username,
  2777. const std::string &password);
  2778. void set_proxy_bearer_token_auth(const std::string &token);
  2779. void set_no_proxy(const std::vector<std::string> &patterns);
  2780. void set_logger(Logger logger);
  2781. void set_error_logger(ErrorLogger error_logger);
  2782. private:
  2783. std::unique_ptr<ClientImpl> cli_;
  2784. #ifdef CPPHTTPLIB_SSL_ENABLED
  2785. public:
  2786. void set_digest_auth(const std::string &username,
  2787. const std::string &password);
  2788. void set_proxy_digest_auth(const std::string &username,
  2789. const std::string &password);
  2790. void enable_server_certificate_verification(bool enabled);
  2791. void enable_server_hostname_verification(bool enabled);
  2792. void enable_system_ca(bool enabled);
  2793. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2794. const std::string &ca_cert_dir_path = std::string());
  2795. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2796. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2797. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2798. void set_session_verifier(
  2799. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2800. tls::ctx_t tls_context() const;
  2801. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2802. void enable_windows_certificate_verification(bool enabled);
  2803. #endif
  2804. private:
  2805. bool is_ssl_ = false;
  2806. #endif
  2807. };
  2808. #ifdef CPPHTTPLIB_SSL_ENABLED
  2809. class SSLServer : public Server {
  2810. public:
  2811. SSLServer(const char *cert_path, const char *private_key_path,
  2812. const char *client_ca_cert_file_path = nullptr,
  2813. const char *client_ca_cert_dir_path = nullptr,
  2814. const char *private_key_password = nullptr);
  2815. struct PemMemory {
  2816. const char *cert_pem;
  2817. size_t cert_pem_len;
  2818. const char *key_pem;
  2819. size_t key_pem_len;
  2820. const char *client_ca_pem;
  2821. size_t client_ca_pem_len;
  2822. const char *private_key_password;
  2823. };
  2824. explicit SSLServer(const PemMemory &pem);
  2825. // The callback receives the ctx_t handle which can be cast to the
  2826. // appropriate backend type (SSL_CTX* for OpenSSL,
  2827. // tls::impl::MbedTlsContext* for Mbed TLS)
  2828. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2829. ~SSLServer() override;
  2830. bool is_valid() const override;
  2831. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2832. const char *client_ca_pem = nullptr,
  2833. const char *password = nullptr);
  2834. tls::ctx_t tls_context() const { return ctx_; }
  2835. int ssl_last_error() const { return last_ssl_error_; }
  2836. private:
  2837. bool process_and_close_socket(socket_t sock) override;
  2838. tls::ctx_t ctx_ = nullptr;
  2839. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2840. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2841. // bounds, and new ones wait while it is pending so that they cannot keep it
  2842. // waiting.
  2843. std::mutex ctx_mutex_;
  2844. std::condition_variable ctx_cv_;
  2845. size_t handshakes_in_progress_ = 0;
  2846. size_t updates_pending_ = 0;
  2847. int last_ssl_error_ = 0;
  2848. };
  2849. class SSLClient final : public ClientImpl {
  2850. public:
  2851. explicit SSLClient(const std::string &host);
  2852. explicit SSLClient(const std::string &host, int port);
  2853. explicit SSLClient(const std::string &host, int port,
  2854. const std::string &client_cert_path,
  2855. const std::string &client_key_path,
  2856. const std::string &private_key_password = std::string());
  2857. struct PemMemory {
  2858. const char *cert_pem;
  2859. size_t cert_pem_len;
  2860. const char *key_pem;
  2861. size_t key_pem_len;
  2862. const char *private_key_password;
  2863. };
  2864. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2865. ~SSLClient() override;
  2866. bool is_valid() const override;
  2867. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2868. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2869. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2870. // Post-handshake session verifier (backend-independent)
  2871. void set_session_verifier(
  2872. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2873. tls::ctx_t tls_context() const { return ctx_; }
  2874. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2875. void enable_windows_certificate_verification(bool enabled);
  2876. #endif
  2877. private:
  2878. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2879. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2880. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2881. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2882. bool
  2883. process_socket(const Socket &socket,
  2884. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2885. std::function<bool(Stream &strm)> callback) override;
  2886. bool is_ssl() const override;
  2887. bool setup_proxy_connection(
  2888. Socket &socket,
  2889. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2890. Response &res, bool &success, Error &error) override;
  2891. bool connect_with_proxy(
  2892. Socket &sock,
  2893. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2894. Response &res, bool &success, Error &error);
  2895. bool initialize_ssl(Socket &socket, Error &error);
  2896. void init_ctx();
  2897. void reset_ctx_on_error();
  2898. bool load_certs();
  2899. tls::ctx_t ctx_ = nullptr;
  2900. std::mutex ctx_mutex_;
  2901. std::once_flag initialize_cert_;
  2902. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2903. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2904. // Used to keep custom CA configuration exclusive with system CA loading.
  2905. bool ca_cert_store_set_ = false;
  2906. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2907. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2908. // set_server_certificate_verifier() installed there.
  2909. tls::VerifyCallback server_certificate_verifier_;
  2910. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2911. bool enable_windows_cert_verification_ = true;
  2912. #endif
  2913. friend class ClientImpl;
  2914. };
  2915. #endif // CPPHTTPLIB_SSL_ENABLED
  2916. namespace detail {
  2917. template <typename T, typename U>
  2918. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2919. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2920. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2921. duration - std::chrono::seconds(sec))
  2922. .count();
  2923. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2924. }
  2925. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2926. return N - 1;
  2927. }
  2928. inline bool is_numeric(const std::string &str) {
  2929. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2930. }
  2931. // std::ranges::next(first, n, last) for C++11
  2932. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2933. for (; n > 0 && first != last; --n) {
  2934. ++first;
  2935. }
  2936. return first;
  2937. }
  2938. inline size_t get_header_value_u64(const Headers &headers,
  2939. const std::string &key, size_t def,
  2940. size_t id, bool &is_invalid_value) {
  2941. is_invalid_value = false;
  2942. auto rng = headers.equal_range(key);
  2943. auto it = bounded_next(rng.first, id, rng.second);
  2944. if (it != rng.second) {
  2945. if (is_numeric(it->second)) {
  2946. // Parse at size_t width so an out-of-range Content-Length is reported
  2947. // rather than silently saturated/truncated (a value above 2^32 would
  2948. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2949. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2950. size_t val = 0;
  2951. const auto &s = it->second;
  2952. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2953. if (r.ec == std::errc::result_out_of_range) {
  2954. is_invalid_value = true;
  2955. return (std::numeric_limits<size_t>::max)();
  2956. }
  2957. return val;
  2958. } else {
  2959. is_invalid_value = true;
  2960. }
  2961. }
  2962. return def;
  2963. }
  2964. inline size_t get_header_value_u64(const Headers &headers,
  2965. const std::string &key, size_t def,
  2966. size_t id) {
  2967. auto dummy = false;
  2968. return get_header_value_u64(headers, key, def, id, dummy);
  2969. }
  2970. } // namespace detail
  2971. template <class Rep, class Period>
  2972. inline Server &
  2973. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2974. detail::duration_to_sec_and_usec(
  2975. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2976. return *this;
  2977. }
  2978. template <class Rep, class Period>
  2979. inline Server &
  2980. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2981. detail::duration_to_sec_and_usec(
  2982. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2983. return *this;
  2984. }
  2985. template <class Rep, class Period>
  2986. inline Server &
  2987. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2988. detail::duration_to_sec_and_usec(
  2989. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2990. return *this;
  2991. }
  2992. template <class Rep, class Period>
  2993. inline void ClientImpl::set_connection_timeout(
  2994. const std::chrono::duration<Rep, Period> &duration) {
  2995. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2996. set_connection_timeout(sec, usec);
  2997. });
  2998. }
  2999. template <class Rep, class Period>
  3000. inline void ClientImpl::set_read_timeout(
  3001. const std::chrono::duration<Rep, Period> &duration) {
  3002. detail::duration_to_sec_and_usec(
  3003. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3004. }
  3005. template <class Rep, class Period>
  3006. inline void ClientImpl::set_write_timeout(
  3007. const std::chrono::duration<Rep, Period> &duration) {
  3008. detail::duration_to_sec_and_usec(
  3009. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3010. }
  3011. template <class Rep, class Period>
  3012. inline void ClientImpl::set_max_timeout(
  3013. const std::chrono::duration<Rep, Period> &duration) {
  3014. auto msec =
  3015. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3016. set_max_timeout(static_cast<time_t>(msec));
  3017. }
  3018. template <class Rep, class Period>
  3019. inline void Client::set_connection_timeout(
  3020. const std::chrono::duration<Rep, Period> &duration) {
  3021. cli_->set_connection_timeout(duration);
  3022. }
  3023. template <class Rep, class Period>
  3024. inline void
  3025. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3026. cli_->set_read_timeout(duration);
  3027. }
  3028. template <class Rep, class Period>
  3029. inline void
  3030. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3031. cli_->set_write_timeout(duration);
  3032. }
  3033. inline void Client::set_max_timeout(time_t msec) {
  3034. cli_->set_max_timeout(msec);
  3035. }
  3036. template <class Rep, class Period>
  3037. inline void
  3038. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3039. cli_->set_max_timeout(duration);
  3040. }
  3041. /*
  3042. * Forward declarations and types that will be part of the .h file if split into
  3043. * .h + .cc.
  3044. */
  3045. std::string hosted_at(const std::string &hostname);
  3046. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3047. // JavaScript-style URL encoding/decoding functions
  3048. std::string encode_uri_component(const std::string &value);
  3049. std::string encode_uri(const std::string &value);
  3050. std::string decode_uri_component(const std::string &value);
  3051. std::string decode_uri(const std::string &value);
  3052. // RFC 3986 compliant URL component encoding/decoding functions
  3053. std::string encode_path_component(const std::string &component);
  3054. std::string decode_path_component(const std::string &component);
  3055. std::string encode_query_component(const std::string &component,
  3056. bool space_as_plus = true);
  3057. std::string decode_query_component(const std::string &component,
  3058. bool plus_as_space = true);
  3059. std::string sanitize_filename(const std::string &filename);
  3060. std::string append_query_params(const std::string &path, const Params &params);
  3061. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3062. std::pair<std::string, std::string>
  3063. make_basic_authentication_header(const std::string &username,
  3064. const std::string &password,
  3065. bool is_proxy = false);
  3066. namespace detail {
  3067. #if defined(_WIN32)
  3068. inline std::wstring u8string_to_wstring(const char *s) {
  3069. if (!s) { return std::wstring(); }
  3070. auto len = static_cast<int>(strlen(s));
  3071. if (!len) { return std::wstring(); }
  3072. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3073. if (!wlen) { return std::wstring(); }
  3074. std::wstring ws;
  3075. ws.resize(wlen);
  3076. wlen = ::MultiByteToWideChar(
  3077. CP_UTF8, 0, s, len,
  3078. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3079. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3080. return ws;
  3081. }
  3082. #endif
  3083. struct FileStat {
  3084. FileStat(const std::string &path);
  3085. bool is_file() const;
  3086. bool is_dir() const;
  3087. time_t mtime() const;
  3088. size_t size() const;
  3089. private:
  3090. #if defined(_WIN32)
  3091. struct _stat st_;
  3092. #else
  3093. struct stat st_;
  3094. #endif
  3095. int ret_ = -1;
  3096. };
  3097. std::string make_host_and_port_string(const std::string &host, int port,
  3098. bool is_ssl);
  3099. template <typename T>
  3100. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3101. Error &error);
  3102. std::string trim_copy(const std::string &s);
  3103. void divide(
  3104. const char *data, std::size_t size, char d,
  3105. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3106. fn);
  3107. void divide(
  3108. const std::string &str, char d,
  3109. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3110. fn);
  3111. void split(const char *b, const char *e, char d,
  3112. std::function<void(const char *, const char *)> fn);
  3113. void split(const char *b, const char *e, char d, size_t m,
  3114. std::function<void(const char *, const char *)> fn);
  3115. bool split_find(const char *b, const char *e, char d,
  3116. std::function<bool(const char *, const char *)> fn);
  3117. bool has_header_token(const Headers &headers, const std::string &key,
  3118. const std::string &token);
  3119. std::string websocket_accept_key(const std::string &client_key);
  3120. bool is_websocket_upgrade(const Request &req);
  3121. bool process_client_socket(
  3122. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3123. time_t write_timeout_sec, time_t write_timeout_usec,
  3124. time_t max_timeout_msec,
  3125. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3126. std::function<bool(Stream &)> callback);
  3127. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3128. int port, int address_family, bool tcp_nodelay,
  3129. bool ipv6_v6only, SocketOptions socket_options,
  3130. time_t connection_timeout_sec,
  3131. time_t connection_timeout_usec,
  3132. time_t read_timeout_sec, time_t read_timeout_usec,
  3133. time_t write_timeout_sec,
  3134. time_t write_timeout_usec,
  3135. const std::string &intf, Error &error);
  3136. const char *get_header_value(const Headers &headers, const std::string &key,
  3137. const char *def, size_t id);
  3138. std::string get_combined_header_value(const Headers &headers,
  3139. const std::string &key);
  3140. std::string params_to_query_str(const Params &params);
  3141. void parse_query_text(const char *data, std::size_t size, Params &params);
  3142. void parse_query_text(const std::string &s, Params &params);
  3143. bool parse_multipart_boundary(const std::string &content_type,
  3144. std::string &boundary);
  3145. bool parse_range_header(const std::string &s, Ranges &ranges);
  3146. bool parse_accept_header(const std::string &s,
  3147. std::vector<std::string> &content_types);
  3148. void parse_disposition_params(const std::string &s, Params &params);
  3149. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3150. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3151. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3152. EncodingType encoding_type(const Request &req, const Response &res,
  3153. const std::string &content_type);
  3154. EncodingType encoding_type(const Request &req, const Response &res);
  3155. class BufferStream final : public Stream {
  3156. public:
  3157. BufferStream() = default;
  3158. ~BufferStream() override = default;
  3159. bool is_readable() const override;
  3160. bool wait_readable() const override;
  3161. bool wait_writable() const override;
  3162. ssize_t read(char *ptr, size_t size) override;
  3163. ssize_t write(const char *ptr, size_t size) override;
  3164. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3165. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3166. socket_t socket() const override;
  3167. time_t duration() const override;
  3168. const std::string &get_buffer() const;
  3169. private:
  3170. std::string buffer;
  3171. size_t position = 0;
  3172. };
  3173. class compressor {
  3174. public:
  3175. virtual ~compressor() = default;
  3176. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3177. virtual bool compress(const char *data, size_t data_length, bool last,
  3178. Callback callback) = 0;
  3179. };
  3180. class decompressor {
  3181. public:
  3182. virtual ~decompressor() = default;
  3183. virtual bool is_valid() const = 0;
  3184. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3185. virtual bool decompress(const char *data, size_t data_length,
  3186. Callback callback) = 0;
  3187. };
  3188. class nocompressor final : public compressor {
  3189. public:
  3190. ~nocompressor() override = default;
  3191. bool compress(const char *data, size_t data_length, bool /*last*/,
  3192. Callback callback) override;
  3193. };
  3194. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3195. class gzip_compressor final : public compressor {
  3196. public:
  3197. gzip_compressor();
  3198. ~gzip_compressor() override;
  3199. bool compress(const char *data, size_t data_length, bool last,
  3200. Callback callback) override;
  3201. private:
  3202. bool is_valid_ = false;
  3203. z_stream strm_;
  3204. };
  3205. class gzip_decompressor final : public decompressor {
  3206. public:
  3207. gzip_decompressor();
  3208. ~gzip_decompressor() override;
  3209. bool is_valid() const override;
  3210. bool decompress(const char *data, size_t data_length,
  3211. Callback callback) override;
  3212. private:
  3213. bool is_valid_ = false;
  3214. z_stream strm_;
  3215. };
  3216. #endif
  3217. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3218. class brotli_compressor final : public compressor {
  3219. public:
  3220. brotli_compressor();
  3221. ~brotli_compressor();
  3222. bool compress(const char *data, size_t data_length, bool last,
  3223. Callback callback) override;
  3224. private:
  3225. BrotliEncoderState *state_ = nullptr;
  3226. };
  3227. class brotli_decompressor final : public decompressor {
  3228. public:
  3229. brotli_decompressor();
  3230. ~brotli_decompressor();
  3231. bool is_valid() const override;
  3232. bool decompress(const char *data, size_t data_length,
  3233. Callback callback) override;
  3234. private:
  3235. BrotliDecoderResult decoder_r;
  3236. BrotliDecoderState *decoder_s = nullptr;
  3237. };
  3238. #endif
  3239. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3240. class zstd_compressor : public compressor {
  3241. public:
  3242. zstd_compressor();
  3243. ~zstd_compressor();
  3244. bool compress(const char *data, size_t data_length, bool last,
  3245. Callback callback) override;
  3246. private:
  3247. ZSTD_CCtx *ctx_ = nullptr;
  3248. };
  3249. class zstd_decompressor : public decompressor {
  3250. public:
  3251. zstd_decompressor();
  3252. ~zstd_decompressor();
  3253. bool is_valid() const override;
  3254. bool decompress(const char *data, size_t data_length,
  3255. Callback callback) override;
  3256. private:
  3257. ZSTD_DCtx *ctx_ = nullptr;
  3258. };
  3259. #endif
  3260. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3261. // to store data. The call can set memory on stack for performance.
  3262. class stream_line_reader {
  3263. public:
  3264. stream_line_reader(Stream &strm, char *fixed_buffer,
  3265. size_t fixed_buffer_size);
  3266. const char *ptr() const;
  3267. size_t size() const;
  3268. bool end_with_crlf() const;
  3269. bool getline();
  3270. private:
  3271. void append(char c);
  3272. void append(const char *data, size_t size);
  3273. Stream &strm_;
  3274. char *fixed_buffer_;
  3275. const size_t fixed_buffer_size_;
  3276. size_t fixed_buffer_used_size_ = 0;
  3277. std::string growable_buffer_;
  3278. };
  3279. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3280. const Headers &src_headers);
  3281. struct ChunkedDecoder {
  3282. Stream &strm;
  3283. size_t chunk_remaining = 0;
  3284. bool finished = false;
  3285. char line_buf[64];
  3286. size_t last_chunk_total = 0;
  3287. size_t last_chunk_offset = 0;
  3288. explicit ChunkedDecoder(Stream &s);
  3289. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3290. size_t &out_chunk_total);
  3291. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3292. };
  3293. // A regular file opened to be served: mapped on Windows, read with pread()
  3294. // elsewhere.
  3295. class mmap {
  3296. public:
  3297. mmap(const char *path);
  3298. ~mmap();
  3299. bool open(const char *path);
  3300. void close();
  3301. bool is_open() const;
  3302. size_t size() const;
  3303. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3304. // down to 0, if the file has shrunk since it was opened.
  3305. size_t read(size_t offset, char *buf, size_t len) const;
  3306. private:
  3307. #if defined(_WIN32)
  3308. HANDLE hFile_ = NULL;
  3309. HANDLE hMapping_ = NULL;
  3310. void *addr_ = nullptr;
  3311. bool is_open_empty_file = false;
  3312. #else
  3313. int fd_ = -1;
  3314. #endif
  3315. size_t size_ = 0;
  3316. };
  3317. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3318. namespace fields {
  3319. bool is_token_char(char c);
  3320. bool is_token(const std::string &s);
  3321. bool is_field_name(const std::string &s);
  3322. bool is_vchar(char c);
  3323. bool is_obs_text(char c);
  3324. bool is_field_vchar(char c);
  3325. bool is_field_content(const std::string &s);
  3326. bool is_field_value(const std::string &s);
  3327. bool is_field_valid(const std::string &name, const std::string &value);
  3328. bool is_request_target(const std::string &s);
  3329. bool is_host(const std::string &s);
  3330. } // namespace fields
  3331. } // namespace detail
  3332. /*
  3333. * TLS Abstraction Layer Declarations
  3334. */
  3335. #ifdef CPPHTTPLIB_SSL_ENABLED
  3336. // TLS abstraction layer - backend-specific type declarations
  3337. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3338. namespace tls {
  3339. namespace impl {
  3340. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3341. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3342. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3343. struct MbedTlsContext {
  3344. mbedtls_ssl_config conf;
  3345. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3346. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3347. mbedtls_entropy_context entropy;
  3348. mbedtls_ctr_drbg_context ctr_drbg;
  3349. #endif
  3350. mbedtls_x509_crt ca_chain;
  3351. mbedtls_x509_crt own_cert;
  3352. mbedtls_pk_context own_key;
  3353. bool is_server = false;
  3354. // Peer certificate required (set_verify_client()); a client defaults to true
  3355. bool verify_client = false;
  3356. // Set by tls::set_verify_callback().
  3357. VerifyCallback verify_callback;
  3358. MbedTlsContext();
  3359. ~MbedTlsContext();
  3360. MbedTlsContext(const MbedTlsContext &) = delete;
  3361. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3362. };
  3363. } // namespace impl
  3364. } // namespace tls
  3365. #endif
  3366. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3367. namespace tls {
  3368. namespace impl {
  3369. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3370. // This struct is accessible via tls::impl for use in SSL context
  3371. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3372. struct WolfSSLContext {
  3373. WOLFSSL_CTX *ctx = nullptr;
  3374. bool is_server = false;
  3375. // Peer certificate required (set_verify_client()); a client defaults to true
  3376. bool verify_client = false;
  3377. // Replaced under verify_callback_mutex()
  3378. std::shared_ptr<VerifyCallback> verify_callback;
  3379. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3380. WolfSSLContext();
  3381. ~WolfSSLContext();
  3382. WolfSSLContext(const WolfSSLContext &) = delete;
  3383. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3384. };
  3385. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3386. struct WolfSSLCAStore {
  3387. std::string pem_data;
  3388. };
  3389. } // namespace impl
  3390. } // namespace tls
  3391. #endif
  3392. #endif // CPPHTTPLIB_SSL_ENABLED
  3393. namespace stream {
  3394. class Result {
  3395. public:
  3396. Result();
  3397. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3398. Result(Result &&other) noexcept;
  3399. Result &operator=(Result &&other) noexcept;
  3400. Result(const Result &) = delete;
  3401. Result &operator=(const Result &) = delete;
  3402. // Response info
  3403. bool is_valid() const;
  3404. explicit operator bool() const;
  3405. int status() const;
  3406. const Headers &headers() const;
  3407. std::string get_header_value(const std::string &key,
  3408. const char *def = "") const;
  3409. bool has_header(const std::string &key) const;
  3410. Error error() const;
  3411. Error read_error() const;
  3412. bool has_read_error() const;
  3413. // Stream reading
  3414. bool next();
  3415. const char *data() const;
  3416. size_t size() const;
  3417. std::string read_all();
  3418. private:
  3419. ClientImpl::StreamHandle handle_;
  3420. std::string buffer_;
  3421. size_t current_size_ = 0;
  3422. size_t chunk_size_;
  3423. bool finished_ = false;
  3424. };
  3425. // GET
  3426. template <typename ClientType>
  3427. inline Result Get(ClientType &cli, const std::string &path,
  3428. size_t chunk_size = 8192) {
  3429. return Result{cli.open_stream("GET", path), chunk_size};
  3430. }
  3431. template <typename ClientType>
  3432. inline Result Get(ClientType &cli, const std::string &path,
  3433. const Headers &headers, size_t chunk_size = 8192) {
  3434. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3435. }
  3436. template <typename ClientType>
  3437. inline Result Get(ClientType &cli, const std::string &path,
  3438. const Params &params, size_t chunk_size = 8192) {
  3439. return Result{cli.open_stream("GET", path, params), chunk_size};
  3440. }
  3441. template <typename ClientType>
  3442. inline Result Get(ClientType &cli, const std::string &path,
  3443. const Params &params, const Headers &headers,
  3444. size_t chunk_size = 8192) {
  3445. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3446. }
  3447. // POST
  3448. template <typename ClientType>
  3449. inline Result Post(ClientType &cli, const std::string &path,
  3450. const std::string &body, const std::string &content_type,
  3451. size_t chunk_size = 8192) {
  3452. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3453. chunk_size};
  3454. }
  3455. template <typename ClientType>
  3456. inline Result Post(ClientType &cli, const std::string &path,
  3457. const Headers &headers, const std::string &body,
  3458. const std::string &content_type, size_t chunk_size = 8192) {
  3459. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3460. chunk_size};
  3461. }
  3462. template <typename ClientType>
  3463. inline Result Post(ClientType &cli, const std::string &path,
  3464. const Params &params, const std::string &body,
  3465. const std::string &content_type, size_t chunk_size = 8192) {
  3466. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3467. chunk_size};
  3468. }
  3469. template <typename ClientType>
  3470. inline Result Post(ClientType &cli, const std::string &path,
  3471. const Params &params, const Headers &headers,
  3472. const std::string &body, const std::string &content_type,
  3473. size_t chunk_size = 8192) {
  3474. return Result{
  3475. cli.open_stream("POST", path, params, headers, body, content_type),
  3476. chunk_size};
  3477. }
  3478. // PUT
  3479. template <typename ClientType>
  3480. inline Result Put(ClientType &cli, const std::string &path,
  3481. const std::string &body, const std::string &content_type,
  3482. size_t chunk_size = 8192) {
  3483. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3484. chunk_size};
  3485. }
  3486. template <typename ClientType>
  3487. inline Result Put(ClientType &cli, const std::string &path,
  3488. const Headers &headers, const std::string &body,
  3489. const std::string &content_type, size_t chunk_size = 8192) {
  3490. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3491. chunk_size};
  3492. }
  3493. template <typename ClientType>
  3494. inline Result Put(ClientType &cli, const std::string &path,
  3495. const Params &params, const std::string &body,
  3496. const std::string &content_type, size_t chunk_size = 8192) {
  3497. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3498. chunk_size};
  3499. }
  3500. template <typename ClientType>
  3501. inline Result Put(ClientType &cli, const std::string &path,
  3502. const Params &params, const Headers &headers,
  3503. const std::string &body, const std::string &content_type,
  3504. size_t chunk_size = 8192) {
  3505. return Result{
  3506. cli.open_stream("PUT", path, params, headers, body, content_type),
  3507. chunk_size};
  3508. }
  3509. // PATCH
  3510. template <typename ClientType>
  3511. inline Result Patch(ClientType &cli, const std::string &path,
  3512. const std::string &body, const std::string &content_type,
  3513. size_t chunk_size = 8192) {
  3514. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3515. chunk_size};
  3516. }
  3517. template <typename ClientType>
  3518. inline Result Patch(ClientType &cli, const std::string &path,
  3519. const Headers &headers, const std::string &body,
  3520. const std::string &content_type, size_t chunk_size = 8192) {
  3521. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3522. chunk_size};
  3523. }
  3524. template <typename ClientType>
  3525. inline Result Patch(ClientType &cli, const std::string &path,
  3526. const Params &params, const std::string &body,
  3527. const std::string &content_type, size_t chunk_size = 8192) {
  3528. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3529. chunk_size};
  3530. }
  3531. template <typename ClientType>
  3532. inline Result Patch(ClientType &cli, const std::string &path,
  3533. const Params &params, const Headers &headers,
  3534. const std::string &body, const std::string &content_type,
  3535. size_t chunk_size = 8192) {
  3536. return Result{
  3537. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3538. chunk_size};
  3539. }
  3540. // DELETE
  3541. template <typename ClientType>
  3542. inline Result Delete(ClientType &cli, const std::string &path,
  3543. size_t chunk_size = 8192) {
  3544. return Result{cli.open_stream("DELETE", path), chunk_size};
  3545. }
  3546. template <typename ClientType>
  3547. inline Result Delete(ClientType &cli, const std::string &path,
  3548. const Headers &headers, size_t chunk_size = 8192) {
  3549. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3550. }
  3551. template <typename ClientType>
  3552. inline Result Delete(ClientType &cli, const std::string &path,
  3553. const std::string &body, const std::string &content_type,
  3554. size_t chunk_size = 8192) {
  3555. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3556. chunk_size};
  3557. }
  3558. template <typename ClientType>
  3559. inline Result Delete(ClientType &cli, const std::string &path,
  3560. const Headers &headers, const std::string &body,
  3561. const std::string &content_type,
  3562. size_t chunk_size = 8192) {
  3563. return Result{
  3564. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3565. chunk_size};
  3566. }
  3567. template <typename ClientType>
  3568. inline Result Delete(ClientType &cli, const std::string &path,
  3569. const Params &params, size_t chunk_size = 8192) {
  3570. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3571. }
  3572. template <typename ClientType>
  3573. inline Result Delete(ClientType &cli, const std::string &path,
  3574. const Params &params, const Headers &headers,
  3575. size_t chunk_size = 8192) {
  3576. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3577. }
  3578. template <typename ClientType>
  3579. inline Result Delete(ClientType &cli, const std::string &path,
  3580. const Params &params, const std::string &body,
  3581. const std::string &content_type,
  3582. size_t chunk_size = 8192) {
  3583. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3584. chunk_size};
  3585. }
  3586. template <typename ClientType>
  3587. inline Result Delete(ClientType &cli, const std::string &path,
  3588. const Params &params, const Headers &headers,
  3589. const std::string &body, const std::string &content_type,
  3590. size_t chunk_size = 8192) {
  3591. return Result{
  3592. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3593. chunk_size};
  3594. }
  3595. // HEAD
  3596. template <typename ClientType>
  3597. inline Result Head(ClientType &cli, const std::string &path,
  3598. size_t chunk_size = 8192) {
  3599. return Result{cli.open_stream("HEAD", path), chunk_size};
  3600. }
  3601. template <typename ClientType>
  3602. inline Result Head(ClientType &cli, const std::string &path,
  3603. const Headers &headers, size_t chunk_size = 8192) {
  3604. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3605. }
  3606. template <typename ClientType>
  3607. inline Result Head(ClientType &cli, const std::string &path,
  3608. const Params &params, size_t chunk_size = 8192) {
  3609. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3610. }
  3611. template <typename ClientType>
  3612. inline Result Head(ClientType &cli, const std::string &path,
  3613. const Params &params, const Headers &headers,
  3614. size_t chunk_size = 8192) {
  3615. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3616. }
  3617. // OPTIONS
  3618. template <typename ClientType>
  3619. inline Result Options(ClientType &cli, const std::string &path,
  3620. size_t chunk_size = 8192) {
  3621. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3622. }
  3623. template <typename ClientType>
  3624. inline Result Options(ClientType &cli, const std::string &path,
  3625. const Headers &headers, size_t chunk_size = 8192) {
  3626. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3627. }
  3628. template <typename ClientType>
  3629. inline Result Options(ClientType &cli, const std::string &path,
  3630. const Params &params, size_t chunk_size = 8192) {
  3631. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3632. }
  3633. template <typename ClientType>
  3634. inline Result Options(ClientType &cli, const std::string &path,
  3635. const Params &params, const Headers &headers,
  3636. size_t chunk_size = 8192) {
  3637. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3638. }
  3639. } // namespace stream
  3640. namespace sse {
  3641. struct SSEMessage {
  3642. std::string event; // Event type (default: "message")
  3643. std::string data; // Event payload
  3644. std::string id; // Event ID for Last-Event-ID header
  3645. SSEMessage();
  3646. void clear();
  3647. };
  3648. class SSEClient {
  3649. public:
  3650. using MessageHandler = std::function<void(const SSEMessage &)>;
  3651. using ErrorHandler = std::function<void(Error)>;
  3652. using OpenHandler = std::function<void()>;
  3653. SSEClient(Client &client, const std::string &path);
  3654. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3655. ~SSEClient();
  3656. SSEClient(const SSEClient &) = delete;
  3657. SSEClient &operator=(const SSEClient &) = delete;
  3658. // Event handlers
  3659. SSEClient &on_message(MessageHandler handler);
  3660. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3661. SSEClient &on_open(OpenHandler handler);
  3662. SSEClient &on_error(ErrorHandler handler);
  3663. SSEClient &set_reconnect_interval(int ms);
  3664. SSEClient &set_max_reconnect_attempts(int n);
  3665. // Update headers (thread-safe)
  3666. SSEClient &set_headers(const Headers &headers);
  3667. // State accessors
  3668. bool is_connected() const;
  3669. const std::string &last_event_id() const;
  3670. // Blocking start - runs event loop with auto-reconnect
  3671. void start();
  3672. // Non-blocking start - runs in background thread
  3673. void start_async();
  3674. // Stop the client (thread-safe)
  3675. void stop();
  3676. private:
  3677. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3678. bool &has_data, bool &has_id);
  3679. void run_event_loop();
  3680. void dispatch_event(const SSEMessage &msg);
  3681. bool should_reconnect(int count) const;
  3682. void wait_for_reconnect();
  3683. // Client and path
  3684. Client &client_;
  3685. std::string path_;
  3686. Headers headers_;
  3687. mutable std::mutex headers_mutex_;
  3688. // Callbacks
  3689. MessageHandler on_message_;
  3690. std::map<std::string, MessageHandler> event_handlers_;
  3691. OpenHandler on_open_;
  3692. ErrorHandler on_error_;
  3693. // Configuration
  3694. int reconnect_interval_ms_ = 3000;
  3695. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3696. // State
  3697. std::atomic<bool> running_{false};
  3698. std::atomic<bool> connected_{false};
  3699. std::string last_event_id_;
  3700. // Async support
  3701. std::thread async_thread_;
  3702. };
  3703. } // namespace sse
  3704. namespace ws {
  3705. class WebSocketClient;
  3706. enum class Opcode : uint8_t {
  3707. Continuation = 0x0,
  3708. Text = 0x1,
  3709. Binary = 0x2,
  3710. Close = 0x8,
  3711. Ping = 0x9,
  3712. Pong = 0xA,
  3713. };
  3714. enum class CloseStatus : uint16_t {
  3715. Normal = 1000,
  3716. GoingAway = 1001,
  3717. ProtocolError = 1002,
  3718. UnsupportedData = 1003,
  3719. NoStatus = 1005,
  3720. Abnormal = 1006,
  3721. InvalidPayload = 1007,
  3722. PolicyViolation = 1008,
  3723. MessageTooBig = 1009,
  3724. MandatoryExtension = 1010,
  3725. InternalError = 1011,
  3726. };
  3727. // Timeout is returned only when a read timeout was set and it elapsed before
  3728. // any byte of a frame arrived: nothing was consumed and the connection is
  3729. // still open, so the caller can send on it and read again. `msg` is left
  3730. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3731. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3732. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3733. // upgrade handshake fully succeeded. On failure error() identifies the
  3734. // failing layer; status()/headers() expose the server's upgrade response
  3735. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3736. // CONNECT when error() is ProxyConnection.
  3737. class Result {
  3738. public:
  3739. Result() = default;
  3740. Result(Error err, int status, Headers &&headers)
  3741. : err_(err), status_(status), headers_(std::move(headers)) {}
  3742. explicit operator bool() const { return err_ == Error::Success; }
  3743. Error error() const { return err_; }
  3744. // Upgrade response info
  3745. int status() const { return status_; }
  3746. const Headers &headers() const { return headers_; }
  3747. std::string get_header_value(const std::string &key,
  3748. const char *def = "") const {
  3749. return detail::get_header_value(headers_, key, def, 0);
  3750. }
  3751. bool has_header(const std::string &key) const {
  3752. return headers_.find(key) != headers_.end();
  3753. }
  3754. #ifdef CPPHTTPLIB_SSL_ENABLED
  3755. Result(Error err, int status, Headers &&headers, int ssl_error,
  3756. uint64_t ssl_backend_error)
  3757. : err_(err), status_(status), headers_(std::move(headers)),
  3758. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3759. int ssl_error() const { return ssl_error_; }
  3760. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3761. #endif
  3762. private:
  3763. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3764. int status_ = -1;
  3765. Headers headers_;
  3766. #ifdef CPPHTTPLIB_SSL_ENABLED
  3767. int ssl_error_ = 0;
  3768. uint64_t ssl_backend_error_ = 0;
  3769. #endif
  3770. };
  3771. class WebSocket {
  3772. public:
  3773. WebSocket(const WebSocket &) = delete;
  3774. WebSocket &operator=(const WebSocket &) = delete;
  3775. ~WebSocket();
  3776. ReadResult read(std::string &msg);
  3777. bool send(const std::string &data);
  3778. bool send(const char *data, size_t len);
  3779. void close(CloseStatus status = CloseStatus::Normal,
  3780. const std::string &reason = "");
  3781. const Request &request() const;
  3782. bool is_open() const;
  3783. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3784. // A server handler owns its connection's timeout this way; a client sets it
  3785. // through WebSocketClient. Safe to call while another thread is in read().
  3786. //
  3787. // Only a timeout set here is reported as Timeout. The compile-time default
  3788. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3789. // than a request for control, so when it elapses read() returns Fail and
  3790. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3791. void set_read_timeout(time_t sec, time_t usec = 0);
  3792. template <class Rep, class Period>
  3793. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3794. private:
  3795. friend class httplib::Server;
  3796. friend class httplib::ws::WebSocketClient;
  3797. WebSocket(
  3798. Stream &strm, const Request &req, bool is_server,
  3799. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3800. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3801. : strm_(strm), req_(req), is_server_(is_server),
  3802. ping_interval_sec_(ping_interval_sec),
  3803. max_missed_pongs_(max_missed_pongs) {
  3804. start_heartbeat();
  3805. }
  3806. WebSocket(
  3807. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3808. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3809. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3810. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3811. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3812. max_missed_pongs_(max_missed_pongs) {
  3813. start_heartbeat();
  3814. }
  3815. void start_heartbeat();
  3816. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3817. Stream &strm_;
  3818. std::unique_ptr<Stream> owned_strm_;
  3819. Request req_;
  3820. bool is_server_;
  3821. time_t ping_interval_sec_;
  3822. int max_missed_pongs_;
  3823. int unacked_pings_ = 0;
  3824. std::atomic<bool> closed_{false};
  3825. // Set once the caller has bounded read() through set_read_timeout(). Until
  3826. // then the timeout in effect is the compile-time default, and elapsing it
  3827. // is a failure that closes the connection, not a Timeout.
  3828. std::atomic<bool> read_timeout_set_{false};
  3829. std::mutex write_mutex_;
  3830. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3831. // may do so: read_websocket_frame() reads a payload until it has the whole
  3832. // declared length, so a second parser stealing bytes silently corrupts the
  3833. // message the first one is assembling.
  3834. std::mutex read_mutex_;
  3835. std::thread ping_thread_;
  3836. std::mutex ping_mutex_;
  3837. std::condition_variable ping_cv_;
  3838. };
  3839. class WebSocketClient {
  3840. public:
  3841. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3842. const Headers &headers = {});
  3843. ~WebSocketClient();
  3844. WebSocketClient(const WebSocketClient &) = delete;
  3845. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3846. bool is_valid() const;
  3847. Result connect();
  3848. ReadResult read(std::string &msg);
  3849. bool send(const std::string &data);
  3850. bool send(const char *data, size_t len);
  3851. void close(CloseStatus status = CloseStatus::Normal,
  3852. const std::string &reason = "");
  3853. bool is_open() const;
  3854. const std::string &subprotocol() const;
  3855. void set_read_timeout(time_t sec, time_t usec = 0);
  3856. template <class Rep, class Period>
  3857. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3858. void set_write_timeout(time_t sec, time_t usec = 0);
  3859. template <class Rep, class Period>
  3860. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3861. void set_websocket_ping_interval(time_t sec);
  3862. void set_websocket_max_missed_pongs(int count);
  3863. void set_tcp_nodelay(bool on);
  3864. void set_address_family(int family);
  3865. void set_ipv6_v6only(bool on);
  3866. void set_socket_options(SocketOptions socket_options);
  3867. void set_connection_timeout(time_t sec, time_t usec = 0);
  3868. template <class Rep, class Period>
  3869. void
  3870. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3871. void set_interface(const std::string &intf);
  3872. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3873. void set_proxy(const std::string &host, int port);
  3874. void set_proxy_basic_auth(const std::string &username,
  3875. const std::string &password);
  3876. void set_proxy_bearer_token_auth(const std::string &token);
  3877. void set_no_proxy(const std::vector<std::string> &patterns);
  3878. #ifdef CPPHTTPLIB_SSL_ENABLED
  3879. struct PemMemory {
  3880. const char *cert_pem;
  3881. size_t cert_pem_len;
  3882. const char *key_pem;
  3883. size_t key_pem_len;
  3884. const char *private_key_password;
  3885. };
  3886. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3887. const PemMemory &pem, const Headers &headers = {});
  3888. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3889. const std::string &ca_cert_dir_path = std::string());
  3890. void set_ca_cert_store(tls::ca_store_t store);
  3891. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3892. void enable_server_certificate_verification(bool enabled);
  3893. void enable_server_hostname_verification(bool enabled);
  3894. void enable_system_ca(bool enabled);
  3895. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3896. void set_session_verifier(
  3897. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3898. void set_proxy_digest_auth(const std::string &username,
  3899. const std::string &password);
  3900. #endif
  3901. private:
  3902. void shutdown_and_close();
  3903. std::pair<time_t, time_t> handshake_timeout() const;
  3904. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3905. int &ssl_error, uint64_t &ssl_backend_error);
  3906. void prepare_default_headers(Request &req);
  3907. bool is_proxy_enabled() const;
  3908. bool create_and_connect_socket(Error &error);
  3909. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  3910. bool connect_with_proxy(Response &proxy_res, Error &error);
  3911. std::string host_;
  3912. int port_;
  3913. std::string path_;
  3914. Headers headers_;
  3915. std::string subprotocol_;
  3916. bool is_valid_ = false;
  3917. socket_t sock_ = INVALID_SOCKET;
  3918. std::unique_ptr<WebSocket> ws_;
  3919. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3920. time_t read_timeout_usec_ = 0;
  3921. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3922. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3923. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3924. time_t websocket_ping_interval_sec_ =
  3925. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3926. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3927. int address_family_ = AF_UNSPEC;
  3928. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3929. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3930. SocketOptions socket_options_ = nullptr;
  3931. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3932. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3933. std::string interface_;
  3934. // Hostname to connection target map. The value is an IP literal or another
  3935. // hostname; only the connection target changes, never the identity.
  3936. std::map<std::string, std::string> addr_map_;
  3937. std::string proxy_host_;
  3938. int proxy_port_ = -1;
  3939. std::string proxy_basic_auth_username_;
  3940. std::string proxy_basic_auth_password_;
  3941. std::string proxy_bearer_token_auth_token_;
  3942. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  3943. #ifdef CPPHTTPLIB_SSL_ENABLED
  3944. bool is_ssl_ = false;
  3945. tls::ctx_t tls_ctx_ = nullptr;
  3946. tls::session_t tls_session_ = nullptr;
  3947. std::string ca_cert_file_path_;
  3948. std::string ca_cert_dir_path_;
  3949. bool custom_ca_loaded_ = false;
  3950. bool certs_loaded_ = false;
  3951. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3952. bool server_certificate_verification_ = true;
  3953. bool server_hostname_verification_ = true;
  3954. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  3955. std::string proxy_digest_auth_username_;
  3956. std::string proxy_digest_auth_password_;
  3957. #endif
  3958. };
  3959. template <class Rep, class Period>
  3960. inline void WebSocket::set_read_timeout(
  3961. const std::chrono::duration<Rep, Period> &duration) {
  3962. detail::duration_to_sec_and_usec(
  3963. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3964. }
  3965. template <class Rep, class Period>
  3966. inline void WebSocketClient::set_read_timeout(
  3967. const std::chrono::duration<Rep, Period> &duration) {
  3968. detail::duration_to_sec_and_usec(
  3969. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3970. }
  3971. template <class Rep, class Period>
  3972. inline void WebSocketClient::set_write_timeout(
  3973. const std::chrono::duration<Rep, Period> &duration) {
  3974. detail::duration_to_sec_and_usec(
  3975. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3976. }
  3977. template <class Rep, class Period>
  3978. inline void WebSocketClient::set_connection_timeout(
  3979. const std::chrono::duration<Rep, Period> &duration) {
  3980. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3981. set_connection_timeout(sec, usec);
  3982. });
  3983. }
  3984. namespace impl {
  3985. bool is_valid_utf8(const std::string &s);
  3986. // Three states, because a failure that consumed bytes and one that consumed
  3987. // none are not the same thing: the first has left the stream in the middle of
  3988. // a frame and the connection cannot be reused, the second can just be retried.
  3989. enum class FrameRead { Ok, Fail, Timeout };
  3990. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3991. std::string &payload, bool &fin,
  3992. bool expect_masked, size_t max_len);
  3993. } // namespace impl
  3994. } // namespace ws
  3995. // ----------------------------------------------------------------------------
  3996. /*
  3997. * Implementation that will be part of the .cc file if split into .h + .cc.
  3998. */
  3999. namespace stream {
  4000. // stream::Result implementations
  4001. inline Result::Result() : chunk_size_(8192) {}
  4002. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4003. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4004. inline Result::Result(Result &&other) noexcept
  4005. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4006. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4007. finished_(other.finished_) {
  4008. other.current_size_ = 0;
  4009. other.finished_ = true;
  4010. }
  4011. inline Result &Result::operator=(Result &&other) noexcept {
  4012. if (this != &other) {
  4013. handle_ = std::move(other.handle_);
  4014. buffer_ = std::move(other.buffer_);
  4015. current_size_ = other.current_size_;
  4016. chunk_size_ = other.chunk_size_;
  4017. finished_ = other.finished_;
  4018. other.current_size_ = 0;
  4019. other.finished_ = true;
  4020. }
  4021. return *this;
  4022. }
  4023. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4024. inline Result::operator bool() const { return is_valid(); }
  4025. inline int Result::status() const {
  4026. return handle_.response ? handle_.response->status : -1;
  4027. }
  4028. inline const Headers &Result::headers() const {
  4029. static const Headers empty_headers;
  4030. return handle_.response ? handle_.response->headers : empty_headers;
  4031. }
  4032. inline std::string Result::get_header_value(const std::string &key,
  4033. const char *def) const {
  4034. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4035. }
  4036. inline bool Result::has_header(const std::string &key) const {
  4037. return handle_.response ? handle_.response->has_header(key) : false;
  4038. }
  4039. inline Error Result::error() const { return handle_.error; }
  4040. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4041. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4042. inline bool Result::next() {
  4043. if (!handle_.is_valid() || finished_) { return false; }
  4044. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4045. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4046. if (n > 0) {
  4047. current_size_ = static_cast<size_t>(n);
  4048. return true;
  4049. }
  4050. current_size_ = 0;
  4051. finished_ = true;
  4052. return false;
  4053. }
  4054. inline const char *Result::data() const { return buffer_.data(); }
  4055. inline size_t Result::size() const { return current_size_; }
  4056. inline std::string Result::read_all() {
  4057. std::string result;
  4058. while (next()) {
  4059. result.append(data(), size());
  4060. }
  4061. return result;
  4062. }
  4063. } // namespace stream
  4064. namespace sse {
  4065. // SSEMessage implementations
  4066. inline SSEMessage::SSEMessage() : event("message") {}
  4067. inline void SSEMessage::clear() {
  4068. event = "message";
  4069. data.clear();
  4070. id.clear();
  4071. }
  4072. // SSEClient implementations
  4073. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4074. : client_(client), path_(path) {}
  4075. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4076. const Headers &headers)
  4077. : client_(client), path_(path), headers_(headers) {}
  4078. inline SSEClient::~SSEClient() { stop(); }
  4079. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4080. on_message_ = std::move(handler);
  4081. return *this;
  4082. }
  4083. inline SSEClient &SSEClient::on_event(const std::string &type,
  4084. MessageHandler handler) {
  4085. event_handlers_[type] = std::move(handler);
  4086. return *this;
  4087. }
  4088. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4089. on_open_ = std::move(handler);
  4090. return *this;
  4091. }
  4092. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4093. on_error_ = std::move(handler);
  4094. return *this;
  4095. }
  4096. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4097. reconnect_interval_ms_ = ms;
  4098. return *this;
  4099. }
  4100. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4101. max_reconnect_attempts_ = n;
  4102. return *this;
  4103. }
  4104. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4105. std::lock_guard<std::mutex> lock(headers_mutex_);
  4106. headers_ = headers;
  4107. return *this;
  4108. }
  4109. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4110. inline const std::string &SSEClient::last_event_id() const {
  4111. return last_event_id_;
  4112. }
  4113. inline void SSEClient::start() {
  4114. running_.store(true);
  4115. run_event_loop();
  4116. }
  4117. inline void SSEClient::start_async() {
  4118. running_.store(true);
  4119. async_thread_ = std::thread([this]() { run_event_loop(); });
  4120. }
  4121. inline void SSEClient::stop() {
  4122. running_.store(false);
  4123. client_.stop(); // Cancel any pending operations
  4124. if (async_thread_.joinable()) { async_thread_.join(); }
  4125. }
  4126. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4127. int &retry_ms, bool &has_data,
  4128. bool &has_id) {
  4129. // Blank line signals end of event
  4130. if (line.empty()) { return true; }
  4131. // Lines starting with ':' are comments (ignored)
  4132. if (line[0] == ':') { return false; }
  4133. // Find the colon separator
  4134. auto colon_pos = line.find(':');
  4135. auto field = line.substr(0, colon_pos);
  4136. std::string value;
  4137. // Value starts after colon, skip optional single space
  4138. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4139. auto value_start = colon_pos + 1;
  4140. if (line[value_start] == ' ') { value_start++; }
  4141. value = line.substr(value_start);
  4142. }
  4143. // Handle known fields
  4144. if (field == "event") {
  4145. msg.event = value;
  4146. } else if (field == "data") {
  4147. // Multiple data lines are concatenated with newlines
  4148. if (has_data) { msg.data += "\n"; }
  4149. msg.data += value;
  4150. has_data = true;
  4151. } else if (field == "id") {
  4152. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4153. // valid (clears the last event ID)
  4154. if (detail::fields::is_field_value(value)) {
  4155. msg.id = value;
  4156. has_id = true;
  4157. }
  4158. } else if (field == "retry") {
  4159. // Parse retry interval in milliseconds
  4160. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4161. if (detail::is_numeric(value)) {
  4162. int v = 0;
  4163. auto res =
  4164. detail::from_chars(value.data(), value.data() + value.size(), v);
  4165. if (res.ec == std::errc{}) { retry_ms = v; }
  4166. }
  4167. }
  4168. // Unknown fields are ignored per SSE spec
  4169. return false;
  4170. }
  4171. inline void SSEClient::run_event_loop() {
  4172. auto reconnect_count = 0;
  4173. while (running_.load()) {
  4174. // Build headers, including Last-Event-ID if we have one
  4175. Headers request_headers;
  4176. {
  4177. std::lock_guard<std::mutex> lock(headers_mutex_);
  4178. request_headers = headers_;
  4179. }
  4180. if (!last_event_id_.empty()) {
  4181. request_headers.emplace("Last-Event-ID", last_event_id_);
  4182. }
  4183. // Open streaming connection. An event stream has no end, so each event is
  4184. // bounded instead of the whole body.
  4185. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4186. handle.body_reader_.payload_max_length = 0;
  4187. stream::Result result{std::move(handle)};
  4188. // Connection error handling
  4189. if (!result) {
  4190. connected_.store(false);
  4191. if (on_error_) { on_error_(result.error()); }
  4192. if (!should_reconnect(reconnect_count)) { break; }
  4193. wait_for_reconnect();
  4194. reconnect_count++;
  4195. continue;
  4196. }
  4197. if (result.status() != StatusCode::OK_200) {
  4198. connected_.store(false);
  4199. if (on_error_) { on_error_(Error::Connection); }
  4200. // For certain errors, don't reconnect.
  4201. // Note: 401 is intentionally absent so that handlers can refresh
  4202. // credentials via set_headers() and let the client reconnect.
  4203. if (result.status() == StatusCode::NoContent_204 ||
  4204. result.status() == StatusCode::NotFound_404 ||
  4205. result.status() == StatusCode::Forbidden_403) {
  4206. break;
  4207. }
  4208. if (!should_reconnect(reconnect_count)) { break; }
  4209. wait_for_reconnect();
  4210. reconnect_count++;
  4211. continue;
  4212. }
  4213. // Connection successful
  4214. connected_.store(true);
  4215. reconnect_count = 0;
  4216. if (on_open_) { on_open_(); }
  4217. // Event receiving loop
  4218. std::string buffer;
  4219. SSEMessage current_msg;
  4220. auto has_data = false;
  4221. auto has_id = false;
  4222. auto first_line = true;
  4223. auto after_cr = false;
  4224. auto event_too_long = false;
  4225. while (running_.load() && result.next()) {
  4226. // What is left in the buffer has no line ending
  4227. auto search_pos = buffer.size();
  4228. buffer.append(result.data(), result.size());
  4229. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4230. // per the SSE spec
  4231. size_t line_start = 0;
  4232. size_t eol_pos;
  4233. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4234. std::string::npos) {
  4235. auto line = buffer.substr(line_start, eol_pos - line_start);
  4236. line_start = eol_pos + 1;
  4237. search_pos = line_start;
  4238. // The \n of a \r\n may arrive in a later chunk than its \r
  4239. auto is_lf_of_crlf =
  4240. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4241. after_cr = buffer[eol_pos] == '\r';
  4242. if (is_lf_of_crlf) { continue; }
  4243. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4244. if (first_line) {
  4245. first_line = false;
  4246. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4247. }
  4248. // Parse the line and check if event is complete
  4249. auto event_complete = parse_sse_line(
  4250. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4251. if (event_complete) {
  4252. // Update last_event_id for reconnection, even for an event that
  4253. // has no data. An empty id clears it.
  4254. if (has_id) { last_event_id_ = current_msg.id; }
  4255. // An event without a data field is not dispatched
  4256. if (has_data) { dispatch_event(current_msg); }
  4257. // Reset the message for the next event either way
  4258. current_msg.clear();
  4259. has_data = false;
  4260. has_id = false;
  4261. }
  4262. }
  4263. // Keep unprocessed data in buffer
  4264. buffer.erase(0, line_start);
  4265. // Neither an event nor a line still waiting for its end may grow
  4266. // without bound. 0 means no limit.
  4267. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4268. buffer.size() + current_msg.data.size() >
  4269. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4270. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4271. event_too_long = true;
  4272. break;
  4273. }
  4274. }
  4275. // Connection ended
  4276. connected_.store(false);
  4277. // Reconnecting would only get the same event again
  4278. if (!running_.load() || event_too_long) { break; }
  4279. // Check for read errors
  4280. if (result.has_read_error()) {
  4281. if (on_error_) { on_error_(result.read_error()); }
  4282. }
  4283. if (!should_reconnect(reconnect_count)) { break; }
  4284. wait_for_reconnect();
  4285. reconnect_count++;
  4286. }
  4287. connected_.store(false);
  4288. }
  4289. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4290. // Check for specific event type handler first
  4291. auto it = event_handlers_.find(msg.event);
  4292. if (it != event_handlers_.end()) {
  4293. it->second(msg);
  4294. return;
  4295. }
  4296. // Fall back to generic message handler
  4297. if (on_message_) { on_message_(msg); }
  4298. }
  4299. inline bool SSEClient::should_reconnect(int count) const {
  4300. if (!running_.load()) { return false; }
  4301. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4302. return count < max_reconnect_attempts_;
  4303. }
  4304. inline void SSEClient::wait_for_reconnect() {
  4305. // Use small increments to check running_ flag frequently.
  4306. // Always wait at least one increment, so that a zero interval (e.g.
  4307. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4308. const auto step_ms = 100;
  4309. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4310. auto waited = 0;
  4311. while (running_.load() && waited < interval_ms) {
  4312. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4313. waited += step_ms;
  4314. }
  4315. }
  4316. } // namespace sse
  4317. #ifdef CPPHTTPLIB_SSL_ENABLED
  4318. /*
  4319. * TLS abstraction layer - internal function declarations
  4320. * These are implementation details and not part of the public API.
  4321. */
  4322. namespace tls {
  4323. // Client context
  4324. ctx_t create_client_context();
  4325. void free_context(ctx_t ctx);
  4326. bool set_min_version(ctx_t ctx, Version version);
  4327. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4328. bool load_ca_file(ctx_t ctx, const char *file_path);
  4329. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4330. bool load_system_certs(ctx_t ctx);
  4331. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4332. const char *password);
  4333. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4334. const char *key_path, const char *password);
  4335. // Server context
  4336. ctx_t create_server_context();
  4337. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4338. const char *password);
  4339. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4340. const char *key_path, const char *password);
  4341. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4342. void set_verify_client(ctx_t ctx, bool require);
  4343. // Session management
  4344. session_t create_session(ctx_t ctx, socket_t sock);
  4345. void free_session(session_t session);
  4346. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4347. // Handshake (non-blocking capable)
  4348. TlsError connect(session_t session);
  4349. TlsError accept(session_t session);
  4350. // Handshake with timeout (blocking until timeout)
  4351. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4352. time_t timeout_usec, TlsError *err);
  4353. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4354. time_t timeout_usec, TlsError *err);
  4355. // I/O (non-blocking capable)
  4356. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4357. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4358. int pending(const_session_t session);
  4359. void shutdown(session_t session, bool graceful);
  4360. // Connection state
  4361. bool is_peer_closed(session_t session, socket_t sock);
  4362. // Certificate verification
  4363. cert_t get_peer_cert(const_session_t session);
  4364. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4365. // do not use them after free_session(), as with get_peer_cert().
  4366. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4367. void free_cert(cert_t cert);
  4368. bool verify_hostname(cert_t cert, const char *hostname);
  4369. uint64_t hostname_mismatch_code();
  4370. long get_verify_result(const_session_t session);
  4371. // Certificate introspection
  4372. std::string get_cert_subject_cn(cert_t cert);
  4373. std::string get_cert_issuer_name(cert_t cert);
  4374. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4375. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4376. std::string get_cert_serial(cert_t cert);
  4377. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4378. const char *get_sni(const_session_t session);
  4379. // CA store management
  4380. ca_store_t create_ca_store(const char *pem, size_t len);
  4381. void free_ca_store(ca_store_t store);
  4382. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4383. // Free each with free_cert(), and do not use them once the context's CA
  4384. // certificates change.
  4385. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4386. std::vector<std::string> get_ca_names(ctx_t ctx);
  4387. // Dynamic certificate update (for servers)
  4388. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4389. const char *password);
  4390. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4391. // Certificate verification callback
  4392. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4393. long get_verify_error(const_session_t session);
  4394. std::string verify_error_string(long error_code);
  4395. // TlsError information
  4396. uint64_t peek_error();
  4397. uint64_t get_error();
  4398. std::string error_string(uint64_t code);
  4399. } // namespace tls
  4400. #endif // CPPHTTPLIB_SSL_ENABLED
  4401. /*
  4402. * Group 1: detail namespace - Non-SSL utilities
  4403. */
  4404. namespace detail {
  4405. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4406. const void *optval, socklen_t optlen) {
  4407. return setsockopt(sock, level, optname,
  4408. #ifdef _WIN32
  4409. reinterpret_cast<const char *>(optval),
  4410. #else
  4411. optval,
  4412. #endif
  4413. optlen) == 0;
  4414. }
  4415. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4416. time_t sec, time_t usec) {
  4417. #ifdef _WIN32
  4418. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4419. #else
  4420. timeval timeout;
  4421. timeout.tv_sec = static_cast<long>(sec);
  4422. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4423. #endif
  4424. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4425. }
  4426. inline bool is_hex(char c, int &v) {
  4427. if (is_ascii_digit(c)) {
  4428. v = c - '0';
  4429. return true;
  4430. } else if ('A' <= c && c <= 'F') {
  4431. v = c - 'A' + 10;
  4432. return true;
  4433. } else if ('a' <= c && c <= 'f') {
  4434. v = c - 'a' + 10;
  4435. return true;
  4436. }
  4437. return false;
  4438. }
  4439. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4440. int &val) {
  4441. if (i >= s.size()) { return false; }
  4442. val = 0;
  4443. for (; cnt; i++, cnt--) {
  4444. if (!s[i]) { return false; }
  4445. auto v = 0;
  4446. if (is_hex(s[i], v)) {
  4447. val = val * 16 + v;
  4448. } else {
  4449. return false;
  4450. }
  4451. }
  4452. return true;
  4453. }
  4454. inline std::string from_i_to_hex(size_t n) {
  4455. static const auto charset = "0123456789abcdef";
  4456. std::string ret;
  4457. do {
  4458. ret = charset[n & 15] + ret;
  4459. n >>= 4;
  4460. } while (n > 0);
  4461. return ret;
  4462. }
  4463. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4464. // builds and trips -Wtautological-type-limit-compare.
  4465. inline bool fits_in_size_t(uint64_t n) {
  4466. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4467. }
  4468. inline std::string compute_etag(const FileStat &fs,
  4469. const std::string &suffix = std::string()) {
  4470. if (!fs.is_file()) { return std::string(); }
  4471. // If mtime cannot be determined (negative value indicates an error
  4472. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4473. // value like 0 could collide with a real file that legitimately has
  4474. // mtime == 0 (epoch) and lead to misleading validators.
  4475. auto mtime_raw = fs.mtime();
  4476. if (mtime_raw < 0) { return std::string(); }
  4477. auto mtime = static_cast<size_t>(mtime_raw);
  4478. auto size = fs.size();
  4479. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4480. from_i_to_hex(size) + suffix + "\"";
  4481. }
  4482. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4483. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4484. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4485. inline std::string file_mtime_to_http_date(time_t mtime) {
  4486. if (mtime < 0) { return std::string(); }
  4487. struct tm tm_buf;
  4488. #ifdef _WIN32
  4489. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4490. #else
  4491. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4492. #endif
  4493. char buf[64];
  4494. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4495. return std::string();
  4496. }
  4497. return std::string(buf);
  4498. }
  4499. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4500. inline time_t parse_http_date(const std::string &date_str) {
  4501. struct tm tm_buf;
  4502. // Create a classic locale object once for all parsing attempts
  4503. const std::locale classic_locale = std::locale::classic();
  4504. // Try to parse using std::get_time (C++11, cross-platform)
  4505. auto try_parse = [&](const char *fmt) -> bool {
  4506. std::istringstream ss(date_str);
  4507. ss.imbue(classic_locale);
  4508. memset(&tm_buf, 0, sizeof(tm_buf));
  4509. ss >> std::get_time(&tm_buf, fmt);
  4510. return !ss.fail();
  4511. };
  4512. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4513. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4514. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4515. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4516. // asctime format: "Sun Nov 6 08:49:37 1994"
  4517. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4518. return static_cast<time_t>(-1);
  4519. }
  4520. }
  4521. }
  4522. #ifdef _WIN32
  4523. return _mkgmtime(&tm_buf);
  4524. #elif defined _AIX
  4525. return mktime(&tm_buf);
  4526. #else
  4527. return timegm(&tm_buf);
  4528. #endif
  4529. }
  4530. inline bool is_weak_etag(const std::string &s) {
  4531. // Check if the string is a weak ETag (starts with 'W/"')
  4532. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4533. }
  4534. inline bool is_strong_etag(const std::string &s) {
  4535. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4536. // chars)
  4537. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4538. }
  4539. inline size_t to_utf8(int code, char *buff) {
  4540. if (code < 0x0080) {
  4541. buff[0] = static_cast<char>(code & 0x7F);
  4542. return 1;
  4543. } else if (code < 0x0800) {
  4544. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4545. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4546. return 2;
  4547. } else if (code < 0xD800) {
  4548. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4549. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4550. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4551. return 3;
  4552. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4553. return 0;
  4554. } else if (code < 0x10000) {
  4555. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4556. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4557. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4558. return 3;
  4559. } else if (code < 0x110000) {
  4560. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4561. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4562. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4563. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4564. return 4;
  4565. }
  4566. // NOTREACHED
  4567. return 0;
  4568. }
  4569. } // namespace detail
  4570. namespace ws {
  4571. namespace impl {
  4572. inline bool is_valid_utf8(const std::string &s) {
  4573. size_t i = 0;
  4574. auto n = s.size();
  4575. while (i < n) {
  4576. auto c = static_cast<unsigned char>(s[i]);
  4577. size_t len;
  4578. uint32_t cp;
  4579. if (c < 0x80) {
  4580. i++;
  4581. continue;
  4582. } else if ((c & 0xE0) == 0xC0) {
  4583. len = 2;
  4584. cp = c & 0x1F;
  4585. } else if ((c & 0xF0) == 0xE0) {
  4586. len = 3;
  4587. cp = c & 0x0F;
  4588. } else if ((c & 0xF8) == 0xF0) {
  4589. len = 4;
  4590. cp = c & 0x07;
  4591. } else {
  4592. return false;
  4593. }
  4594. if (i + len > n) { return false; }
  4595. for (size_t j = 1; j < len; j++) {
  4596. auto b = static_cast<unsigned char>(s[i + j]);
  4597. if ((b & 0xC0) != 0x80) { return false; }
  4598. cp = (cp << 6) | (b & 0x3F);
  4599. }
  4600. // Overlong encoding check
  4601. if (len == 2 && cp < 0x80) { return false; }
  4602. if (len == 3 && cp < 0x800) { return false; }
  4603. if (len == 4 && cp < 0x10000) { return false; }
  4604. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4605. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4606. if (cp > 0x10FFFF) { return false; }
  4607. i += len;
  4608. }
  4609. return true;
  4610. }
  4611. } // namespace impl
  4612. } // namespace ws
  4613. namespace detail {
  4614. // NOTE: This code came up with the following stackoverflow post:
  4615. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4616. inline std::string base64_encode(const std::string &in) {
  4617. static const auto lookup =
  4618. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4619. std::string out;
  4620. out.reserve(in.size());
  4621. // Unsigned: the accumulator is never masked, so with a signed int the
  4622. // `val << 8` below overflows once enough bytes are folded in (undefined
  4623. // behaviour before C++20). Only the low bits are ever emitted, so the
  4624. // wrap-around of an unsigned accumulator does not affect the output.
  4625. uint32_t val = 0;
  4626. auto valb = -6;
  4627. for (auto c : in) {
  4628. val = (val << 8) + static_cast<uint8_t>(c);
  4629. valb += 8;
  4630. while (valb >= 0) {
  4631. out.push_back(lookup[(val >> valb) & 0x3F]);
  4632. valb -= 6;
  4633. }
  4634. }
  4635. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4636. while (out.size() % 4) {
  4637. out.push_back('=');
  4638. }
  4639. return out;
  4640. }
  4641. inline std::string sha1(const std::string &input) {
  4642. // RFC 3174 SHA-1 implementation
  4643. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4644. return (x << n) | (x >> (32 - n));
  4645. };
  4646. uint32_t h0 = 0x67452301;
  4647. uint32_t h1 = 0xEFCDAB89;
  4648. uint32_t h2 = 0x98BADCFE;
  4649. uint32_t h3 = 0x10325476;
  4650. uint32_t h4 = 0xC3D2E1F0;
  4651. // Pre-processing: adding padding bits
  4652. std::string msg = input;
  4653. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4654. msg.push_back(static_cast<char>(0x80u));
  4655. while (msg.size() % 64 != 56) {
  4656. msg.push_back(0);
  4657. }
  4658. // Append original length in bits as 64-bit big-endian
  4659. for (int i = 56; i >= 0; i -= 8) {
  4660. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4661. }
  4662. // Process each 512-bit chunk
  4663. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4664. uint32_t w[80];
  4665. for (size_t i = 0; i < 16; i++) {
  4666. w[i] =
  4667. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4668. << 24) |
  4669. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4670. << 16) |
  4671. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4672. << 8) |
  4673. (static_cast<uint32_t>(
  4674. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4675. }
  4676. for (int i = 16; i < 80; i++) {
  4677. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4678. }
  4679. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4680. for (int i = 0; i < 80; i++) {
  4681. uint32_t f, k;
  4682. if (i < 20) {
  4683. f = (b & c) | ((~b) & d);
  4684. k = 0x5A827999;
  4685. } else if (i < 40) {
  4686. f = b ^ c ^ d;
  4687. k = 0x6ED9EBA1;
  4688. } else if (i < 60) {
  4689. f = (b & c) | (b & d) | (c & d);
  4690. k = 0x8F1BBCDC;
  4691. } else {
  4692. f = b ^ c ^ d;
  4693. k = 0xCA62C1D6;
  4694. }
  4695. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4696. e = d;
  4697. d = c;
  4698. c = left_rotate(b, 30);
  4699. b = a;
  4700. a = temp;
  4701. }
  4702. h0 += a;
  4703. h1 += b;
  4704. h2 += c;
  4705. h3 += d;
  4706. h4 += e;
  4707. }
  4708. // Produce the final hash as a 20-byte binary string
  4709. std::string hash(20, '\0');
  4710. for (size_t i = 0; i < 4; i++) {
  4711. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4712. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4713. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4714. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4715. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4716. }
  4717. return hash;
  4718. }
  4719. inline std::string websocket_accept_key(const std::string &client_key) {
  4720. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4721. return base64_encode(sha1(client_key + magic));
  4722. }
  4723. inline bool is_websocket_upgrade(const Request &req) {
  4724. if (req.method != "GET") { return false; }
  4725. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4726. // list of protocols and asks recipients to match each name
  4727. // case-insensitively, so look for the token rather than compare the whole
  4728. // field value.
  4729. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4730. // Check Connection: Upgrade
  4731. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4732. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4733. // RFC 6455 Section 4.2.1
  4734. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4735. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4736. return false;
  4737. }
  4738. static const std::string b64chars =
  4739. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4740. for (size_t i = 0; i < 22; i++) {
  4741. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4742. }
  4743. // Check Sec-WebSocket-Version: 13
  4744. auto version = req.get_header_value("Sec-WebSocket-Version");
  4745. if (version != "13") { return false; }
  4746. return true;
  4747. }
  4748. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4749. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4750. thread_local std::random_device rd;
  4751. size_t filled = 0;
  4752. while (filled < n) {
  4753. auto v = rd();
  4754. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4755. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4756. }
  4757. }
  4758. }
  4759. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4760. const char *data, size_t len, bool fin,
  4761. bool mask) {
  4762. // First byte: FIN + opcode
  4763. uint8_t header[2];
  4764. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4765. (static_cast<uint8_t>(opcode) & 0x0F));
  4766. // Second byte: MASK + payload length
  4767. if (len < 126) {
  4768. header[1] = static_cast<uint8_t>(len);
  4769. if (mask) { header[1] |= 0x80; }
  4770. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4771. } else if (len <= 0xFFFF) {
  4772. header[1] = 126;
  4773. if (mask) { header[1] |= 0x80; }
  4774. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4775. uint8_t ext[2];
  4776. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4777. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4778. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4779. } else {
  4780. header[1] = 127;
  4781. if (mask) { header[1] |= 0x80; }
  4782. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4783. uint8_t ext[8];
  4784. for (int i = 7; i >= 0; i--) {
  4785. ext[7 - i] =
  4786. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4787. }
  4788. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4789. }
  4790. if (mask) {
  4791. // Generate random mask key
  4792. uint8_t mask_key[4];
  4793. fill_random_bytes(mask_key, sizeof(mask_key));
  4794. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4795. // Write masked payload in chunks
  4796. const size_t chunk_size = 4096;
  4797. std::vector<char> buf((std::min)(len, chunk_size));
  4798. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4799. size_t n = (std::min)(chunk_size, len - offset);
  4800. for (size_t i = 0; i < n; i++) {
  4801. buf[i] =
  4802. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4803. }
  4804. if (strm.write(buf.data(), n) < 0) { return false; }
  4805. }
  4806. } else {
  4807. if (len > 0) {
  4808. if (strm.write(data, len) < 0) { return false; }
  4809. }
  4810. }
  4811. return true;
  4812. }
  4813. } // namespace detail
  4814. namespace ws {
  4815. namespace impl {
  4816. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4817. // hands back whatever its buffer already holds -- so every multi-byte field has
  4818. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4819. // header straddles the read buffer's boundary.
  4820. //
  4821. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4822. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4823. // there is a failure like any other. (When read() fails it always records why,
  4824. // so the error belongs to this call and not to an earlier one.)
  4825. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4826. auto p = static_cast<char *>(buf);
  4827. size_t total = 0;
  4828. while (total < size) {
  4829. auto n = strm.read(p + total, size - total);
  4830. if (n <= 0) {
  4831. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4832. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4833. }
  4834. total += static_cast<size_t>(n);
  4835. }
  4836. return FrameRead::Ok;
  4837. }
  4838. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4839. std::string &payload, bool &fin,
  4840. bool expect_masked, size_t max_len) {
  4841. // Read first 2 bytes. This is the only read that may report a timeout: it
  4842. // sits on a frame boundary, where nothing has been consumed yet.
  4843. uint8_t header[2];
  4844. FrameRead first = read_exact(strm, header, 2);
  4845. if (first != FrameRead::Ok) { return first; }
  4846. fin = (header[0] & 0x80) != 0;
  4847. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4848. if (header[0] & 0x70) { return FrameRead::Fail; }
  4849. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4850. bool masked = (header[1] & 0x80) != 0;
  4851. uint64_t payload_len = header[1] & 0x7F;
  4852. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4853. // MUST have a payload length of 125 bytes or less
  4854. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4855. if (is_control) {
  4856. if (!fin) { return FrameRead::Fail; }
  4857. if (payload_len > 125) { return FrameRead::Fail; }
  4858. }
  4859. if (masked != expect_masked) { return FrameRead::Fail; }
  4860. // Extended payload length
  4861. if (payload_len == 126) {
  4862. uint8_t ext[2];
  4863. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4864. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4865. } else if (payload_len == 127) {
  4866. uint8_t ext[8];
  4867. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4868. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4869. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4870. payload_len = 0;
  4871. for (int i = 0; i < 8; i++) {
  4872. payload_len = (payload_len << 8) | ext[i];
  4873. }
  4874. }
  4875. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4876. // size_t cannot hold (32-bit builds) is refused either way.
  4877. if ((max_len > 0 && payload_len > max_len) ||
  4878. !detail::fits_in_size_t(payload_len)) {
  4879. return FrameRead::Fail;
  4880. }
  4881. // Read mask key if present
  4882. uint8_t mask_key[4] = {0};
  4883. if (masked) {
  4884. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4885. return FrameRead::Fail;
  4886. }
  4887. }
  4888. // Grow the payload only as it arrives, since a header alone can announce
  4889. // max_len bytes that never come.
  4890. payload.clear();
  4891. auto len = static_cast<size_t>(payload_len);
  4892. while (payload.size() < len) {
  4893. auto offset = payload.size();
  4894. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4895. payload.resize(offset + n);
  4896. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4897. return FrameRead::Fail;
  4898. }
  4899. }
  4900. // Unmask if needed
  4901. if (masked) {
  4902. for (size_t i = 0; i < payload.size(); i++) {
  4903. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4904. }
  4905. }
  4906. return FrameRead::Ok;
  4907. }
  4908. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4909. // be sent followed by a UTF-8 reason.
  4910. inline bool is_valid_close_payload(const std::string &payload) {
  4911. if (payload.empty()) { return true; }
  4912. if (payload.size() < 2) { return false; }
  4913. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  4914. static_cast<uint8_t>(payload[1]);
  4915. auto may_be_sent = (1000 <= code && code <= 1003) ||
  4916. (1007 <= code && code <= 1014) ||
  4917. (3000 <= code && code <= 4999);
  4918. return may_be_sent && is_valid_utf8(payload.substr(2));
  4919. }
  4920. } // namespace impl
  4921. } // namespace ws
  4922. namespace detail {
  4923. inline bool is_valid_path(const std::string &path) {
  4924. size_t level = 0;
  4925. size_t i = 0;
  4926. // Skip slash
  4927. while (i < path.size() && path[i] == '/') {
  4928. i++;
  4929. }
  4930. while (i < path.size()) {
  4931. // Read component
  4932. auto beg = i;
  4933. while (i < path.size() && path[i] != '/') {
  4934. if (path[i] == '\0') {
  4935. return false;
  4936. } else if (path[i] == '\\') {
  4937. return false;
  4938. }
  4939. i++;
  4940. }
  4941. auto len = i - beg;
  4942. assert(len > 0);
  4943. if (!path.compare(beg, len, ".")) {
  4944. ;
  4945. } else if (!path.compare(beg, len, "..")) {
  4946. if (level == 0) { return false; }
  4947. level--;
  4948. } else {
  4949. level++;
  4950. }
  4951. // Skip slash
  4952. while (i < path.size() && path[i] == '/') {
  4953. i++;
  4954. }
  4955. }
  4956. return true;
  4957. }
  4958. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4959. #if defined(_WIN32)
  4960. char buf[_MAX_PATH];
  4961. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4962. resolved = buf;
  4963. #elif defined(PATH_MAX)
  4964. char buf[PATH_MAX];
  4965. if (realpath(path, buf) == nullptr) { return false; }
  4966. resolved = buf;
  4967. #else
  4968. auto buf = realpath(path, nullptr);
  4969. auto guard = scope_exit([&]() { std::free(buf); });
  4970. if (buf == nullptr) { return false; }
  4971. resolved = buf;
  4972. #endif
  4973. return true;
  4974. }
  4975. inline bool is_path_within_base(const std::string &resolved_path,
  4976. const std::string &resolved_base) {
  4977. #if defined(_WIN32)
  4978. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4979. resolved_base.size()) == 0;
  4980. #else
  4981. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4982. resolved_base.size()) == 0;
  4983. #endif
  4984. }
  4985. inline FileStat::FileStat(const std::string &path) {
  4986. #if defined(_WIN32)
  4987. auto wpath = u8string_to_wstring(path.c_str());
  4988. ret_ = _wstat(wpath.c_str(), &st_);
  4989. #else
  4990. ret_ = stat(path.c_str(), &st_);
  4991. #endif
  4992. }
  4993. inline bool FileStat::is_file() const {
  4994. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4995. }
  4996. inline bool FileStat::is_dir() const {
  4997. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4998. }
  4999. inline time_t FileStat::mtime() const {
  5000. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5001. : static_cast<time_t>(-1);
  5002. }
  5003. inline size_t FileStat::size() const {
  5004. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5005. }
  5006. inline std::string encode_path(const std::string &s) {
  5007. std::string result;
  5008. result.reserve(s.size());
  5009. for (size_t i = 0; s[i]; i++) {
  5010. switch (s[i]) {
  5011. case ' ': result += "%20"; break;
  5012. case '+': result += "%2B"; break;
  5013. case '\'': result += "%27"; break;
  5014. case ',': result += "%2C"; break;
  5015. // case ':': result += "%3A"; break; // ok? probably...
  5016. case ';': result += "%3B"; break;
  5017. default:
  5018. auto c = static_cast<uint8_t>(s[i]);
  5019. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5020. // in a request-target as-is.
  5021. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5022. result += '%';
  5023. char hex[4];
  5024. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5025. assert(len == 2);
  5026. result.append(hex, static_cast<size_t>(len));
  5027. } else {
  5028. result += s[i];
  5029. }
  5030. break;
  5031. }
  5032. }
  5033. return result;
  5034. }
  5035. inline std::string file_extension(const std::string &path) {
  5036. auto i = path.size();
  5037. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5038. i--;
  5039. }
  5040. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5041. return std::string();
  5042. }
  5043. return path.substr(i);
  5044. }
  5045. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5046. template <typename T>
  5047. inline bool parse_header(const char *beg, const char *end, T fn);
  5048. template <typename T>
  5049. inline bool parse_header(const char *beg, const char *end, T fn) {
  5050. // Skip trailing spaces and tabs.
  5051. while (beg < end && is_space_or_tab(end[-1])) {
  5052. end--;
  5053. }
  5054. auto p = beg;
  5055. while (p < end && *p != ':') {
  5056. p++;
  5057. }
  5058. auto name = std::string(beg, p);
  5059. if (!detail::fields::is_field_name(name)) { return false; }
  5060. if (p == end) { return false; }
  5061. auto key_end = p;
  5062. if (*p++ != ':') { return false; }
  5063. while (p < end && is_space_or_tab(*p)) {
  5064. p++;
  5065. }
  5066. if (p <= end) {
  5067. auto key_len = key_end - beg;
  5068. if (!key_len) { return false; }
  5069. auto key = std::string(beg, key_end);
  5070. auto val = std::string(p, end);
  5071. if (!detail::fields::is_field_value(val)) { return false; }
  5072. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5073. // percent-decoded by the recipient. Applications that need to interpret a
  5074. // value as a URI component should call httplib::decode_uri_component()
  5075. // (or decode_path_component()) explicitly.
  5076. fn(key, val);
  5077. return true;
  5078. }
  5079. return false;
  5080. }
  5081. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5082. const Headers &src_headers) {
  5083. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5084. // transfer coding is complete when a chunk with a chunk-size of zero is
  5085. // received, possibly followed by a trailer section, and finally terminated by
  5086. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5087. //
  5088. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5089. // doesn't care for the existence of the final CRLF. In other words, it seems
  5090. // to be ok whether the final CRLF exists or not in the chunked data.
  5091. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5092. //
  5093. // According to the reference code in RFC 9112, cpp-httplib now allows
  5094. // chunked transfer coding data without the final CRLF.
  5095. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5096. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5097. "transfer-encoding",
  5098. "content-length",
  5099. "host",
  5100. "authorization",
  5101. "www-authenticate",
  5102. "proxy-authenticate",
  5103. "proxy-authorization",
  5104. "cookie",
  5105. "set-cookie",
  5106. "cache-control",
  5107. "expect",
  5108. "max-forwards",
  5109. "pragma",
  5110. "range",
  5111. "te",
  5112. "age",
  5113. "expires",
  5114. "date",
  5115. "location",
  5116. "retry-after",
  5117. "vary",
  5118. "warning",
  5119. "content-encoding",
  5120. "content-type",
  5121. "content-range",
  5122. "trailer"};
  5123. case_ignore::unordered_set<std::string> declared_trailers;
  5124. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5125. if (!trailer_header.empty()) {
  5126. // split() trims each token and skips empty ones, so the name arrives ready
  5127. // to look up.
  5128. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5129. ',', [&](const char *b, const char *e) {
  5130. // A legitimate message declares only a handful of trailers. Cap the
  5131. // set so a peer cannot grow it without bound: an oversized set only
  5132. // arises from an attempt to force many colliding names into
  5133. // quadratic lookups (case_ignore::hash is unkeyed).
  5134. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5135. return;
  5136. }
  5137. std::string key(b, e);
  5138. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5139. declared_trailers.insert(key);
  5140. }
  5141. });
  5142. }
  5143. size_t trailer_header_count = 0;
  5144. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5145. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5146. // Count every received trailer field, not only the declared ones stored in
  5147. // dest, so undeclared fields cannot keep this loop running past the limit.
  5148. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5149. constexpr auto line_terminator_len = 2;
  5150. auto line_beg = line_reader.ptr();
  5151. auto line_end =
  5152. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5153. if (!parse_header(line_beg, line_end,
  5154. [&](const std::string &key, const std::string &val) {
  5155. if (declared_trailers.find(key) !=
  5156. declared_trailers.end()) {
  5157. dest.emplace(key, val);
  5158. }
  5159. })) {
  5160. return false;
  5161. }
  5162. trailer_header_count++;
  5163. if (!line_reader.getline()) { return false; }
  5164. }
  5165. return true;
  5166. }
  5167. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5168. size_t right) {
  5169. while (b + left < e && is_space_or_tab(b[left])) {
  5170. left++;
  5171. }
  5172. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5173. right--;
  5174. }
  5175. return std::make_pair(left, right);
  5176. }
  5177. inline std::string trim_copy(const std::string &s) {
  5178. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5179. return s.substr(r.first, r.second - r.first);
  5180. }
  5181. inline std::string trim_double_quotes_copy(const std::string &s) {
  5182. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5183. return s.substr(1, s.size() - 2);
  5184. }
  5185. return s;
  5186. }
  5187. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5188. // here, as browsers send any other backslash, such as one in a Windows path,
  5189. // as it is.
  5190. inline std::string unquote_param(const std::string &s) {
  5191. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5192. std::string out;
  5193. for (size_t i = 1; i + 1 < s.size(); i++) {
  5194. if (s[i] == '\\' && i + 2 < s.size() &&
  5195. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5196. i++;
  5197. }
  5198. out += s[i];
  5199. }
  5200. return out;
  5201. }
  5202. inline void
  5203. divide(const char *data, std::size_t size, char d,
  5204. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5205. fn) {
  5206. const auto it = std::find(data, data + size, d);
  5207. const auto found = static_cast<std::size_t>(it != data + size);
  5208. const auto lhs_data = data;
  5209. const auto lhs_size = static_cast<std::size_t>(it - data);
  5210. const auto rhs_data = it + found;
  5211. const auto rhs_size = size - lhs_size - found;
  5212. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5213. }
  5214. inline void
  5215. divide(const std::string &str, char d,
  5216. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5217. fn) {
  5218. divide(str.data(), str.size(), d, std::move(fn));
  5219. }
  5220. inline void split(const char *b, const char *e, char d,
  5221. std::function<void(const char *, const char *)> fn) {
  5222. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5223. }
  5224. inline void split(const char *b, const char *e, char d, size_t m,
  5225. std::function<void(const char *, const char *)> fn) {
  5226. size_t i = 0;
  5227. size_t beg = 0;
  5228. size_t count = 1;
  5229. while (e ? (b + i < e) : (b[i] != '\0')) {
  5230. if (b[i] == d && count < m) {
  5231. auto r = trim(b, e, beg, i);
  5232. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5233. beg = i + 1;
  5234. count++;
  5235. }
  5236. i++;
  5237. }
  5238. if (i) {
  5239. auto r = trim(b, e, beg, i);
  5240. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5241. }
  5242. }
  5243. // Same contract as split(), except that a delimiter inside a quoted-string is
  5244. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5245. // quoted-string, and ';' and '=' are legal characters inside one.
  5246. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5247. std::function<void(const char *, const char *)> fn) {
  5248. size_t i = 0;
  5249. size_t beg = 0;
  5250. size_t count = 1;
  5251. auto in_quotes = false;
  5252. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5253. while (has(i)) {
  5254. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5255. // A quoted-pair, whose second character does not end the string.
  5256. i++;
  5257. } else if (b[i] == '"') {
  5258. in_quotes = !in_quotes;
  5259. } else if (b[i] == d && !in_quotes && count < m) {
  5260. auto r = trim(b, e, beg, i);
  5261. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5262. beg = i + 1;
  5263. count++;
  5264. }
  5265. i++;
  5266. }
  5267. if (i) {
  5268. auto r = trim(b, e, beg, i);
  5269. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5270. }
  5271. }
  5272. inline void split_unquoted(const char *b, const char *e, char d,
  5273. std::function<void(const char *, const char *)> fn) {
  5274. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5275. std::move(fn));
  5276. }
  5277. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5278. // key a token, so the first '=' is the separator even when the value is a
  5279. // quoted-string carrying more of them.
  5280. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5281. std::string &val) {
  5282. divide(
  5283. b, static_cast<std::size_t>(e - b), '=',
  5284. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5285. const auto kr = trim(kb, kb + klen, 0, klen);
  5286. key.assign(kb + kr.first, kb + kr.second);
  5287. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5288. val.assign(vb + vr.first, vb + vr.second);
  5289. });
  5290. }
  5291. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5292. std::function<bool(const char *, const char *)> fn) {
  5293. size_t i = 0;
  5294. size_t beg = 0;
  5295. size_t count = 1;
  5296. while (e ? (b + i < e) : (b[i] != '\0')) {
  5297. if (b[i] == d && count < m) {
  5298. auto r = trim(b, e, beg, i);
  5299. if (r.first < r.second) {
  5300. auto found = fn(&b[r.first], &b[r.second]);
  5301. if (found) { return true; }
  5302. }
  5303. beg = i + 1;
  5304. count++;
  5305. }
  5306. i++;
  5307. }
  5308. if (i) {
  5309. auto r = trim(b, e, beg, i);
  5310. if (r.first < r.second) {
  5311. auto found = fn(&b[r.first], &b[r.second]);
  5312. if (found) { return true; }
  5313. }
  5314. }
  5315. return false;
  5316. }
  5317. inline bool split_find(const char *b, const char *e, char d,
  5318. std::function<bool(const char *, const char *)> fn) {
  5319. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5320. std::move(fn));
  5321. }
  5322. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5323. size_t fixed_buffer_size)
  5324. : strm_(strm), fixed_buffer_(fixed_buffer),
  5325. fixed_buffer_size_(fixed_buffer_size) {}
  5326. inline const char *stream_line_reader::ptr() const {
  5327. if (growable_buffer_.empty()) {
  5328. return fixed_buffer_;
  5329. } else {
  5330. return growable_buffer_.data();
  5331. }
  5332. }
  5333. inline size_t stream_line_reader::size() const {
  5334. if (growable_buffer_.empty()) {
  5335. return fixed_buffer_used_size_;
  5336. } else {
  5337. return growable_buffer_.size();
  5338. }
  5339. }
  5340. inline bool stream_line_reader::end_with_crlf() const {
  5341. auto end = ptr() + size();
  5342. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5343. }
  5344. inline bool stream_line_reader::getline() {
  5345. fixed_buffer_used_size_ = 0;
  5346. growable_buffer_.clear();
  5347. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5348. char prev_byte = 0;
  5349. #endif
  5350. for (size_t i = 0;; i++) {
  5351. // Fast path: whatever the stream has already buffered can be scanned for
  5352. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5353. // call, a bounds check and a one-byte copy per character of the request.
  5354. size_t buffered_size = 0;
  5355. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5356. auto take = buffered_size;
  5357. auto terminated = false;
  5358. for (size_t at = 0; at < buffered_size;) {
  5359. auto nl = static_cast<const char *>(
  5360. memchr(buffered + at, '\n', buffered_size - at));
  5361. if (!nl) { break; }
  5362. auto pos = static_cast<size_t>(nl - buffered);
  5363. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5364. take = pos + 1;
  5365. terminated = true;
  5366. break;
  5367. #else
  5368. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5369. // be the last byte of an earlier chunk, hence prev_byte.
  5370. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5371. take = pos + 1;
  5372. terminated = true;
  5373. break;
  5374. }
  5375. at = pos + 1;
  5376. #endif
  5377. }
  5378. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5379. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5380. prev_byte = buffered[take - 1];
  5381. #endif
  5382. append(buffered, take);
  5383. strm_.consume_buffered(take);
  5384. i += take;
  5385. if (terminated) { return true; }
  5386. continue;
  5387. }
  5388. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5389. // Treat exceptionally long lines as an error to
  5390. // prevent infinite loops/memory exhaustion
  5391. return false;
  5392. }
  5393. char byte;
  5394. auto n = strm_.read(&byte, 1);
  5395. if (n < 0) {
  5396. return false;
  5397. } else if (n == 0) {
  5398. if (i == 0) {
  5399. return false;
  5400. } else {
  5401. break;
  5402. }
  5403. }
  5404. append(byte);
  5405. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5406. if (byte == '\n') { break; }
  5407. #else
  5408. if (prev_byte == '\r' && byte == '\n') { break; }
  5409. prev_byte = byte;
  5410. #endif
  5411. }
  5412. return true;
  5413. }
  5414. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5415. inline void stream_line_reader::append(const char *data, size_t size) {
  5416. // Once the line has outgrown the fixed buffer everything must keep going to
  5417. // the growable one, even if a later chunk would have fit. Without the
  5418. // emptiness check a short append after a long one would land in the fixed
  5419. // buffer, which ptr() and size() no longer look at, and be lost.
  5420. if (growable_buffer_.empty() &&
  5421. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5422. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5423. fixed_buffer_used_size_ += size;
  5424. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5425. } else {
  5426. // Unlike the per-character overload, this can be the very first append of
  5427. // the line, so the fixed buffer may hold nothing and carry no terminator
  5428. // yet. assign() takes an explicit length and does not need one.
  5429. if (growable_buffer_.empty()) {
  5430. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5431. }
  5432. growable_buffer_.append(data, size);
  5433. }
  5434. }
  5435. inline mmap::mmap(const char *path) { open(path); }
  5436. inline mmap::~mmap() { close(); }
  5437. inline bool mmap::open(const char *path) {
  5438. close();
  5439. #if defined(_WIN32)
  5440. auto wpath = u8string_to_wstring(path);
  5441. if (wpath.empty()) { return false; }
  5442. hFile_ =
  5443. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5444. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5445. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5446. LARGE_INTEGER size{};
  5447. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5448. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5449. // See:
  5450. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5451. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5452. size_ = static_cast<size_t>(size.QuadPart);
  5453. hMapping_ =
  5454. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5455. // Special treatment for an empty file...
  5456. if (hMapping_ == NULL && size_ == 0) {
  5457. close();
  5458. is_open_empty_file = true;
  5459. return true;
  5460. }
  5461. if (hMapping_ == NULL) {
  5462. close();
  5463. return false;
  5464. }
  5465. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5466. if (addr_ == nullptr) {
  5467. close();
  5468. return false;
  5469. }
  5470. #else
  5471. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5472. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5473. if (fd_ == -1) { return false; }
  5474. // Only a regular file has a size to serve, unlike a directory or a device.
  5475. struct stat sb;
  5476. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5477. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5478. close();
  5479. return false;
  5480. }
  5481. size_ = static_cast<size_t>(sb.st_size);
  5482. #endif
  5483. return true;
  5484. }
  5485. inline bool mmap::is_open() const {
  5486. #if defined(_WIN32)
  5487. return is_open_empty_file ? true : addr_ != nullptr;
  5488. #else
  5489. return fd_ != -1;
  5490. #endif
  5491. }
  5492. inline size_t mmap::size() const { return size_; }
  5493. inline void mmap::close() {
  5494. #if defined(_WIN32)
  5495. if (addr_) {
  5496. ::UnmapViewOfFile(addr_);
  5497. addr_ = nullptr;
  5498. }
  5499. if (hMapping_) {
  5500. ::CloseHandle(hMapping_);
  5501. hMapping_ = NULL;
  5502. }
  5503. if (hFile_ != INVALID_HANDLE_VALUE) {
  5504. ::CloseHandle(hFile_);
  5505. hFile_ = INVALID_HANDLE_VALUE;
  5506. }
  5507. is_open_empty_file = false;
  5508. #else
  5509. if (fd_ != -1) {
  5510. ::close(fd_);
  5511. fd_ = -1;
  5512. }
  5513. #endif
  5514. size_ = 0;
  5515. }
  5516. inline int close_socket(socket_t sock) noexcept {
  5517. #ifdef _WIN32
  5518. return closesocket(sock);
  5519. #else
  5520. return close(sock);
  5521. #endif
  5522. }
  5523. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5524. ssize_t res = 0;
  5525. while (true) {
  5526. res = fn();
  5527. if (res < 0 && errno == EINTR) {
  5528. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5529. continue;
  5530. }
  5531. break;
  5532. }
  5533. return res;
  5534. }
  5535. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5536. if (offset >= size_) { return 0; }
  5537. len = (std::min)(len, size_ - offset);
  5538. #if defined(_WIN32)
  5539. // Windows does not let a mapped file be truncated.
  5540. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5541. return len;
  5542. #else
  5543. auto n = handle_EINTR(
  5544. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5545. return n > 0 ? static_cast<size_t>(n) : 0;
  5546. #endif
  5547. }
  5548. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5549. return handle_EINTR([&]() {
  5550. return recv(sock,
  5551. #ifdef _WIN32
  5552. static_cast<char *>(ptr), static_cast<int>(size),
  5553. #else
  5554. ptr, size,
  5555. #endif
  5556. flags);
  5557. });
  5558. }
  5559. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5560. int flags) {
  5561. return handle_EINTR([&]() {
  5562. return send(sock,
  5563. #ifdef _WIN32
  5564. static_cast<const char *>(ptr), static_cast<int>(size),
  5565. #else
  5566. ptr, size,
  5567. #endif
  5568. flags);
  5569. });
  5570. }
  5571. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5572. #ifdef _WIN32
  5573. return ::WSAPoll(fds, nfds, timeout);
  5574. #else
  5575. return ::poll(fds, nfds, timeout);
  5576. #endif
  5577. }
  5578. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5579. time_t usec) {
  5580. struct pollfd pfd;
  5581. pfd.fd = sock;
  5582. pfd.events = events;
  5583. pfd.revents = 0;
  5584. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5585. // "return immediately", which callers here rely on to probe a socket.
  5586. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5587. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5588. }
  5589. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5590. return select_impl(sock, POLLIN, sec, usec);
  5591. }
  5592. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5593. return select_impl(sock, POLLOUT, sec, usec);
  5594. }
  5595. // The point sec and usec from now, for select_until(). A negative sec never
  5596. // comes, as a negative timeout waits forever in select_impl().
  5597. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5598. time_t usec) {
  5599. if (sec < 0) { return (std::chrono::steady_clock::time_point::max)(); }
  5600. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5601. std::chrono::microseconds(usec);
  5602. }
  5603. // Waits only for the time left until deadline, so that all the waits of one
  5604. // TLS handshake come out of a single timeout.
  5605. inline ssize_t select_until(socket_t sock, short events,
  5606. std::chrono::steady_clock::time_point deadline) {
  5607. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5608. return select_impl(sock, events, -1, 0);
  5609. }
  5610. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5611. deadline - std::chrono::steady_clock::now())
  5612. .count();
  5613. if (left <= 0) { return 0; }
  5614. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5615. static_cast<time_t>(left % 1000000));
  5616. }
  5617. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5618. time_t usec) {
  5619. struct pollfd pfd_read;
  5620. pfd_read.fd = sock;
  5621. pfd_read.events = POLLIN | POLLOUT;
  5622. pfd_read.revents = 0;
  5623. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5624. auto poll_res =
  5625. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5626. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5627. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5628. auto error = 0;
  5629. socklen_t len = sizeof(error);
  5630. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5631. reinterpret_cast<char *>(&error), &len);
  5632. auto successful = res >= 0 && !error;
  5633. return successful ? Error::Success : Error::Connection;
  5634. }
  5635. return Error::Connection;
  5636. }
  5637. inline bool is_socket_alive(socket_t sock) {
  5638. const auto val = detail::select_read(sock, 0, 0);
  5639. if (val == 0) {
  5640. return true;
  5641. } else if (val < 0 && errno == EBADF) {
  5642. return false;
  5643. }
  5644. char buf[1];
  5645. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5646. }
  5647. class SocketStream final : public Stream {
  5648. public:
  5649. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5650. time_t write_timeout_sec, time_t write_timeout_usec,
  5651. time_t max_timeout_msec = 0,
  5652. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5653. (std::chrono::steady_clock::time_point::min)());
  5654. ~SocketStream() override;
  5655. bool is_readable() const override;
  5656. bool wait_readable() const override;
  5657. bool wait_writable() const override;
  5658. bool is_peer_alive() const override;
  5659. ssize_t read(char *ptr, size_t size) override;
  5660. ssize_t write(const char *ptr, size_t size) override;
  5661. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5662. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5663. socket_t socket() const override;
  5664. time_t duration() const override;
  5665. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5666. void set_max_timeout(time_t msec) override;
  5667. const char *buffered_data(size_t &size) const override;
  5668. void consume_buffered(size_t size) override;
  5669. // The caller has just seen this socket become readable. Lets the next read
  5670. // skip its own readiness wait, which would otherwise ask the kernel a
  5671. // question that was answered a moment ago. Consumed by that read.
  5672. void set_readable_hint() { readable_hint_ = true; }
  5673. private:
  5674. bool ensure_readable();
  5675. socket_t sock_;
  5676. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5677. // thread while a read is in flight -- that is the point of it, for a caller
  5678. // holding one connection and wanting control back to send on it.
  5679. std::atomic<time_t> read_timeout_sec_;
  5680. std::atomic<time_t> read_timeout_usec_;
  5681. time_t write_timeout_sec_;
  5682. time_t write_timeout_usec_;
  5683. time_t max_timeout_msec_;
  5684. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5685. std::vector<char> read_buff_;
  5686. size_t read_buff_off_ = 0;
  5687. size_t read_buff_content_size_ = 0;
  5688. bool readable_hint_ = false;
  5689. static const size_t read_buff_size_ = 1024l * 4;
  5690. };
  5691. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5692. time_t keep_alive_timeout_sec) {
  5693. using namespace std::chrono;
  5694. const auto interval_usec =
  5695. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5696. // Avoid expensive `steady_clock::now()` call for the first time
  5697. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5698. const auto start = steady_clock::now() - microseconds{interval_usec};
  5699. const auto timeout = seconds{keep_alive_timeout_sec};
  5700. while (true) {
  5701. if (svr_sock == INVALID_SOCKET) {
  5702. break; // Server socket is closed
  5703. }
  5704. auto val = select_read(sock, 0, interval_usec);
  5705. if (val < 0) {
  5706. break; // Ssocket error
  5707. } else if (val == 0) {
  5708. if (steady_clock::now() - start > timeout) {
  5709. break; // Timeout
  5710. }
  5711. } else {
  5712. return true; // Ready for read
  5713. }
  5714. }
  5715. return false;
  5716. }
  5717. // `has_buffered_request` reports whether the connection's stream already holds
  5718. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5719. // 9.3.2), so reading one request can pull the start of the next one into the
  5720. // stream's buffer; that request must be served without waiting for the socket
  5721. // to become readable again, since its bytes are no longer on the socket.
  5722. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5723. template <typename P, typename T>
  5724. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5725. socket_t sock,
  5726. size_t keep_alive_max_count,
  5727. time_t keep_alive_timeout_sec,
  5728. P has_buffered_request, T callback) {
  5729. auto ret = false;
  5730. // A keep_alive_max_count of 0 sets no limit.
  5731. for (size_t served = 0;
  5732. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5733. auto socket_readable = false;
  5734. if (!has_buffered_request()) {
  5735. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5736. socket_readable = true;
  5737. }
  5738. auto close_connection = served + 1 == keep_alive_max_count;
  5739. auto connection_closed = false;
  5740. ret = callback(socket_readable, close_connection, connection_closed);
  5741. if (!ret || connection_closed) { break; }
  5742. }
  5743. return ret;
  5744. }
  5745. template <typename T>
  5746. inline bool
  5747. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5748. size_t keep_alive_max_count,
  5749. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5750. time_t read_timeout_usec, time_t write_timeout_sec,
  5751. time_t write_timeout_usec, T callback) {
  5752. // One stream per connection: its read buffer can already hold the start of
  5753. // the next, pipelined request.
  5754. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5755. write_timeout_sec, write_timeout_usec);
  5756. return process_server_socket_core(
  5757. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5758. [&]() { return strm.is_readable(); },
  5759. [&](bool socket_readable, bool close_connection,
  5760. bool &connection_closed) {
  5761. if (socket_readable) { strm.set_readable_hint(); }
  5762. return callback(strm, close_connection, connection_closed);
  5763. });
  5764. }
  5765. inline bool process_client_socket(
  5766. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5767. time_t write_timeout_sec, time_t write_timeout_usec,
  5768. time_t max_timeout_msec,
  5769. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5770. std::function<bool(Stream &)> callback) {
  5771. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5772. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5773. start_time);
  5774. return callback(strm);
  5775. }
  5776. inline int shutdown_socket(socket_t sock) noexcept {
  5777. #ifdef _WIN32
  5778. return shutdown(sock, SD_BOTH);
  5779. #else
  5780. return shutdown(sock, SHUT_RDWR);
  5781. #endif
  5782. }
  5783. // Half-closes the write side and drains any in-flight/queued bytes before
  5784. // the final shutdown+close. Closing with unread data in the receive queue
  5785. // (or bytes arriving after the receive side is closed) makes the stack send
  5786. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5787. // response as a failed read even though it was fully written.
  5788. inline void drain_and_close_socket(socket_t sock) noexcept {
  5789. #ifdef _WIN32
  5790. shutdown(sock, SD_SEND);
  5791. #else
  5792. shutdown(sock, SHUT_WR);
  5793. #endif
  5794. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5795. size_t total = 0;
  5796. const auto deadline = std::chrono::steady_clock::now() +
  5797. std::chrono::milliseconds(100); // bound #1
  5798. while (total < size_t(1024u * 1024u)) { // bound #2
  5799. const auto remaining =
  5800. std::chrono::duration_cast<std::chrono::microseconds>(
  5801. deadline - std::chrono::steady_clock::now())
  5802. .count();
  5803. if (remaining <= 0) { break; }
  5804. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5805. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5806. if (n <= 0) { break; }
  5807. total += static_cast<size_t>(n);
  5808. }
  5809. shutdown_socket(sock);
  5810. close_socket(sock);
  5811. }
  5812. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5813. if (s.size() > 1 && s[0] == '\0') {
  5814. auto ret = s;
  5815. ret[0] = '@';
  5816. return ret;
  5817. }
  5818. return s;
  5819. }
  5820. inline std::string
  5821. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5822. if (s.size() > 1 && s[0] == '@') {
  5823. auto ret = s;
  5824. ret[0] = '\0';
  5825. return ret;
  5826. }
  5827. return s;
  5828. }
  5829. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5830. const struct addrinfo *hints,
  5831. struct addrinfo **res, time_t timeout_sec) {
  5832. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5833. if (timeout_sec <= 0) {
  5834. // No timeout specified, use standard getaddrinfo
  5835. return getaddrinfo(node, service, hints, res);
  5836. }
  5837. #ifdef _WIN32
  5838. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5839. OVERLAPPED overlapped = {};
  5840. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5841. if (!event) { return EAI_FAIL; }
  5842. overlapped.hEvent = event;
  5843. PADDRINFOEXW result_addrinfo = nullptr;
  5844. HANDLE cancel_handle = nullptr;
  5845. ADDRINFOEXW hints_ex = {};
  5846. if (hints) {
  5847. hints_ex.ai_flags = hints->ai_flags;
  5848. hints_ex.ai_family = hints->ai_family;
  5849. hints_ex.ai_socktype = hints->ai_socktype;
  5850. hints_ex.ai_protocol = hints->ai_protocol;
  5851. }
  5852. auto wnode = u8string_to_wstring(node);
  5853. auto wservice = u8string_to_wstring(service);
  5854. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5855. hints ? &hints_ex : nullptr, &result_addrinfo,
  5856. nullptr, &overlapped, nullptr, &cancel_handle);
  5857. if (ret == WSA_IO_PENDING) {
  5858. auto wait_result =
  5859. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5860. if (wait_result == WAIT_TIMEOUT) {
  5861. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5862. ::CloseHandle(event);
  5863. return EAI_AGAIN;
  5864. }
  5865. DWORD bytes_returned;
  5866. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5867. &bytes_returned, FALSE)) {
  5868. ::CloseHandle(event);
  5869. return ::WSAGetLastError();
  5870. }
  5871. }
  5872. ::CloseHandle(event);
  5873. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5874. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5875. return 0;
  5876. }
  5877. return ret;
  5878. #elif TARGET_OS_MAC && defined(__clang__)
  5879. if (!node) { return EAI_NONAME; }
  5880. // macOS implementation using CFHost API for asynchronous DNS resolution
  5881. CFStringRef hostname_ref = CFStringCreateWithCString(
  5882. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5883. if (!hostname_ref) { return EAI_MEMORY; }
  5884. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5885. CFRelease(hostname_ref);
  5886. if (!host_ref) { return EAI_MEMORY; }
  5887. // Set up context for callback
  5888. struct CFHostContext {
  5889. bool completed = false;
  5890. bool success = false;
  5891. CFArrayRef addresses = nullptr;
  5892. std::mutex mutex;
  5893. std::condition_variable cv;
  5894. } context;
  5895. CFHostClientContext client_context;
  5896. memset(&client_context, 0, sizeof(client_context));
  5897. client_context.info = &context;
  5898. // Set callback
  5899. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5900. const CFStreamError *error, void *info) {
  5901. auto ctx = static_cast<CFHostContext *>(info);
  5902. std::lock_guard<std::mutex> lock(ctx->mutex);
  5903. if (error && error->error != 0) {
  5904. ctx->success = false;
  5905. } else {
  5906. Boolean hasBeenResolved;
  5907. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5908. if (ctx->addresses && hasBeenResolved) {
  5909. CFRetain(ctx->addresses);
  5910. ctx->success = true;
  5911. } else {
  5912. ctx->success = false;
  5913. }
  5914. }
  5915. ctx->completed = true;
  5916. ctx->cv.notify_one();
  5917. };
  5918. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5919. CFRelease(host_ref);
  5920. return EAI_SYSTEM;
  5921. }
  5922. // Schedule on run loop
  5923. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5924. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5925. // Start resolution
  5926. CFStreamError stream_error;
  5927. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5928. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5929. CFRelease(host_ref);
  5930. return EAI_FAIL;
  5931. }
  5932. // Wait for completion with timeout
  5933. auto timeout_time =
  5934. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5935. bool timed_out = false;
  5936. {
  5937. std::unique_lock<std::mutex> lock(context.mutex);
  5938. while (!context.completed) {
  5939. auto now = std::chrono::steady_clock::now();
  5940. if (now >= timeout_time) {
  5941. timed_out = true;
  5942. break;
  5943. }
  5944. // Run the runloop for a short time
  5945. lock.unlock();
  5946. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5947. lock.lock();
  5948. }
  5949. }
  5950. // Clean up
  5951. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5952. CFHostSetClient(host_ref, nullptr, nullptr);
  5953. if (timed_out || !context.completed) {
  5954. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5955. CFRelease(host_ref);
  5956. return EAI_AGAIN;
  5957. }
  5958. if (!context.success || !context.addresses) {
  5959. CFRelease(host_ref);
  5960. return EAI_NODATA;
  5961. }
  5962. // Convert CFArray to addrinfo
  5963. CFIndex count = CFArrayGetCount(context.addresses);
  5964. if (count == 0) {
  5965. CFRelease(context.addresses);
  5966. CFRelease(host_ref);
  5967. return EAI_NODATA;
  5968. }
  5969. struct addrinfo *result_addrinfo = nullptr;
  5970. struct addrinfo **current = &result_addrinfo;
  5971. for (CFIndex i = 0; i < count; i++) {
  5972. CFDataRef addr_data =
  5973. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5974. if (!addr_data) continue;
  5975. const struct sockaddr *sockaddr_ptr =
  5976. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5977. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5978. // Allocate addrinfo structure
  5979. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5980. if (!*current) {
  5981. freeaddrinfo(result_addrinfo);
  5982. CFRelease(context.addresses);
  5983. CFRelease(host_ref);
  5984. return EAI_MEMORY;
  5985. }
  5986. memset(*current, 0, sizeof(struct addrinfo));
  5987. // Set up addrinfo fields
  5988. (*current)->ai_family = sockaddr_ptr->sa_family;
  5989. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5990. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5991. (*current)->ai_addrlen = sockaddr_len;
  5992. // Copy sockaddr
  5993. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5994. if (!(*current)->ai_addr) {
  5995. freeaddrinfo(result_addrinfo);
  5996. CFRelease(context.addresses);
  5997. CFRelease(host_ref);
  5998. return EAI_MEMORY;
  5999. }
  6000. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6001. // Set port if service is specified
  6002. if (service && *service) {
  6003. int port = 0;
  6004. if (parse_port(service, strlen(service), port)) {
  6005. if (sockaddr_ptr->sa_family == AF_INET) {
  6006. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6007. ->sin_port = htons(static_cast<uint16_t>(port));
  6008. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6009. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6010. ->sin6_port = htons(static_cast<uint16_t>(port));
  6011. }
  6012. }
  6013. }
  6014. current = &((*current)->ai_next);
  6015. }
  6016. CFRelease(context.addresses);
  6017. CFRelease(host_ref);
  6018. *res = result_addrinfo;
  6019. return 0;
  6020. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6021. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6022. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6023. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6024. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6025. // the resolver worker still references the stack-local gaicb. The cancel
  6026. // path therefore waits (gai_suspend with no timeout) for the worker to
  6027. // actually finish before letting the stack frame go. The trade-off is that
  6028. // a wedged DNS server can hold this thread for the system resolver timeout
  6029. // (~30s by default) past the caller's connection timeout.
  6030. struct gaicb request{};
  6031. struct gaicb *requests[1] = {&request};
  6032. struct sigevent sevp{};
  6033. struct timespec timeout{timeout_sec, 0};
  6034. request.ar_name = node;
  6035. request.ar_service = service;
  6036. request.ar_request = hints;
  6037. sevp.sigev_notify = SIGEV_NONE;
  6038. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6039. if (rc != 0) { return rc; }
  6040. auto cleanup = scope_exit([&] {
  6041. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6042. });
  6043. int wait_result = gai_suspend(requests, 1, &timeout);
  6044. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6045. int gai_result = gai_error(&request);
  6046. if (gai_result == 0) {
  6047. *res = request.ar_result;
  6048. request.ar_result = nullptr;
  6049. return 0;
  6050. }
  6051. return gai_result;
  6052. }
  6053. gai_cancel(&request);
  6054. while (gai_error(&request) == EAI_INPROGRESS) {
  6055. gai_suspend(requests, 1, nullptr);
  6056. }
  6057. return wait_result;
  6058. #else
  6059. // Fallback implementation using thread-based timeout for other Unix systems.
  6060. struct GetAddrInfoState {
  6061. ~GetAddrInfoState() {
  6062. if (info) { freeaddrinfo(info); }
  6063. }
  6064. std::mutex mutex;
  6065. std::condition_variable result_cv;
  6066. bool completed = false;
  6067. int result = EAI_SYSTEM;
  6068. std::string node;
  6069. std::string service;
  6070. struct addrinfo hints;
  6071. struct addrinfo *info = nullptr;
  6072. };
  6073. // Allocate on the heap, so the resolver thread can keep using the data.
  6074. auto state = std::make_shared<GetAddrInfoState>();
  6075. if (node) { state->node = node; }
  6076. state->service = service;
  6077. state->hints = *hints;
  6078. std::thread resolve_thread([state]() {
  6079. auto thread_result =
  6080. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6081. &state->info);
  6082. std::lock_guard<std::mutex> lock(state->mutex);
  6083. state->result = thread_result;
  6084. state->completed = true;
  6085. state->result_cv.notify_one();
  6086. });
  6087. // Wait for completion or timeout
  6088. std::unique_lock<std::mutex> lock(state->mutex);
  6089. auto finished =
  6090. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6091. [&] { return state->completed; });
  6092. if (finished) {
  6093. // Operation completed within timeout
  6094. resolve_thread.join();
  6095. *res = state->info;
  6096. state->info = nullptr; // Pass ownership to caller
  6097. return state->result;
  6098. } else {
  6099. // Timeout occurred
  6100. resolve_thread.detach(); // Let the thread finish in background
  6101. return EAI_AGAIN; // Return timeout error
  6102. }
  6103. #endif
  6104. #else
  6105. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6106. return getaddrinfo(node, service, hints, res);
  6107. #endif
  6108. }
  6109. template <typename BindOrConnect>
  6110. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6111. int address_family, int socket_flags, bool tcp_nodelay,
  6112. bool ipv6_v6only, SocketOptions socket_options,
  6113. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6114. // Get address info
  6115. const char *node = nullptr;
  6116. struct addrinfo hints;
  6117. struct addrinfo *result;
  6118. memset(&hints, 0, sizeof(struct addrinfo));
  6119. hints.ai_socktype = SOCK_STREAM;
  6120. hints.ai_protocol = IPPROTO_IP;
  6121. if (!ip.empty()) {
  6122. node = ip.c_str();
  6123. // Ask getaddrinfo to convert IP in c-string to address
  6124. hints.ai_family = AF_UNSPEC;
  6125. hints.ai_flags = AI_NUMERICHOST;
  6126. } else {
  6127. if (!host.empty()) { node = host.c_str(); }
  6128. hints.ai_family = address_family;
  6129. hints.ai_flags = socket_flags;
  6130. }
  6131. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6132. if (hints.ai_family == AF_UNIX) {
  6133. const auto addrlen = host.length();
  6134. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6135. #ifdef SOCK_CLOEXEC
  6136. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6137. hints.ai_protocol);
  6138. #else
  6139. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6140. #endif
  6141. if (sock != INVALID_SOCKET) {
  6142. sockaddr_un addr{};
  6143. addr.sun_family = AF_UNIX;
  6144. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6145. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6146. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6147. hints.ai_addrlen = static_cast<socklen_t>(
  6148. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6149. #ifndef SOCK_CLOEXEC
  6150. #ifndef _WIN32
  6151. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6152. #endif
  6153. #endif
  6154. if (socket_options) { socket_options(sock); }
  6155. #ifdef _WIN32
  6156. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6157. // remove the option.
  6158. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6159. #endif
  6160. bool dummy;
  6161. if (!bind_or_connect(sock, hints, dummy)) {
  6162. close_socket(sock);
  6163. sock = INVALID_SOCKET;
  6164. }
  6165. }
  6166. return sock;
  6167. }
  6168. #endif
  6169. auto service = std::to_string(port);
  6170. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6171. timeout_sec)) {
  6172. #if defined __linux__ && !defined __ANDROID__
  6173. res_init();
  6174. #endif
  6175. return INVALID_SOCKET;
  6176. }
  6177. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6178. for (auto rp = result; rp; rp = rp->ai_next) {
  6179. // Create a socket
  6180. #ifdef _WIN32
  6181. auto sock =
  6182. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6183. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6184. /**
  6185. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6186. * and above the socket creation fails on older Windows Systems.
  6187. *
  6188. * Let's try to create a socket the old way in this case.
  6189. *
  6190. * Reference:
  6191. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6192. *
  6193. * WSA_FLAG_NO_HANDLE_INHERIT:
  6194. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6195. * SP1, and later
  6196. *
  6197. */
  6198. if (sock == INVALID_SOCKET) {
  6199. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6200. }
  6201. #else
  6202. #ifdef SOCK_CLOEXEC
  6203. auto sock =
  6204. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6205. #else
  6206. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6207. #endif
  6208. #endif
  6209. if (sock == INVALID_SOCKET) { continue; }
  6210. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6211. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6212. close_socket(sock);
  6213. continue;
  6214. }
  6215. #endif
  6216. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6217. if (rp->ai_family == AF_INET6) {
  6218. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6219. }
  6220. if (socket_options) { socket_options(sock); }
  6221. // bind or connect
  6222. auto quit = false;
  6223. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6224. close_socket(sock);
  6225. if (quit) { break; }
  6226. }
  6227. return INVALID_SOCKET;
  6228. }
  6229. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6230. #ifdef _WIN32
  6231. auto flags = nonblocking ? 1UL : 0UL;
  6232. ioctlsocket(sock, FIONBIO, &flags);
  6233. #else
  6234. auto flags = fcntl(sock, F_GETFL, 0);
  6235. fcntl(sock, F_SETFL,
  6236. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6237. #endif
  6238. }
  6239. inline bool is_connection_error() {
  6240. #ifdef _WIN32
  6241. return WSAGetLastError() != WSAEWOULDBLOCK;
  6242. #else
  6243. return errno != EINPROGRESS;
  6244. #endif
  6245. }
  6246. // accept() failed because the process or the network stack is temporarily out
  6247. // of resources. The listening socket is still usable, so back off briefly and
  6248. // try again.
  6249. inline bool is_accept_resource_error() {
  6250. #ifdef _WIN32
  6251. auto err = WSAGetLastError();
  6252. return err == WSAEMFILE || err == WSAENOBUFS;
  6253. #else
  6254. auto err = errno;
  6255. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6256. #endif
  6257. }
  6258. // accept() failed for a reason that says nothing about the listening socket:
  6259. // the pending connection went away before it could be accepted, or the call
  6260. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6261. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6262. // connection that way.
  6263. inline bool is_accept_transient_error() {
  6264. #ifdef _WIN32
  6265. auto err = WSAGetLastError();
  6266. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6267. err == WSAECONNABORTED;
  6268. #else
  6269. auto err = errno;
  6270. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6271. err == ECONNABORTED;
  6272. #endif
  6273. }
  6274. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6275. struct addrinfo hints;
  6276. struct addrinfo *result;
  6277. memset(&hints, 0, sizeof(struct addrinfo));
  6278. hints.ai_family = AF_UNSPEC;
  6279. hints.ai_socktype = SOCK_STREAM;
  6280. hints.ai_protocol = 0;
  6281. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6282. return false;
  6283. }
  6284. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6285. auto ret = false;
  6286. for (auto rp = result; rp; rp = rp->ai_next) {
  6287. const auto &ai = *rp;
  6288. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6289. ret = true;
  6290. break;
  6291. }
  6292. }
  6293. return ret;
  6294. }
  6295. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6296. #define USE_IF2IP
  6297. #endif
  6298. #ifdef USE_IF2IP
  6299. inline std::string if2ip(int address_family, const std::string &ifn) {
  6300. struct ifaddrs *ifap;
  6301. getifaddrs(&ifap);
  6302. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6303. std::string addr_candidate;
  6304. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6305. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6306. (AF_UNSPEC == address_family ||
  6307. ifa->ifa_addr->sa_family == address_family)) {
  6308. if (ifa->ifa_addr->sa_family == AF_INET) {
  6309. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6310. char buf[INET_ADDRSTRLEN];
  6311. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6312. return std::string(buf, INET_ADDRSTRLEN);
  6313. }
  6314. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6315. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6316. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6317. char buf[INET6_ADDRSTRLEN] = {};
  6318. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6319. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6320. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6321. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6322. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6323. } else {
  6324. return std::string(buf, INET6_ADDRSTRLEN);
  6325. }
  6326. }
  6327. }
  6328. }
  6329. }
  6330. }
  6331. return addr_candidate;
  6332. }
  6333. #endif
  6334. inline socket_t create_client_socket(
  6335. const std::string &host, const std::string &ip, int port,
  6336. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6337. SocketOptions socket_options, time_t connection_timeout_sec,
  6338. time_t connection_timeout_usec, time_t read_timeout_sec,
  6339. time_t read_timeout_usec, time_t write_timeout_sec,
  6340. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6341. auto sock = create_socket(
  6342. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6343. std::move(socket_options),
  6344. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6345. if (!intf.empty()) {
  6346. #ifdef USE_IF2IP
  6347. auto ip_from_if = if2ip(address_family, intf);
  6348. if (ip_from_if.empty()) { ip_from_if = intf; }
  6349. if (!bind_ip_address(sock2, ip_from_if)) {
  6350. error = Error::BindIPAddress;
  6351. return false;
  6352. }
  6353. #endif
  6354. }
  6355. set_nonblocking(sock2, true);
  6356. auto ret =
  6357. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6358. if (ret < 0) {
  6359. if (is_connection_error()) {
  6360. error = Error::Connection;
  6361. return false;
  6362. }
  6363. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6364. connection_timeout_usec);
  6365. if (error != Error::Success) {
  6366. if (error == Error::ConnectionTimeout) { quit = true; }
  6367. return false;
  6368. }
  6369. }
  6370. set_nonblocking(sock2, false);
  6371. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6372. read_timeout_usec);
  6373. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6374. write_timeout_usec);
  6375. error = Error::Success;
  6376. return true;
  6377. },
  6378. connection_timeout_sec); // Pass DNS timeout
  6379. if (sock != INVALID_SOCKET) {
  6380. error = Error::Success;
  6381. } else {
  6382. if (error == Error::Success) { error = Error::Connection; }
  6383. }
  6384. return sock;
  6385. }
  6386. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6387. socklen_t addr_len, std::string &ip, int &port) {
  6388. if (addr.ss_family == AF_INET) {
  6389. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6390. } else if (addr.ss_family == AF_INET6) {
  6391. port =
  6392. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6393. } else {
  6394. return false;
  6395. }
  6396. std::array<char, NI_MAXHOST> ipstr{};
  6397. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6398. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6399. 0, NI_NUMERICHOST)) {
  6400. return false;
  6401. }
  6402. ip = ipstr.data();
  6403. return true;
  6404. }
  6405. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6406. struct sockaddr_storage addr;
  6407. socklen_t addr_len = sizeof(addr);
  6408. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6409. &addr_len)) {
  6410. get_ip_and_port(addr, addr_len, ip, port);
  6411. }
  6412. }
  6413. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6414. struct sockaddr_storage addr;
  6415. socklen_t addr_len = sizeof(addr);
  6416. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6417. &addr_len)) {
  6418. #ifndef _WIN32
  6419. if (addr.ss_family == AF_UNIX) {
  6420. #if defined(__linux__)
  6421. struct ucred ucred;
  6422. socklen_t len = sizeof(ucred);
  6423. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6424. port = ucred.pid;
  6425. }
  6426. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6427. pid_t pid;
  6428. socklen_t len = sizeof(pid);
  6429. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6430. port = pid;
  6431. }
  6432. #endif
  6433. return;
  6434. }
  6435. #endif
  6436. get_ip_and_port(addr, addr_len, ip, port);
  6437. }
  6438. }
  6439. inline std::string
  6440. find_content_type(const std::string &path,
  6441. const std::map<std::string, std::string> &user_data,
  6442. const std::string &default_content_type) {
  6443. auto ext = file_extension(path);
  6444. // Extensions are matched regardless of case, as web servers do, with an
  6445. // exact match to a user mapping first
  6446. auto lower_ext = case_ignore::to_lower(ext);
  6447. auto it = user_data.find(ext);
  6448. if (it == user_data.end()) { it = user_data.find(lower_ext); }
  6449. if (it != user_data.end()) { return it->second; }
  6450. static const struct {
  6451. const char *ext;
  6452. const char *type;
  6453. } types[] = {
  6454. {"css", "text/css"},
  6455. {"csv", "text/csv"},
  6456. {"htm", "text/html"},
  6457. {"html", "text/html"},
  6458. {"js", "text/javascript"},
  6459. {"mjs", "text/javascript"},
  6460. {"txt", "text/plain"},
  6461. {"vtt", "text/vtt"},
  6462. {"apng", "image/apng"},
  6463. {"avif", "image/avif"},
  6464. {"bmp", "image/bmp"},
  6465. {"gif", "image/gif"},
  6466. {"png", "image/png"},
  6467. {"svg", "image/svg+xml"},
  6468. {"webp", "image/webp"},
  6469. {"ico", "image/x-icon"},
  6470. {"tif", "image/tiff"},
  6471. {"tiff", "image/tiff"},
  6472. {"jpg", "image/jpeg"},
  6473. {"jpeg", "image/jpeg"},
  6474. {"mp4", "video/mp4"},
  6475. {"mpeg", "video/mpeg"},
  6476. {"webm", "video/webm"},
  6477. {"mp3", "audio/mp3"},
  6478. {"mpga", "audio/mpeg"},
  6479. {"weba", "audio/webm"},
  6480. {"wav", "audio/wave"},
  6481. {"otf", "font/otf"},
  6482. {"ttf", "font/ttf"},
  6483. {"woff", "font/woff"},
  6484. {"woff2", "font/woff2"},
  6485. {"7z", "application/x-7z-compressed"},
  6486. {"atom", "application/atom+xml"},
  6487. {"pdf", "application/pdf"},
  6488. {"json", "application/json"},
  6489. {"rss", "application/rss+xml"},
  6490. {"tar", "application/x-tar"},
  6491. {"xht", "application/xhtml+xml"},
  6492. {"xhtml", "application/xhtml+xml"},
  6493. {"xslt", "application/xslt+xml"},
  6494. {"xml", "application/xml"},
  6495. {"gz", "application/gzip"},
  6496. {"zip", "application/zip"},
  6497. {"wasm", "application/wasm"},
  6498. };
  6499. for (const auto &t : types) {
  6500. if (lower_ext == t.ext) { return t.type; }
  6501. }
  6502. return default_content_type;
  6503. }
  6504. inline std::string
  6505. extract_media_type(const std::string &content_type,
  6506. std::map<std::string, std::string> *params = nullptr) {
  6507. // Extract type/subtype from Content-Type value (RFC 2045)
  6508. // e.g. "application/json; charset=utf-8" -> "application/json"
  6509. auto media_type = content_type;
  6510. auto semicolon_pos = media_type.find(';');
  6511. if (semicolon_pos != std::string::npos) {
  6512. auto param_str = media_type.substr(semicolon_pos + 1);
  6513. media_type = media_type.substr(0, semicolon_pos);
  6514. if (params) {
  6515. // Parse parameters: key=value pairs separated by ';'
  6516. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6517. [&](const char *b, const char *e) {
  6518. std::string key;
  6519. std::string val;
  6520. divide_param_pair(b, e, key, val);
  6521. // Parameter names are case-insensitive (RFC 9110
  6522. // §5.6.6)
  6523. if (!key.empty()) {
  6524. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6525. unquote_param(val));
  6526. }
  6527. });
  6528. }
  6529. }
  6530. // Trim whitespace from media type
  6531. return trim_copy(media_type);
  6532. }
  6533. inline bool can_compress_content_type(const std::string &content_type) {
  6534. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6535. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6536. static const char *const compressible[] = {
  6537. "image/svg+xml",
  6538. "application/javascript",
  6539. "application/x-javascript",
  6540. "application/json",
  6541. "application/ld+json",
  6542. "application/xml",
  6543. "application/xhtml+xml",
  6544. "application/rss+xml",
  6545. "application/atom+xml",
  6546. "application/xslt+xml",
  6547. "application/protobuf",
  6548. };
  6549. for (auto type : compressible) {
  6550. if (mime_type == type) { return true; }
  6551. }
  6552. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6553. }
  6554. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6555. double &quality) {
  6556. quality = 1.0;
  6557. token.clear();
  6558. // Split on first ';': left = token name, right = parameters
  6559. const char *params_b = nullptr;
  6560. std::size_t params_len = 0;
  6561. divide(
  6562. b, static_cast<std::size_t>(e - b), ';',
  6563. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6564. auto r = trim(lb, lb + llen, 0, llen);
  6565. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6566. params_b = rb;
  6567. params_len = rlen;
  6568. });
  6569. if (token.empty()) { return false; }
  6570. if (params_len == 0) { return true; }
  6571. // Scan parameters for q= (stops on first match)
  6572. bool invalid = false;
  6573. split_find(params_b, params_b + params_len, ';',
  6574. (std::numeric_limits<size_t>::max)(),
  6575. [&](const char *pb, const char *pe) -> bool {
  6576. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6577. auto len = static_cast<size_t>(pe - pb);
  6578. if (len < 2) { return false; }
  6579. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6580. return false;
  6581. }
  6582. // Trim the value portion
  6583. auto r = trim(pb, pe, 2, len);
  6584. if (r.first >= r.second) {
  6585. invalid = true;
  6586. return true;
  6587. }
  6588. double v = 0.0;
  6589. auto res = from_chars(pb + r.first, pb + r.second, v);
  6590. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6591. v < 0.0 || v > 1.0) {
  6592. invalid = true;
  6593. return true;
  6594. }
  6595. quality = v;
  6596. return true;
  6597. });
  6598. return !invalid;
  6599. }
  6600. inline EncodingType encoding_type(const Request &req,
  6601. const std::string &content_type) {
  6602. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6603. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6604. if (s.empty()) { return EncodingType::None; }
  6605. // Single-pass: iterate tokens and track the best supported encoding.
  6606. // Server preference breaks ties (br > gzip > zstd).
  6607. EncodingType best = EncodingType::None;
  6608. double best_q = 0.0; // q=0 means "not acceptable"
  6609. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6610. auto priority = [](EncodingType t) -> int {
  6611. switch (t) {
  6612. case EncodingType::Brotli: return 0;
  6613. case EncodingType::Gzip: return 1;
  6614. case EncodingType::Zstd: return 2;
  6615. default: return 3;
  6616. }
  6617. };
  6618. std::string name;
  6619. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6620. double quality = 1.0;
  6621. if (!parse_quality(b, e, name, quality)) { return; }
  6622. if (quality <= 0.0) { return; }
  6623. EncodingType type = EncodingType::None;
  6624. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6625. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6626. #endif
  6627. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6628. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6629. type = EncodingType::Gzip;
  6630. }
  6631. #endif
  6632. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6633. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6634. type = EncodingType::Zstd;
  6635. }
  6636. #endif
  6637. if (type == EncodingType::None) { return; }
  6638. // Higher q-value wins; for equal q, server preference breaks ties
  6639. if (quality > best_q ||
  6640. (quality == best_q && priority(type) < priority(best))) {
  6641. best_q = quality;
  6642. best = type;
  6643. }
  6644. });
  6645. return best;
  6646. }
  6647. // `content_type` is taken separately because a file-backed response has not
  6648. // been given one yet when its coding has to be decided.
  6649. inline EncodingType encoding_type(const Request &req, const Response &res,
  6650. const std::string &content_type) {
  6651. // The response already names a content coding of its own: a handler serving
  6652. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6653. // point whose headers name the coding its files are stored in. Applying one
  6654. // on top of that would double-encode the body and append a second
  6655. // `Content-Encoding` field line.
  6656. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6657. return encoding_type(req, content_type);
  6658. }
  6659. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6660. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6661. }
  6662. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6663. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6664. if (type == EncodingType::Gzip) {
  6665. return detail::make_unique<gzip_compressor>();
  6666. }
  6667. #endif
  6668. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6669. if (type == EncodingType::Brotli) {
  6670. return detail::make_unique<brotli_compressor>();
  6671. }
  6672. #endif
  6673. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6674. if (type == EncodingType::Zstd) {
  6675. return detail::make_unique<zstd_compressor>();
  6676. }
  6677. #endif
  6678. (void)type;
  6679. return nullptr;
  6680. }
  6681. inline const char *encoding_name(EncodingType type) {
  6682. switch (type) {
  6683. case EncodingType::Gzip: return "gzip";
  6684. case EncodingType::Brotli: return "br";
  6685. case EncodingType::Zstd: return "zstd";
  6686. default: return "";
  6687. }
  6688. }
  6689. inline bool nocompressor::compress(const char *data, size_t data_length,
  6690. bool /*last*/, Callback callback) {
  6691. if (!data_length) { return true; }
  6692. return callback(data, data_length);
  6693. }
  6694. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6695. inline gzip_compressor::gzip_compressor() {
  6696. std::memset(&strm_, 0, sizeof(strm_));
  6697. strm_.zalloc = Z_NULL;
  6698. strm_.zfree = Z_NULL;
  6699. strm_.opaque = Z_NULL;
  6700. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6701. Z_DEFAULT_STRATEGY) == Z_OK;
  6702. }
  6703. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6704. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6705. bool last, Callback callback) {
  6706. assert(is_valid_);
  6707. do {
  6708. constexpr size_t max_avail_in =
  6709. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6710. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6711. (std::min)(data_length, max_avail_in));
  6712. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6713. data_length -= strm_.avail_in;
  6714. data += strm_.avail_in;
  6715. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6716. auto ret = Z_OK;
  6717. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6718. do {
  6719. strm_.avail_out = static_cast<uInt>(buff.size());
  6720. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6721. ret = deflate(&strm_, flush);
  6722. if (ret == Z_STREAM_ERROR) { return false; }
  6723. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6724. return false;
  6725. }
  6726. } while (strm_.avail_out == 0);
  6727. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6728. (flush == Z_NO_FLUSH && ret == Z_OK));
  6729. assert(strm_.avail_in == 0);
  6730. } while (data_length > 0);
  6731. return true;
  6732. }
  6733. inline gzip_decompressor::gzip_decompressor() {
  6734. std::memset(&strm_, 0, sizeof(strm_));
  6735. strm_.zalloc = Z_NULL;
  6736. strm_.zfree = Z_NULL;
  6737. strm_.opaque = Z_NULL;
  6738. // 15 is the value of wbits, which should be at the maximum possible value
  6739. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6740. // that the stream type should be automatically detected either gzip or
  6741. // deflate.
  6742. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6743. }
  6744. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6745. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6746. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6747. Callback callback) {
  6748. assert(is_valid_);
  6749. auto ret = Z_OK;
  6750. do {
  6751. constexpr size_t max_avail_in =
  6752. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6753. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6754. (std::min)(data_length, max_avail_in));
  6755. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6756. data_length -= strm_.avail_in;
  6757. data += strm_.avail_in;
  6758. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6759. while (strm_.avail_in > 0 && ret == Z_OK) {
  6760. strm_.avail_out = static_cast<uInt>(buff.size());
  6761. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6762. ret = inflate(&strm_, Z_NO_FLUSH);
  6763. assert(ret != Z_STREAM_ERROR);
  6764. switch (ret) {
  6765. case Z_NEED_DICT:
  6766. case Z_DATA_ERROR:
  6767. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6768. }
  6769. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6770. return false;
  6771. }
  6772. }
  6773. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6774. } while (data_length > 0);
  6775. return true;
  6776. }
  6777. #endif
  6778. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6779. inline brotli_compressor::brotli_compressor() {
  6780. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6781. }
  6782. inline brotli_compressor::~brotli_compressor() {
  6783. BrotliEncoderDestroyInstance(state_);
  6784. }
  6785. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6786. bool last, Callback callback) {
  6787. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6788. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6789. auto available_in = data_length;
  6790. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6791. for (;;) {
  6792. if (last) {
  6793. if (BrotliEncoderIsFinished(state_)) { break; }
  6794. } else {
  6795. if (!available_in) { break; }
  6796. }
  6797. auto available_out = buff.size();
  6798. auto next_out = buff.data();
  6799. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6800. &available_out, &next_out, nullptr)) {
  6801. return false;
  6802. }
  6803. auto output_bytes = buff.size() - available_out;
  6804. if (output_bytes) {
  6805. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6806. }
  6807. }
  6808. return true;
  6809. }
  6810. inline brotli_decompressor::brotli_decompressor() {
  6811. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6812. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6813. : BROTLI_DECODER_RESULT_ERROR;
  6814. }
  6815. inline brotli_decompressor::~brotli_decompressor() {
  6816. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6817. }
  6818. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6819. inline bool brotli_decompressor::decompress(const char *data,
  6820. size_t data_length,
  6821. Callback callback) {
  6822. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6823. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6824. return 0;
  6825. }
  6826. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6827. size_t avail_in = data_length;
  6828. size_t total_out;
  6829. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6830. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6831. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6832. char *next_out = buff.data();
  6833. size_t avail_out = buff.size();
  6834. decoder_r = BrotliDecoderDecompressStream(
  6835. decoder_s, &avail_in, &next_in, &avail_out,
  6836. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6837. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6838. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6839. }
  6840. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6841. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6842. }
  6843. #endif
  6844. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6845. inline zstd_compressor::zstd_compressor() {
  6846. ctx_ = ZSTD_createCCtx();
  6847. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6848. }
  6849. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6850. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6851. bool last, Callback callback) {
  6852. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6853. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6854. ZSTD_inBuffer input = {data, data_length, 0};
  6855. bool finished;
  6856. do {
  6857. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6858. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6859. if (ZSTD_isError(remaining)) { return false; }
  6860. if (!callback(buff.data(), output.pos)) { return false; }
  6861. finished = last ? (remaining == 0) : (input.pos == input.size);
  6862. } while (!finished);
  6863. return true;
  6864. }
  6865. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6866. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6867. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6868. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6869. Callback callback) {
  6870. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6871. ZSTD_inBuffer input = {data, data_length, 0};
  6872. while (input.pos < input.size) {
  6873. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6874. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6875. if (ZSTD_isError(remaining)) { return false; }
  6876. if (!callback(buff.data(), output.pos)) { return false; }
  6877. }
  6878. return true;
  6879. }
  6880. #endif
  6881. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6882. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6883. // unknown coding, and its payload would be handed back still compressed.
  6884. inline bool is_zlib_encoding(const std::string &encoding) {
  6885. return case_ignore::equal(encoding, "gzip") ||
  6886. case_ignore::equal(encoding, "deflate");
  6887. }
  6888. inline bool is_brotli_encoding(const std::string &encoding) {
  6889. return case_ignore::equal(encoding, "br");
  6890. }
  6891. inline bool is_zstd_encoding(const std::string &encoding) {
  6892. return case_ignore::equal(encoding, "zstd");
  6893. }
  6894. // Returns true if the content coding is one cpp-httplib is able to decompress
  6895. // when the corresponding support is compiled in.
  6896. inline bool is_known_content_encoding(const std::string &encoding) {
  6897. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6898. is_zstd_encoding(encoding);
  6899. }
  6900. inline std::unique_ptr<decompressor>
  6901. create_decompressor(const std::string &encoding) {
  6902. std::unique_ptr<decompressor> decompressor;
  6903. if (is_zlib_encoding(encoding)) {
  6904. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6905. decompressor = detail::make_unique<gzip_decompressor>();
  6906. #endif
  6907. } else if (is_brotli_encoding(encoding)) {
  6908. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6909. decompressor = detail::make_unique<brotli_decompressor>();
  6910. #endif
  6911. } else if (is_zstd_encoding(encoding)) {
  6912. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6913. decompressor = detail::make_unique<zstd_decompressor>();
  6914. #endif
  6915. }
  6916. return decompressor;
  6917. }
  6918. // Returns the best available compressor and its Content-Encoding name.
  6919. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6920. inline std::pair<std::unique_ptr<compressor>, const char *>
  6921. create_compressor() {
  6922. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6923. return {detail::make_unique<brotli_compressor>(), "br"};
  6924. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6925. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6926. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6927. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6928. #else
  6929. return {nullptr, nullptr};
  6930. #endif
  6931. }
  6932. inline bool is_prohibited_header_name(const std::string &name) {
  6933. // Field names are case-insensitive (RFC 9110 §5.1)
  6934. return case_ignore::equal(name, "REMOTE_ADDR") ||
  6935. case_ignore::equal(name, "REMOTE_PORT") ||
  6936. case_ignore::equal(name, "LOCAL_ADDR") ||
  6937. case_ignore::equal(name, "LOCAL_PORT");
  6938. }
  6939. inline bool has_header(const Headers &headers, const std::string &key) {
  6940. if (is_prohibited_header_name(key)) { return false; }
  6941. return headers.find(key) != headers.end();
  6942. }
  6943. inline const char *get_header_value(const Headers &headers,
  6944. const std::string &key, const char *def,
  6945. size_t id) {
  6946. if (is_prohibited_header_name(key)) {
  6947. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6948. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6949. throw std::invalid_argument(msg);
  6950. #else
  6951. return "";
  6952. #endif
  6953. }
  6954. auto rng = headers.equal_range(key);
  6955. auto it = bounded_next(rng.first, id, rng.second);
  6956. if (it != rng.second) { return it->second.c_str(); }
  6957. return def;
  6958. }
  6959. inline size_t get_header_value_count(const Headers &headers,
  6960. const std::string &key) {
  6961. return headers.count(key);
  6962. }
  6963. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6964. // list may be sent as several field lines, and the combined field value is
  6965. // those values joined by commas in the order they were received. Callers that
  6966. // parse such a list must work on the combined value; reading only the first
  6967. // occurrence silently drops whatever the later field lines carry.
  6968. inline std::string get_combined_header_value(const Headers &headers,
  6969. const std::string &key) {
  6970. std::string combined;
  6971. auto rng = headers.equal_range(key);
  6972. for (auto it = rng.first; it != rng.second; ++it) {
  6973. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6974. // elements, so an empty field line must not contribute a bare comma to the
  6975. // combined value.
  6976. if (it->second.empty()) { continue; }
  6977. if (!combined.empty()) { combined += ", "; }
  6978. combined += it->second;
  6979. }
  6980. return combined;
  6981. }
  6982. inline bool has_header_token(const Headers &headers, const std::string &key,
  6983. const std::string &token) {
  6984. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6985. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6986. // several lines. Match complete tokens rather than searching the raw value,
  6987. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6988. auto rng = headers.equal_range(key);
  6989. for (auto it = rng.first; it != rng.second; ++it) {
  6990. const auto &value = it->second;
  6991. if (split_find(value.data(), value.data() + value.size(), ',',
  6992. [&](const char *b, const char *e) {
  6993. return case_ignore::equal(std::string(b, e), token);
  6994. })) {
  6995. return true;
  6996. }
  6997. }
  6998. return false;
  6999. }
  7000. template <typename Map>
  7001. inline typename Map::mapped_type
  7002. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7003. auto rng = m.equal_range(key);
  7004. auto it = bounded_next(rng.first, id, rng.second);
  7005. if (it != rng.second) { return it->second; }
  7006. return typename Map::mapped_type();
  7007. }
  7008. inline void set_header(Headers &headers, const std::string &key,
  7009. const std::string &val) {
  7010. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7011. }
  7012. inline bool read_headers(Stream &strm, Headers &headers) {
  7013. const auto bufsiz = 2048;
  7014. char buf[bufsiz];
  7015. stream_line_reader line_reader(strm, buf, bufsiz);
  7016. size_t header_count = 0;
  7017. for (;;) {
  7018. if (!line_reader.getline()) { return false; }
  7019. // Check if the line ends with CRLF.
  7020. auto line_terminator_len = 2;
  7021. if (line_reader.end_with_crlf()) {
  7022. // Blank line indicates end of headers.
  7023. if (line_reader.size() == 2) { break; }
  7024. } else {
  7025. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7026. // Blank line indicates end of headers.
  7027. if (line_reader.size() == 1) { break; }
  7028. line_terminator_len = 1;
  7029. #else
  7030. continue; // Skip invalid line.
  7031. #endif
  7032. }
  7033. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7034. // Check header count limit
  7035. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7036. // Exclude line terminator
  7037. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7038. if (!parse_header(line_reader.ptr(), end,
  7039. [&](const std::string &key, const std::string &val) {
  7040. headers.emplace(key, val);
  7041. })) {
  7042. return false;
  7043. }
  7044. header_count++;
  7045. }
  7046. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7047. // headers that have different values to prevent request smuggling.
  7048. auto cl_range = headers.equal_range("Content-Length");
  7049. if (cl_range.first != cl_range.second) {
  7050. const auto &first_val = cl_range.first->second;
  7051. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7052. if (it->second != first_val) { return false; }
  7053. }
  7054. }
  7055. return true;
  7056. }
  7057. // Parsed by hand: std::regex_match recurses once per character of the reason
  7058. // phrase, which a server can make as long as a whole line.
  7059. inline bool parse_status_line(const char *line, std::string &version,
  7060. int &status, std::string &reason) {
  7061. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7062. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7063. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7064. !is_ascii_digit(line[11])) {
  7065. return false;
  7066. }
  7067. auto p = line + 12;
  7068. auto reason_begin = p;
  7069. if (*p == ' ') {
  7070. reason_begin = ++p;
  7071. p += std::strcspn(p, "\r\n");
  7072. }
  7073. auto reason_end = p;
  7074. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7075. if (*p == '\r') { p++; }
  7076. #else
  7077. if (*p++ != '\r') { return false; }
  7078. #endif
  7079. if (*p++ != '\n' || *p != '\0') { return false; }
  7080. version.assign(line, 8);
  7081. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7082. reason.assign(reason_begin, reason_end);
  7083. return true;
  7084. }
  7085. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7086. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7087. struct WebSocketUpgradeResponse {
  7088. Error error = Error::Success;
  7089. int status = -1;
  7090. Headers headers;
  7091. std::string selected_subprotocol;
  7092. };
  7093. // Reads a response's status line and headers, leaving any body unread. An
  7094. // unparsable status line is no stream error; it just leaves `status` as is.
  7095. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7096. const auto bufsiz = 2048;
  7097. char buf[bufsiz];
  7098. stream_line_reader line_reader(strm, buf, bufsiz);
  7099. if (!line_reader.getline()) { return false; }
  7100. std::string version;
  7101. std::string reason;
  7102. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7103. return true;
  7104. }
  7105. return read_headers(strm, headers);
  7106. }
  7107. inline bool
  7108. read_websocket_upgrade_response(Stream &strm,
  7109. const std::string &expected_accept,
  7110. const std::string &offered_subprotocols,
  7111. WebSocketUpgradeResponse &upgrade) {
  7112. // The headers of a rejection are kept so the caller can see why the server
  7113. // refused the upgrade.
  7114. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7115. upgrade.error = Error::Read;
  7116. return false;
  7117. }
  7118. const auto &headers = upgrade.headers;
  7119. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7120. upgrade.error = Error::WebSocketHandshake;
  7121. return false;
  7122. }
  7123. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7124. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7125. upgrade.error = Error::WebSocketHandshake;
  7126. return false;
  7127. }
  7128. // Verify Connection: Upgrade
  7129. if (!has_header_token(headers, "Connection", "upgrade")) {
  7130. upgrade.error = Error::WebSocketHandshake;
  7131. return false;
  7132. }
  7133. // Verify Sec-WebSocket-Accept header value
  7134. auto it = headers.find("Sec-WebSocket-Accept");
  7135. if (it == headers.end() || it->second != expected_accept) {
  7136. upgrade.error = Error::WebSocketHandshake;
  7137. return false;
  7138. }
  7139. // Extract negotiated subprotocol
  7140. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7141. if (proto_it != headers.end()) {
  7142. upgrade.selected_subprotocol = proto_it->second;
  7143. }
  7144. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7145. if (!upgrade.selected_subprotocol.empty()) {
  7146. auto was_offered = false;
  7147. split(offered_subprotocols.data(),
  7148. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7149. [&](const char *b, const char *e) {
  7150. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7151. was_offered = true;
  7152. }
  7153. });
  7154. if (!was_offered) {
  7155. upgrade.error = Error::WebSocketHandshake;
  7156. return false;
  7157. }
  7158. }
  7159. return true;
  7160. }
  7161. enum class ReadContentResult {
  7162. Success, // Successfully read the content
  7163. PayloadTooLarge, // The content exceeds the specified payload limit
  7164. Error // An error occurred while reading the content
  7165. };
  7166. inline ReadContentResult read_content_with_length(
  7167. Stream &strm, size_t len, DownloadProgress progress,
  7168. ContentReceiverWithProgress out,
  7169. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7170. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7171. detail::BodyReader br;
  7172. br.stream = &strm;
  7173. br.has_content_length = true;
  7174. br.content_length = len;
  7175. br.payload_max_length = payload_max_length;
  7176. br.chunked = false;
  7177. br.bytes_read = 0;
  7178. br.last_error = Error::Success;
  7179. size_t r = 0;
  7180. while (r < len) {
  7181. auto read_len = static_cast<size_t>(len - r);
  7182. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7183. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7184. if (n <= 0) {
  7185. // Check if it was a payload size error
  7186. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7187. return ReadContentResult::PayloadTooLarge;
  7188. }
  7189. return ReadContentResult::Error;
  7190. }
  7191. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7192. return ReadContentResult::Error;
  7193. }
  7194. r += static_cast<size_t>(n);
  7195. if (progress) {
  7196. if (!progress(r, len)) { return ReadContentResult::Error; }
  7197. }
  7198. }
  7199. return ReadContentResult::Success;
  7200. }
  7201. inline ReadContentResult
  7202. read_content_without_length(Stream &strm, size_t payload_max_length,
  7203. ContentReceiverWithProgress out) {
  7204. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7205. size_t r = 0;
  7206. for (;;) {
  7207. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7208. if (n == 0) { return ReadContentResult::Success; }
  7209. if (n < 0) { return ReadContentResult::Error; }
  7210. // Check if adding this data would exceed the payload limit
  7211. if (payload_max_length > 0 &&
  7212. (r > payload_max_length ||
  7213. payload_max_length - r < static_cast<size_t>(n))) {
  7214. return ReadContentResult::PayloadTooLarge;
  7215. }
  7216. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7217. return ReadContentResult::Error;
  7218. }
  7219. r += static_cast<size_t>(n);
  7220. }
  7221. return ReadContentResult::Success;
  7222. }
  7223. template <typename T>
  7224. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7225. size_t payload_max_length,
  7226. ContentReceiverWithProgress out) {
  7227. detail::ChunkedDecoder dec(strm);
  7228. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7229. size_t total_len = 0;
  7230. for (;;) {
  7231. size_t chunk_offset = 0;
  7232. size_t chunk_total = 0;
  7233. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7234. if (n < 0) { return ReadContentResult::Error; }
  7235. if (n == 0) {
  7236. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7237. return ReadContentResult::Error;
  7238. }
  7239. return ReadContentResult::Success;
  7240. }
  7241. if (payload_max_length > 0 &&
  7242. (total_len > payload_max_length ||
  7243. payload_max_length - total_len < static_cast<size_t>(n))) {
  7244. return ReadContentResult::PayloadTooLarge;
  7245. }
  7246. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7247. return ReadContentResult::Error;
  7248. }
  7249. total_len += static_cast<size_t>(n);
  7250. }
  7251. }
  7252. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7253. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7254. // is the final transfer coding. A single field value may list several
  7255. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7256. // several Transfer-Encoding lines, which combine into one comma-separated
  7257. // list in the order the lines were received. Headers preserves that order,
  7258. // so the final coding is the last token of the last line. Match it
  7259. // case-insensitively rather than comparing the whole value against
  7260. // "chunked".
  7261. //
  7262. // Security: reading a chunked message as unframed leaves its body in the
  7263. // socket, where a keep-alive connection parses it as a smuggled request.
  7264. // Server::process_request() answers 400 and closes when the final coding is
  7265. // not chunked, so a request whose framing cannot be determined never
  7266. // reaches the "no body" path.
  7267. auto rng = headers.equal_range("Transfer-Encoding");
  7268. if (rng.first == rng.second) { return false; }
  7269. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7270. // combined list ending in nothing rather than inheriting the line before it.
  7271. std::string last_coding;
  7272. for (auto it = rng.first; it != rng.second; ++it) {
  7273. const auto &value = it->second;
  7274. last_coding.clear();
  7275. split(value.data(), value.data() + value.size(), ',',
  7276. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7277. }
  7278. return case_ignore::equal(last_coding, "chunked");
  7279. }
  7280. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7281. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7282. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7283. return msg.has_header("Transfer-Encoding") &&
  7284. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7285. }
  7286. inline bool has_conflicting_content_length(const Headers &headers) {
  7287. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7288. // Content-Length is framed ambiguously. The body readers here delimit it by
  7289. // the transfer coding and drop Content-Length, while an intermediary may do
  7290. // the reverse, so the two disagree on where the body ends and a reused
  7291. // connection is desynchronised (request/response smuggling). Content-Length:
  7292. // 0 is tolerated for compatibility with existing peers.
  7293. return has_header(headers, "Transfer-Encoding") &&
  7294. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7295. }
  7296. template <typename T, typename U>
  7297. bool prepare_content_receiver(T &x, int &status,
  7298. ContentReceiverWithProgress receiver,
  7299. bool decompress, size_t payload_max_length,
  7300. bool &exceed_payload_max_length, U callback) {
  7301. if (decompress) {
  7302. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7303. std::unique_ptr<decompressor> decompressor;
  7304. if (!encoding.empty()) {
  7305. // A coding we know about but were not built with is an error. An
  7306. // unrecognized coding (including "identity") is left alone and the
  7307. // payload is passed through as-is, since some servers misuse the header,
  7308. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7309. decompressor = detail::create_decompressor(encoding);
  7310. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7311. status = StatusCode::UnsupportedMediaType_415;
  7312. return false;
  7313. }
  7314. }
  7315. if (decompressor) {
  7316. if (decompressor->is_valid()) {
  7317. size_t decompressed_size = 0;
  7318. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7319. size_t off, size_t len) {
  7320. return decompressor->decompress(
  7321. buf, n, [&](const char *buf2, size_t n2) {
  7322. // Guard against zip-bomb: check
  7323. // decompressed size against limit.
  7324. if (payload_max_length > 0 &&
  7325. (decompressed_size >= payload_max_length ||
  7326. n2 > payload_max_length - decompressed_size)) {
  7327. exceed_payload_max_length = true;
  7328. return false;
  7329. }
  7330. decompressed_size += n2;
  7331. return receiver(buf2, n2, off, len);
  7332. });
  7333. };
  7334. return callback(std::move(out));
  7335. } else {
  7336. status = StatusCode::InternalServerError_500;
  7337. return false;
  7338. }
  7339. }
  7340. }
  7341. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7342. size_t len) {
  7343. return receiver(buf, n, off, len);
  7344. };
  7345. return callback(std::move(out));
  7346. }
  7347. template <typename T>
  7348. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7349. DownloadProgress progress,
  7350. ContentReceiverWithProgress receiver, bool decompress) {
  7351. bool exceed_payload_max_length = false;
  7352. return prepare_content_receiver(
  7353. x, status, std::move(receiver), decompress, payload_max_length,
  7354. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7355. auto ret = true;
  7356. // Note: exceed_payload_max_length may also be set by the decompressor
  7357. // wrapper in prepare_content_receiver when the decompressed payload
  7358. // size exceeds the limit.
  7359. if (is_chunked_transfer_encoding(x.headers)) {
  7360. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7361. if (result == ReadContentResult::Success) {
  7362. ret = true;
  7363. } else if (result == ReadContentResult::PayloadTooLarge) {
  7364. exceed_payload_max_length = true;
  7365. ret = false;
  7366. } else {
  7367. ret = false;
  7368. }
  7369. } else if (!has_header(x.headers, "Content-Length")) {
  7370. auto result =
  7371. read_content_without_length(strm, payload_max_length, out);
  7372. if (result == ReadContentResult::Success) {
  7373. ret = true;
  7374. } else if (result == ReadContentResult::PayloadTooLarge) {
  7375. exceed_payload_max_length = true;
  7376. ret = false;
  7377. } else {
  7378. ret = false;
  7379. }
  7380. } else {
  7381. auto is_invalid_value = false;
  7382. auto len = get_header_value_u64(x.headers, "Content-Length",
  7383. (std::numeric_limits<size_t>::max)(),
  7384. 0, is_invalid_value);
  7385. if (is_invalid_value) {
  7386. ret = false;
  7387. } else if (len > 0) {
  7388. auto result = read_content_with_length(
  7389. strm, len, std::move(progress), out, payload_max_length);
  7390. ret = (result == ReadContentResult::Success);
  7391. if (result == ReadContentResult::PayloadTooLarge) {
  7392. exceed_payload_max_length = true;
  7393. }
  7394. }
  7395. }
  7396. if (!ret) {
  7397. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7398. : StatusCode::BadRequest_400;
  7399. }
  7400. return ret;
  7401. });
  7402. }
  7403. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7404. const std::string &path) {
  7405. // Neither the method nor the request target may carry CR/LF, SP or other
  7406. // control octets; otherwise a value smuggled into either splits the request
  7407. // line and injects headers or a whole request.
  7408. if (!fields::is_token(method)) { return -1; }
  7409. if (!fields::is_request_target(path)) { return -1; }
  7410. std::string s = method;
  7411. s += ' ';
  7412. s += path;
  7413. s += " HTTP/1.1\r\n";
  7414. return strm.write(s.data(), s.size());
  7415. }
  7416. inline ssize_t write_response_line(Stream &strm, int status) {
  7417. std::string s = "HTTP/1.1 ";
  7418. s += std::to_string(status);
  7419. s += ' ';
  7420. s += httplib::status_message(status);
  7421. s += "\r\n";
  7422. return strm.write(s.data(), s.size());
  7423. }
  7424. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7425. ssize_t write_len = 0;
  7426. for (const auto &x : headers) {
  7427. // Skip fields with invalid names or values to prevent response splitting
  7428. // via CR/LF injection, matching set_header(). The client validates request
  7429. // headers up front in check_and_write_headers, but the server passes
  7430. // res.headers straight to this writer, and res.headers is a public field
  7431. // an application can populate directly with request-derived values.
  7432. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7433. std::string s;
  7434. s = x.first;
  7435. s += ": ";
  7436. s += x.second;
  7437. s += "\r\n";
  7438. auto len = strm.write(s.data(), s.size());
  7439. if (len < 0) { return len; }
  7440. write_len += len;
  7441. }
  7442. auto len = strm.write("\r\n");
  7443. if (len < 0) { return len; }
  7444. write_len += len;
  7445. return write_len;
  7446. }
  7447. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7448. size_t offset = 0;
  7449. while (offset < l) {
  7450. auto length = strm.write(d + offset, l - offset);
  7451. if (length < 0) { return false; }
  7452. offset += static_cast<size_t>(length);
  7453. }
  7454. return true;
  7455. }
  7456. template <typename T>
  7457. inline bool write_content_with_progress(Stream &strm,
  7458. const ContentProvider &content_provider,
  7459. size_t offset, size_t length,
  7460. T is_shutting_down,
  7461. const UploadProgress &upload_progress,
  7462. Error &error) {
  7463. size_t end_offset = offset + length;
  7464. size_t start_offset = offset;
  7465. auto ok = true;
  7466. auto finished = false;
  7467. DataSink data_sink;
  7468. data_sink.write = [&](const char *d, size_t l) -> bool {
  7469. if (ok) {
  7470. // Bytes past `length` would follow the framed body, where the peer reads
  7471. // them as the next message. Write only what fits and fail the rest.
  7472. if (l > end_offset - offset) {
  7473. l = end_offset - offset;
  7474. ok = false;
  7475. }
  7476. if (write_data(strm, d, l)) {
  7477. offset += l;
  7478. if (upload_progress && length > 0) {
  7479. size_t current_written = offset - start_offset;
  7480. if (!upload_progress(current_written, length)) {
  7481. ok = false;
  7482. return false;
  7483. }
  7484. }
  7485. } else {
  7486. ok = false;
  7487. }
  7488. }
  7489. return ok;
  7490. };
  7491. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7492. // The body is framed by `length`, so a provider that reports itself done
  7493. // early has truncated it. Record that and let the short-body check below
  7494. // fail the write, rather than calling the provider again forever.
  7495. data_sink.done = [&]() { finished = true; };
  7496. while (offset < end_offset && !finished && !is_shutting_down()) {
  7497. auto last_offset = offset;
  7498. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7499. error = Error::Write;
  7500. return false;
  7501. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7502. error = Error::Canceled;
  7503. return false;
  7504. } else if (!ok) {
  7505. error = Error::Write;
  7506. return false;
  7507. }
  7508. // A provider that reports success without writing anything and without
  7509. // reporting itself done gets handed the same offset and length again on
  7510. // the next pass, so it would spin here for as long as the peer stays
  7511. // connected. Treat making no progress as a short body, like done() early.
  7512. if (!finished && offset == last_offset) {
  7513. error = Error::Write;
  7514. return false;
  7515. }
  7516. }
  7517. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7518. error = Error::Write;
  7519. return false;
  7520. }
  7521. error = Error::Success;
  7522. return true;
  7523. }
  7524. template <typename T>
  7525. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7526. size_t offset, size_t length, T is_shutting_down,
  7527. Error &error) {
  7528. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7529. is_shutting_down, nullptr, error);
  7530. }
  7531. template <typename T>
  7532. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7533. size_t offset, size_t length,
  7534. const T &is_shutting_down) {
  7535. auto error = Error::Success;
  7536. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7537. error);
  7538. }
  7539. template <typename T>
  7540. inline bool
  7541. write_content_without_length(Stream &strm,
  7542. const ContentProvider &content_provider,
  7543. const T &is_shutting_down) {
  7544. size_t offset = 0;
  7545. auto data_available = true;
  7546. auto ok = true;
  7547. DataSink data_sink;
  7548. data_sink.write = [&](const char *d, size_t l) -> bool {
  7549. if (ok) {
  7550. offset += l;
  7551. if (!write_data(strm, d, l)) { ok = false; }
  7552. }
  7553. return ok;
  7554. };
  7555. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7556. data_sink.done = [&](void) { data_available = false; };
  7557. while (data_available && !is_shutting_down()) {
  7558. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7559. return false;
  7560. } else if (!content_provider(offset, 0, data_sink)) {
  7561. return false;
  7562. } else if (!ok) {
  7563. return false;
  7564. }
  7565. }
  7566. return !data_available; // true only if done() was called, false if shutting
  7567. // down
  7568. }
  7569. // Runs a known-length content provider to completion and compresses what it
  7570. // writes into `out`, chunk by chunk, without holding the identity form.
  7571. inline bool compress_content_provider(const ContentProvider &content_provider,
  7572. size_t length, compressor &cmp,
  7573. std::string &out) {
  7574. size_t offset = 0;
  7575. auto ok = true;
  7576. auto finished = false;
  7577. DataSink data_sink;
  7578. auto append = [&](const char *data, size_t data_len) {
  7579. out.append(data, data_len);
  7580. return true;
  7581. };
  7582. data_sink.write = [&](const char *d, size_t l) -> bool {
  7583. if (!ok) { return false; }
  7584. offset += l;
  7585. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7586. return ok;
  7587. };
  7588. // The body is framed by `length`, so a provider that reports itself done
  7589. // early has truncated it; the short-body check below turns that into a
  7590. // failure rather than calling the provider again forever.
  7591. data_sink.done = [&]() { finished = true; };
  7592. while (offset < length && !finished) {
  7593. auto prev_offset = offset;
  7594. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7595. return false;
  7596. }
  7597. // No Stream to block on here, so a provider that keeps returning true
  7598. // without writing would spin. Treat a pass that made no progress as a
  7599. // failure.
  7600. if (offset == prev_offset) { return false; }
  7601. }
  7602. if (offset != length) { return false; }
  7603. return cmp.compress(nullptr, 0, true, append);
  7604. }
  7605. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7606. // and the file flag, so recording them has to come after; keeping all of it
  7607. // here means a third file-serving path cannot get that order wrong.
  7608. inline void set_file_content_provider(Response &res,
  7609. const std::shared_ptr<mmap> &m,
  7610. const std::string &content_type,
  7611. EncodingType encoding) {
  7612. // One read and one write move up to this much of the file at a time.
  7613. auto buf = std::make_shared<std::vector<char>>(
  7614. (std::min)(m->size(), size_t(256 * 1024)));
  7615. res.set_content_provider(
  7616. m->size(), content_type,
  7617. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7618. // Never read past the file, which ends the response early if it has
  7619. // shrunk since it was opened.
  7620. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7621. if (n == 0) { return false; }
  7622. sink.write(buf->data(), n);
  7623. return true;
  7624. });
  7625. res.is_file_content_provider_ = true;
  7626. res.content_coding_ = encoding;
  7627. }
  7628. template <typename T, typename U>
  7629. inline bool
  7630. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7631. const T &is_shutting_down, U &compressor, Error &error) {
  7632. size_t offset = 0;
  7633. auto data_available = true;
  7634. auto ok = true;
  7635. DataSink data_sink;
  7636. data_sink.write = [&](const char *d, size_t l) -> bool {
  7637. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7638. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7639. // zero-length chunk is the terminator, so it must not be emitted here.
  7640. if (ok && l > 0) {
  7641. offset += l;
  7642. std::string payload;
  7643. if (compressor.compress(d, l, false,
  7644. [&](const char *data, size_t data_len) {
  7645. payload.append(data, data_len);
  7646. return true;
  7647. })) {
  7648. if (!payload.empty()) {
  7649. // Emit chunked response header and footer for each chunk
  7650. auto chunk =
  7651. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7652. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7653. }
  7654. } else {
  7655. ok = false;
  7656. }
  7657. }
  7658. return ok;
  7659. };
  7660. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7661. auto done_with_trailer = [&](const Headers *trailer) {
  7662. if (!ok) { return; }
  7663. data_available = false;
  7664. std::string payload;
  7665. if (!compressor.compress(nullptr, 0, true,
  7666. [&](const char *data, size_t data_len) {
  7667. payload.append(data, data_len);
  7668. return true;
  7669. })) {
  7670. ok = false;
  7671. return;
  7672. }
  7673. if (!payload.empty()) {
  7674. // Emit chunked response header and footer for each chunk
  7675. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7676. if (!write_data(strm, chunk.data(), chunk.size())) {
  7677. ok = false;
  7678. return;
  7679. }
  7680. }
  7681. constexpr const char done_marker[] = "0\r\n";
  7682. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7683. // Trailer
  7684. if (trailer) {
  7685. for (const auto &kv : *trailer) {
  7686. // Skip fields with invalid names or values to prevent response
  7687. // splitting via CR/LF injection, matching set_header().
  7688. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7689. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7690. if (!write_data(strm, field_line.data(), field_line.size())) {
  7691. ok = false;
  7692. }
  7693. }
  7694. }
  7695. constexpr const char crlf[] = "\r\n";
  7696. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7697. };
  7698. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7699. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7700. done_with_trailer(&trailer);
  7701. };
  7702. while (data_available && !is_shutting_down()) {
  7703. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7704. error = Error::Write;
  7705. return false;
  7706. } else if (!content_provider(offset, 0, data_sink)) {
  7707. error = Error::Canceled;
  7708. return false;
  7709. } else if (!ok) {
  7710. error = Error::Write;
  7711. return false;
  7712. }
  7713. }
  7714. if (data_available) { // exited due to is_shutting_down(), not done()
  7715. error = Error::Write;
  7716. return false;
  7717. }
  7718. error = Error::Success;
  7719. return true;
  7720. }
  7721. template <typename T, typename U>
  7722. inline bool write_content_chunked(Stream &strm,
  7723. const ContentProvider &content_provider,
  7724. const T &is_shutting_down, U &compressor) {
  7725. auto error = Error::Success;
  7726. return write_content_chunked(strm, content_provider, is_shutting_down,
  7727. compressor, error);
  7728. }
  7729. template <typename T>
  7730. inline bool redirect(T &cli, Request &req, Response &res,
  7731. const std::string &path, const std::string &location,
  7732. Error &error) {
  7733. Request new_req = req;
  7734. new_req.path = path;
  7735. new_req.redirect_count_ -= 1;
  7736. if (res.status == StatusCode::SeeOther_303 &&
  7737. (req.method != "GET" && req.method != "HEAD")) {
  7738. new_req.method = "GET";
  7739. new_req.body.clear();
  7740. new_req.headers.clear();
  7741. new_req.content_length_ = 0;
  7742. new_req.content_provider_ = nullptr;
  7743. new_req.is_chunked_content_provider_ = false;
  7744. }
  7745. Response new_res;
  7746. auto ret = cli.send(new_req, new_res, error);
  7747. if (ret) {
  7748. req = std::move(new_req);
  7749. res = std::move(new_res);
  7750. if (res.location.empty()) { res.location = location; }
  7751. }
  7752. return ret;
  7753. }
  7754. inline std::string params_to_query_str(const Params &params) {
  7755. std::string query;
  7756. for (auto it = params.begin(); it != params.end(); ++it) {
  7757. if (it != params.begin()) { query += '&'; }
  7758. query += encode_query_component(it->first);
  7759. query += '=';
  7760. query += encode_query_component(it->second);
  7761. }
  7762. return query;
  7763. }
  7764. // Splits one "key=value" span of a query string at its first '='. A span with
  7765. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7766. // "?flag" keeps its name.
  7767. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7768. std::string &val) {
  7769. divide(b, static_cast<std::size_t>(e - b), '=',
  7770. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7771. std::size_t rhs_size) {
  7772. key.assign(lhs_data, lhs_size);
  7773. val.assign(rhs_data, rhs_size);
  7774. });
  7775. }
  7776. inline void parse_query_text(const char *data, std::size_t size,
  7777. Params &params) {
  7778. std::set<std::string> cache;
  7779. split(data, data + size, '&', [&](const char *b, const char *e) {
  7780. std::string kv(b, e);
  7781. if (cache.find(kv) != cache.end()) { return; }
  7782. cache.insert(std::move(kv));
  7783. std::string key;
  7784. std::string val;
  7785. divide_query_pair(b, e, key, val);
  7786. if (!key.empty()) {
  7787. params.emplace(decode_query_component(key), decode_query_component(val));
  7788. }
  7789. });
  7790. }
  7791. inline void parse_query_text(const std::string &s, Params &params) {
  7792. parse_query_text(s.data(), s.size(), params);
  7793. }
  7794. // Normalize a query string by decoding and re-encoding each key/value pair
  7795. // while preserving the original parameter order. This avoids double-encoding
  7796. // and ensures consistent encoding. It works on the raw string rather than
  7797. // parsing into Params and re-serializing, because that round trip cannot
  7798. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7799. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7800. // duplicated pairs.
  7801. inline std::string normalize_query_string(const std::string &query) {
  7802. std::string result;
  7803. split(query.data(), query.data() + query.size(), '&',
  7804. [&](const char *b, const char *e) {
  7805. std::string key;
  7806. std::string val;
  7807. divide_query_pair(b, e, key, val);
  7808. if (!key.empty()) {
  7809. auto dec_key = decode_query_component(key);
  7810. auto dec_val = decode_query_component(val);
  7811. if (!result.empty()) { result += '&'; }
  7812. result += encode_query_component(dec_key);
  7813. if (!val.empty() || std::find(b, e, '=') != e) {
  7814. result += '=';
  7815. result += encode_query_component(dec_val);
  7816. }
  7817. }
  7818. });
  7819. return result;
  7820. }
  7821. // The query of a client's path: what follows '?', up to the fragment.
  7822. inline std::string query_of(const std::string &path) {
  7823. auto fragment_pos = path.find('#');
  7824. auto query_pos = path.find('?');
  7825. return query_pos < fragment_pos
  7826. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  7827. : std::string();
  7828. }
  7829. // Build the request target that goes on the wire from a caller-supplied path.
  7830. // Shared by the buffered send path and the streaming API so that both put the
  7831. // same bytes in the request line for the same input.
  7832. inline std::string encode_request_target(const std::string &uri,
  7833. bool path_encode) {
  7834. // The fragment stays with the client (RFC 9110 §7.1).
  7835. auto target = uri.substr(0, uri.find('#'));
  7836. // `substr(0, npos)` yields the whole string, which is what the no-query
  7837. // case needs.
  7838. auto query_pos = target.find('?');
  7839. auto path_part = target.substr(0, query_pos);
  7840. std::string query_part;
  7841. if (query_pos != std::string::npos) {
  7842. query_part = target.substr(query_pos + 1);
  7843. }
  7844. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7845. if (!query_part.empty()) {
  7846. // When path encoding is disabled the caller has supplied an already-encoded
  7847. // target and expects the exact bytes to be sent on the wire, so skip
  7848. // normalization for the query too. Normalizing would decode-then-re-encode
  7849. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7850. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7851. if (path_encode) {
  7852. auto normalized = normalize_query_string(query_part);
  7853. if (!normalized.empty()) {
  7854. result += '?';
  7855. result += normalized;
  7856. }
  7857. } else {
  7858. result += '?';
  7859. result += query_part;
  7860. }
  7861. }
  7862. return result;
  7863. }
  7864. inline bool parse_multipart_boundary(const std::string &content_type,
  7865. std::string &boundary) {
  7866. std::map<std::string, std::string> params;
  7867. extract_media_type(content_type, &params);
  7868. auto it = params.find("boundary");
  7869. if (it == params.end()) { return false; }
  7870. boundary = it->second;
  7871. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7872. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7873. // bytes costs a nearly full comparison at nearly every position: the
  7874. // boundary's length multiplies the worst-case cost of scanning a body.
  7875. return !boundary.empty() && boundary.size() <= 70;
  7876. }
  7877. inline void parse_disposition_params(const std::string &s, Params &params) {
  7878. std::set<std::string> cache;
  7879. split_unquoted(
  7880. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  7881. std::string kv(b, e);
  7882. if (cache.find(kv) != cache.end()) { return; }
  7883. cache.insert(kv);
  7884. std::string key;
  7885. std::string val;
  7886. divide_param_pair(b, e, key, val);
  7887. if (!key.empty()) {
  7888. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  7889. }
  7890. });
  7891. }
  7892. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7893. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7894. #else
  7895. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7896. #endif
  7897. auto is_valid = [](const std::string &str) {
  7898. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7899. };
  7900. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7901. const auto pos = static_cast<size_t>(6);
  7902. const auto len = static_cast<size_t>(s.size() - 6);
  7903. auto all_valid_ranges = true;
  7904. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7905. if (!all_valid_ranges) { return; }
  7906. const auto it = std::find(b, e, '-');
  7907. if (it == e) {
  7908. all_valid_ranges = false;
  7909. return;
  7910. }
  7911. const auto lhs = std::string(b, it);
  7912. const auto rhs = std::string(it + 1, e);
  7913. if (!is_valid(lhs) || !is_valid(rhs)) {
  7914. all_valid_ranges = false;
  7915. return;
  7916. }
  7917. ssize_t first = -1;
  7918. if (!lhs.empty()) {
  7919. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7920. // would turn the range into a suffix range.
  7921. auto res =
  7922. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7923. if (res.ec != std::errc{}) {
  7924. all_valid_ranges = false;
  7925. return;
  7926. }
  7927. }
  7928. ssize_t last = -1;
  7929. if (!rhs.empty()) {
  7930. // An overflowing last-byte-pos is past any content length, so keeping
  7931. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7932. ssize_t v;
  7933. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7934. if (res.ec == std::errc{}) { last = v; }
  7935. }
  7936. if ((first == -1 && last == -1) ||
  7937. (first != -1 && last != -1 && first > last)) {
  7938. all_valid_ranges = false;
  7939. return;
  7940. }
  7941. ranges.emplace_back(first, last);
  7942. });
  7943. return all_valid_ranges && !ranges.empty();
  7944. }
  7945. return false;
  7946. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7947. }
  7948. #else
  7949. } catch (...) { return false; }
  7950. #endif
  7951. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7952. inline std::string remove_quoted_strings(const std::string &s) {
  7953. std::string out;
  7954. auto in_quotes = false;
  7955. for (size_t i = 0; i < s.size(); i++) {
  7956. if (s[i] == '"') {
  7957. in_quotes = !in_quotes;
  7958. } else if (!in_quotes) {
  7959. out += s[i];
  7960. } else if (s[i] == '\\') {
  7961. i++;
  7962. }
  7963. }
  7964. return out;
  7965. }
  7966. inline bool parse_accept_header(const std::string &s,
  7967. std::vector<std::string> &content_types) {
  7968. // Parameter values are not used here, so a quoted-string is dropped rather
  7969. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  7970. if (s.find('"') != std::string::npos) {
  7971. return parse_accept_header(remove_quoted_strings(s), content_types);
  7972. }
  7973. content_types.clear();
  7974. // Empty string is considered valid (no preference)
  7975. if (s.empty()) { return true; }
  7976. struct AcceptEntry {
  7977. std::string media_type;
  7978. double quality;
  7979. int order;
  7980. };
  7981. std::vector<AcceptEntry> entries;
  7982. int order = 0;
  7983. bool has_invalid_entry = false;
  7984. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7985. // has to parse and ignore empty list elements, so a leading, trailing or
  7986. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7987. // split() skips them, and the header length limit bounds how many a sender
  7988. // can send, so ignoring all of them cannot be used as a denial-of-service
  7989. // vector.
  7990. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7991. std::string entry(b, e);
  7992. entry = trim_copy(entry);
  7993. AcceptEntry accept_entry;
  7994. accept_entry.order = order++;
  7995. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7996. accept_entry.media_type, accept_entry.quality)) {
  7997. has_invalid_entry = true;
  7998. return;
  7999. }
  8000. // Remove additional parameters from media type
  8001. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8002. // Basic validation of media type format
  8003. if (accept_entry.media_type.empty()) {
  8004. has_invalid_entry = true;
  8005. return;
  8006. }
  8007. // Check for basic media type format (should contain '/' or be '*')
  8008. if (accept_entry.media_type != "*" &&
  8009. accept_entry.media_type.find('/') == std::string::npos) {
  8010. has_invalid_entry = true;
  8011. return;
  8012. }
  8013. entries.push_back(std::move(accept_entry));
  8014. });
  8015. // Return false if any invalid entry was found
  8016. if (has_invalid_entry) { return false; }
  8017. // Sort by quality (descending), then by original order (ascending)
  8018. std::sort(entries.begin(), entries.end(),
  8019. [](const AcceptEntry &a, const AcceptEntry &b) {
  8020. if (a.quality != b.quality) {
  8021. return a.quality > b.quality; // Higher quality first
  8022. }
  8023. return a.order < b.order; // Earlier order first for same quality
  8024. });
  8025. // Extract sorted media types
  8026. content_types.reserve(entries.size());
  8027. for (auto &entry : entries) {
  8028. content_types.push_back(std::move(entry.media_type));
  8029. }
  8030. return true;
  8031. }
  8032. class FormDataParser {
  8033. public:
  8034. FormDataParser() = default;
  8035. void set_boundary(std::string &&boundary) {
  8036. boundary_ = std::move(boundary);
  8037. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8038. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8039. }
  8040. bool is_valid() const { return is_valid_; }
  8041. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8042. const ContentReceiver &content_callback) {
  8043. // Once the close delimiter has been seen the rest of the body is epilogue
  8044. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8045. // spread across reads is not copied in only to be erased right away.
  8046. if (state_ == 5) { return true; }
  8047. buf_append(buf, n);
  8048. while (buf_size() > 0) {
  8049. switch (state_) {
  8050. case 0: { // Initial boundary
  8051. auto pos = buf_find(dash_boundary_crlf_);
  8052. if (pos == buf_size()) {
  8053. // Not found yet: keep only a possible partial boundary at the tail so
  8054. // that a body which never contains the boundary cannot grow the
  8055. // buffer (and get rescanned from the start) without bound.
  8056. auto keep = dash_boundary_crlf_.size() - 1;
  8057. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8058. return true;
  8059. }
  8060. buf_erase(pos + dash_boundary_crlf_.size());
  8061. state_ = 1;
  8062. break;
  8063. }
  8064. case 1: { // New entry
  8065. clear_file_info();
  8066. header_searched_ = 0;
  8067. state_ = 2;
  8068. break;
  8069. }
  8070. case 2: { // Headers
  8071. // Resume where the last call stopped looking, so that a line arriving
  8072. // a few bytes at a time is not searched from its start each time.
  8073. auto pos = buf_find(crlf_, header_searched_);
  8074. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8075. while (pos < buf_size()) {
  8076. // Empty line
  8077. if (pos == 0) {
  8078. if (!header_callback(file_)) {
  8079. is_valid_ = false;
  8080. return false;
  8081. }
  8082. buf_erase(crlf_.size());
  8083. state_ = 3;
  8084. break;
  8085. }
  8086. // Check header count limit
  8087. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8088. is_valid_ = false;
  8089. return false;
  8090. }
  8091. header_count_++;
  8092. const auto header = buf_head(pos);
  8093. if (!parse_header(header.data(), header.data() + header.size(),
  8094. [&](const std::string &, const std::string &) {})) {
  8095. is_valid_ = false;
  8096. return false;
  8097. }
  8098. // Parse and emplace space trimmed headers into a map
  8099. if (!parse_header(
  8100. header.data(), header.data() + header.size(),
  8101. [&](const std::string &key, const std::string &val) {
  8102. file_.headers.emplace(key, val);
  8103. })) {
  8104. is_valid_ = false;
  8105. return false;
  8106. }
  8107. constexpr const char header_content_type[] = "Content-Type:";
  8108. if (start_with_case_ignore(header, header_content_type)) {
  8109. file_.content_type =
  8110. trim_copy(header.substr(str_len(header_content_type)));
  8111. } else {
  8112. std::string disposition_params;
  8113. if (parse_content_disposition(header, disposition_params)) {
  8114. Params params;
  8115. parse_disposition_params(disposition_params, params);
  8116. auto it = params.find("name");
  8117. if (it != params.end()) {
  8118. file_.name = it->second;
  8119. } else {
  8120. is_valid_ = false;
  8121. return false;
  8122. }
  8123. it = params.find("filename");
  8124. if (it != params.end()) { file_.filename = it->second; }
  8125. it = params.find("filename*");
  8126. if (it != params.end()) {
  8127. // RFC 5987: only UTF-8 encoding is allowed
  8128. const auto &val = it->second;
  8129. constexpr const char utf8_prefix[] = "UTF-8''";
  8130. constexpr size_t prefix_len = str_len(utf8_prefix);
  8131. if (val.size() > prefix_len &&
  8132. start_with_case_ignore(val, utf8_prefix)) {
  8133. file_.filename = decode_path_component(
  8134. val.substr(prefix_len)); // override...
  8135. } else {
  8136. is_valid_ = false;
  8137. return false;
  8138. }
  8139. }
  8140. }
  8141. }
  8142. buf_erase(pos + crlf_.size());
  8143. pos = buf_find(crlf_);
  8144. }
  8145. if (state_ != 3) {
  8146. // The CR of the CRLF may be the last byte so far.
  8147. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8148. return true;
  8149. }
  8150. break;
  8151. }
  8152. case 3: { // Body
  8153. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8154. auto pos = buf_find(crlf_dash_boundary_);
  8155. if (pos < buf_size()) {
  8156. if (!content_callback(buf_data(), pos)) {
  8157. is_valid_ = false;
  8158. return false;
  8159. }
  8160. buf_erase(pos + crlf_dash_boundary_.size());
  8161. state_ = 4;
  8162. } else {
  8163. auto len = buf_size() - crlf_dash_boundary_.size();
  8164. if (len > 0) {
  8165. if (!content_callback(buf_data(), len)) {
  8166. is_valid_ = false;
  8167. return false;
  8168. }
  8169. buf_erase(len);
  8170. }
  8171. return true;
  8172. }
  8173. break;
  8174. }
  8175. case 4: { // Boundary
  8176. if (crlf_.size() > buf_size()) { return true; }
  8177. if (buf_start_with(crlf_)) {
  8178. buf_erase(crlf_.size());
  8179. state_ = 1;
  8180. } else if (buf_start_with(dash_)) {
  8181. buf_erase(dash_.size());
  8182. is_valid_ = true;
  8183. state_ = 5;
  8184. } else {
  8185. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8186. // accepted after a boundary; RFC 2046 allows transport-padding in
  8187. // between, but this parser has never supported it. Either way the
  8188. // body is already destined to be rejected, so fail now instead of
  8189. // buffering the rest of it. Both are two bytes, so the check above
  8190. // already guarantees enough buffered data to decide.
  8191. is_valid_ = false;
  8192. return false;
  8193. }
  8194. break;
  8195. }
  8196. case 5: { // Epilogue
  8197. buf_erase(buf_size());
  8198. break;
  8199. }
  8200. }
  8201. }
  8202. return true;
  8203. }
  8204. private:
  8205. void clear_file_info() {
  8206. file_.name.clear();
  8207. file_.filename.clear();
  8208. file_.content_type.clear();
  8209. file_.headers.clear();
  8210. header_count_ = 0;
  8211. }
  8212. bool start_with_case_ignore(const std::string &a, const char *b,
  8213. size_t offset = 0) const {
  8214. const auto b_len = strlen(b);
  8215. if (a.size() < offset + b_len) { return false; }
  8216. for (size_t i = 0; i < b_len; i++) {
  8217. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8218. return false;
  8219. }
  8220. }
  8221. return true;
  8222. }
  8223. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8224. // Returns true if header matches, with the params portion in `params_out`.
  8225. bool parse_content_disposition(const std::string &header,
  8226. std::string &params_out) const {
  8227. constexpr const char prefix[] = "Content-Disposition:";
  8228. constexpr size_t prefix_len = str_len(prefix);
  8229. if (!start_with_case_ignore(header, prefix)) { return false; }
  8230. // Skip whitespace after "Content-Disposition:"
  8231. auto pos = prefix_len;
  8232. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8233. pos++;
  8234. }
  8235. // Match "form-data;" (case-insensitive)
  8236. constexpr const char form_data[] = "form-data;";
  8237. constexpr size_t form_data_len = str_len(form_data);
  8238. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8239. pos += form_data_len;
  8240. // Skip whitespace after "form-data;"
  8241. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8242. pos++;
  8243. }
  8244. params_out = header.substr(pos);
  8245. return true;
  8246. }
  8247. const std::string dash_ = "--";
  8248. const std::string crlf_ = "\r\n";
  8249. std::string boundary_;
  8250. std::string dash_boundary_crlf_;
  8251. std::string crlf_dash_boundary_;
  8252. size_t state_ = 0;
  8253. bool is_valid_ = false;
  8254. FormData file_;
  8255. size_t header_count_ = 0;
  8256. size_t header_searched_ = 0;
  8257. // Buffer
  8258. bool start_with(const std::string &a, size_t spos, size_t epos,
  8259. const std::string &b) const {
  8260. if (epos - spos < b.size()) { return false; }
  8261. for (size_t i = 0; i < b.size(); i++) {
  8262. if (a[i + spos] != b[i]) { return false; }
  8263. }
  8264. return true;
  8265. }
  8266. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8267. const char *buf_data() const { return &buf_[buf_spos_]; }
  8268. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8269. bool buf_start_with(const std::string &s) const {
  8270. return start_with(buf_, buf_spos_, buf_epos_, s);
  8271. }
  8272. size_t buf_find(const std::string &s, size_t from = 0) const {
  8273. auto c = s.front();
  8274. size_t off = buf_spos_ + from;
  8275. while (off < buf_epos_) {
  8276. auto pos = off;
  8277. while (true) {
  8278. if (pos == buf_epos_) { return buf_size(); }
  8279. if (buf_[pos] == c) { break; }
  8280. pos++;
  8281. }
  8282. auto remaining_size = buf_epos_ - pos;
  8283. if (s.size() > remaining_size) { return buf_size(); }
  8284. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8285. off = pos + 1;
  8286. }
  8287. return buf_size();
  8288. }
  8289. void buf_append(const char *data, size_t n) {
  8290. auto remaining_size = buf_size();
  8291. if (remaining_size > 0 && buf_spos_ > 0) {
  8292. for (size_t i = 0; i < remaining_size; i++) {
  8293. buf_[i] = buf_[buf_spos_ + i];
  8294. }
  8295. }
  8296. buf_spos_ = 0;
  8297. buf_epos_ = remaining_size;
  8298. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8299. for (size_t i = 0; i < n; i++) {
  8300. buf_[buf_epos_ + i] = data[i];
  8301. }
  8302. buf_epos_ += n;
  8303. }
  8304. void buf_erase(size_t size) { buf_spos_ += size; }
  8305. std::string buf_;
  8306. size_t buf_spos_ = 0;
  8307. size_t buf_epos_ = 0;
  8308. };
  8309. inline std::string random_string(size_t length) {
  8310. constexpr const char data[] =
  8311. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8312. std::string result(length, '\0');
  8313. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8314. for (auto &c : result) {
  8315. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8316. }
  8317. return result;
  8318. }
  8319. inline std::string make_multipart_data_boundary() {
  8320. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8321. }
  8322. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8323. auto valid = true;
  8324. for (size_t i = 0; i < boundary.size(); i++) {
  8325. auto c = boundary[i];
  8326. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8327. valid = false;
  8328. break;
  8329. }
  8330. }
  8331. return valid;
  8332. }
  8333. // Escape a multipart field name/filename following the WHATWG HTML standard
  8334. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8335. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8336. // With quoted = false, only CR and LF are escaped; this is for header values
  8337. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8338. inline std::string escape_multipart_field(const std::string &s,
  8339. bool quoted = true) {
  8340. std::string result;
  8341. result.reserve(s.size());
  8342. for (auto c : s) {
  8343. switch (c) {
  8344. case '"':
  8345. if (quoted) {
  8346. result += "%22";
  8347. } else {
  8348. result += c;
  8349. }
  8350. break;
  8351. case '\\':
  8352. // A lone backslash would escape the character after it (RFC 9110
  8353. // 5.6.4).
  8354. if (quoted) { result += '\\'; }
  8355. result += c;
  8356. break;
  8357. case '\r': result += "%0D"; break;
  8358. case '\n': result += "%0A"; break;
  8359. default: result += c; break;
  8360. }
  8361. }
  8362. return result;
  8363. }
  8364. template <typename T>
  8365. inline std::string
  8366. serialize_multipart_formdata_item_begin(const T &item,
  8367. const std::string &boundary) {
  8368. std::string body = "--" + boundary + "\r\n";
  8369. body += "Content-Disposition: form-data; name=\"" +
  8370. escape_multipart_field(item.name) + "\"";
  8371. if (!item.filename.empty()) {
  8372. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8373. }
  8374. body += "\r\n";
  8375. if (!item.content_type.empty()) {
  8376. body +=
  8377. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8378. "\r\n";
  8379. }
  8380. body += "\r\n";
  8381. return body;
  8382. }
  8383. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8384. inline std::string
  8385. serialize_multipart_formdata_finish(const std::string &boundary) {
  8386. return "--" + boundary + "--\r\n";
  8387. }
  8388. inline std::string
  8389. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8390. return "multipart/form-data; boundary=" + boundary;
  8391. }
  8392. inline std::string
  8393. serialize_multipart_formdata(const UploadFormDataItems &items,
  8394. const std::string &boundary, bool finish = true) {
  8395. std::string body;
  8396. for (const auto &item : items) {
  8397. body += serialize_multipart_formdata_item_begin(item, boundary);
  8398. body += item.content + serialize_multipart_formdata_item_end();
  8399. }
  8400. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8401. return body;
  8402. }
  8403. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8404. const std::string &boundary) {
  8405. size_t total = 0;
  8406. for (const auto &item : items) {
  8407. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8408. total += item.content.size();
  8409. total += serialize_multipart_formdata_item_end().size();
  8410. }
  8411. total += serialize_multipart_formdata_finish(boundary).size();
  8412. return total;
  8413. }
  8414. struct MultipartSegment {
  8415. const char *data;
  8416. size_t size;
  8417. };
  8418. // NOTE: items must outlive the returned ContentProvider
  8419. // (safe for synchronous use inside Post/Put/Patch)
  8420. inline ContentProvider
  8421. make_multipart_content_provider(const UploadFormDataItems &items,
  8422. const std::string &boundary) {
  8423. // Own the per-item header strings and the finish string
  8424. std::vector<std::string> owned;
  8425. owned.reserve(items.size() + 1);
  8426. for (const auto &item : items)
  8427. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8428. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8429. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8430. std::vector<MultipartSegment> segs;
  8431. segs.reserve(items.size() * 3 + 1);
  8432. static const char crlf[] = "\r\n";
  8433. for (size_t i = 0; i < items.size(); i++) {
  8434. segs.push_back({owned[i].data(), owned[i].size()});
  8435. segs.push_back({items[i].content.data(), items[i].content.size()});
  8436. segs.push_back({crlf, 2});
  8437. }
  8438. segs.push_back({owned.back().data(), owned.back().size()});
  8439. struct MultipartState {
  8440. std::vector<std::string> owned;
  8441. std::vector<MultipartSegment> segs;
  8442. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8443. };
  8444. auto state = std::make_shared<MultipartState>();
  8445. state->owned = std::move(owned);
  8446. // `segs` holds raw pointers into owned strings; std::string move preserves
  8447. // the data pointer, so these pointers remain valid after the move above.
  8448. state->segs = std::move(segs);
  8449. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8450. // Buffer multiple small segments into fewer, larger writes to avoid
  8451. // excessive TCP packets when there are many form data items (#2410)
  8452. auto &buf = state->buf;
  8453. auto buf_size = buf.size();
  8454. size_t buf_len = 0;
  8455. size_t remaining = length;
  8456. // Find the first segment containing 'offset'
  8457. size_t pos = 0;
  8458. size_t seg_idx = 0;
  8459. for (; seg_idx < state->segs.size(); seg_idx++) {
  8460. const auto &seg = state->segs[seg_idx];
  8461. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8462. pos += seg.size;
  8463. }
  8464. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8465. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8466. const auto &seg = state->segs[seg_idx];
  8467. size_t available = seg.size - seg_offset;
  8468. size_t to_copy = (std::min)(available, remaining);
  8469. const char *src = seg.data + seg_offset;
  8470. seg_offset = 0; // only the first segment has a non-zero offset
  8471. while (to_copy > 0) {
  8472. size_t space = buf_size - buf_len;
  8473. size_t chunk = (std::min)(to_copy, space);
  8474. std::memcpy(buf.data() + buf_len, src, chunk);
  8475. buf_len += chunk;
  8476. src += chunk;
  8477. to_copy -= chunk;
  8478. remaining -= chunk;
  8479. if (buf_len == buf_size) {
  8480. if (!sink.write(buf.data(), buf_len)) { return false; }
  8481. buf_len = 0;
  8482. }
  8483. }
  8484. }
  8485. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8486. return true;
  8487. };
  8488. }
  8489. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8490. if (ranges.size() <= 1) return;
  8491. // Sort ranges by start position
  8492. std::sort(ranges.begin(), ranges.end(),
  8493. [](const Range &a, const Range &b) { return a.first < b.first; });
  8494. Ranges coalesced;
  8495. coalesced.reserve(ranges.size());
  8496. for (auto &r : ranges) {
  8497. auto first_pos = r.first;
  8498. auto last_pos = r.second;
  8499. // Handle special cases like in range_error
  8500. if (first_pos == -1 && last_pos == -1) {
  8501. first_pos = 0;
  8502. last_pos = static_cast<ssize_t>(content_length);
  8503. }
  8504. if (first_pos == -1) {
  8505. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8506. last_pos = static_cast<ssize_t>(content_length) - 1;
  8507. }
  8508. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8509. last_pos = static_cast<ssize_t>(content_length) - 1;
  8510. }
  8511. // Skip invalid ranges
  8512. if (!(0 <= first_pos && first_pos <= last_pos &&
  8513. last_pos < static_cast<ssize_t>(content_length))) {
  8514. continue;
  8515. }
  8516. // Coalesce with previous range if overlapping or adjacent (but not
  8517. // identical)
  8518. if (!coalesced.empty()) {
  8519. auto &prev = coalesced.back();
  8520. // Check if current range overlaps or is adjacent to previous range
  8521. // but don't coalesce identical ranges (allow duplicates)
  8522. if (first_pos <= prev.second + 1 &&
  8523. !(first_pos == prev.first && last_pos == prev.second)) {
  8524. // Extend the previous range
  8525. prev.second = (std::max)(prev.second, last_pos);
  8526. continue;
  8527. }
  8528. }
  8529. // Add new range
  8530. coalesced.emplace_back(first_pos, last_pos);
  8531. }
  8532. ranges = std::move(coalesced);
  8533. }
  8534. inline bool range_error(Request &req, Response &res) {
  8535. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8536. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8537. req.ranges.clear();
  8538. if (res.status == StatusCode::PartialContent_206) {
  8539. res.status = StatusCode::OK_200;
  8540. }
  8541. return false;
  8542. }
  8543. ssize_t content_len = static_cast<ssize_t>(
  8544. res.content_length_ ? res.content_length_ : res.body.size());
  8545. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8546. size_t overwrapping_count = 0;
  8547. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8548. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8549. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8550. // Too many ranges
  8551. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8552. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8553. return true;
  8554. }
  8555. for (auto &r : req.ranges) {
  8556. auto &first_pos = r.first;
  8557. auto &last_pos = r.second;
  8558. if (first_pos == -1 && last_pos == -1) {
  8559. first_pos = 0;
  8560. last_pos = content_len;
  8561. }
  8562. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8563. // selects the entire representation.
  8564. if (first_pos == -1) {
  8565. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8566. last_pos = content_len - 1;
  8567. }
  8568. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8569. // A client can limit the number of bytes requested without knowing the
  8570. // size of the selected representation. If the last-pos value is absent,
  8571. // or if the value is greater than or equal to the current length of the
  8572. // representation data, the byte range is interpreted as the remainder of
  8573. // the representation (i.e., the server replaces the value of last-pos
  8574. // with a value that is one less than the current length of the selected
  8575. // representation).
  8576. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8577. if (last_pos == -1 || last_pos >= content_len) {
  8578. last_pos = content_len - 1;
  8579. }
  8580. // Range must be within content length
  8581. if (!(0 <= first_pos && first_pos <= last_pos &&
  8582. last_pos <= content_len - 1)) {
  8583. return true;
  8584. }
  8585. // Request must not have more than two overlapping ranges
  8586. for (const auto &processed_range : processed_ranges) {
  8587. if (!(last_pos < processed_range.first ||
  8588. first_pos > processed_range.second)) {
  8589. overwrapping_count++;
  8590. if (overwrapping_count > 2) { return true; }
  8591. break; // Only count once per range
  8592. }
  8593. }
  8594. processed_ranges.emplace_back(first_pos, last_pos);
  8595. }
  8596. // After validation, coalesce overlapping ranges as per RFC 9110
  8597. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8598. }
  8599. return false;
  8600. }
  8601. inline std::pair<size_t, size_t>
  8602. get_range_offset_and_length(Range r, size_t content_length) {
  8603. assert(r.first != -1 && r.second != -1);
  8604. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8605. assert(r.first <= r.second &&
  8606. r.second < static_cast<ssize_t>(content_length));
  8607. (void)(content_length);
  8608. return std::make_pair(static_cast<size_t>(r.first),
  8609. static_cast<size_t>(r.second - r.first) + 1);
  8610. }
  8611. inline std::string make_content_range_header_field(
  8612. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8613. auto st = offset_and_length.first;
  8614. auto ed = st + offset_and_length.second - 1;
  8615. std::string field = "bytes ";
  8616. field += std::to_string(st);
  8617. field += '-';
  8618. field += std::to_string(ed);
  8619. field += '/';
  8620. field += std::to_string(content_length);
  8621. return field;
  8622. }
  8623. template <typename SToken, typename CToken, typename Content>
  8624. bool process_multipart_ranges_data(const Request &req,
  8625. const std::string &boundary,
  8626. const std::string &content_type,
  8627. size_t content_length, SToken stoken,
  8628. CToken ctoken, Content content) {
  8629. for (size_t i = 0; i < req.ranges.size(); i++) {
  8630. ctoken("--");
  8631. stoken(boundary);
  8632. ctoken("\r\n");
  8633. if (!content_type.empty()) {
  8634. ctoken("Content-Type: ");
  8635. stoken(content_type);
  8636. ctoken("\r\n");
  8637. }
  8638. auto offset_and_length =
  8639. get_range_offset_and_length(req.ranges[i], content_length);
  8640. ctoken("Content-Range: ");
  8641. stoken(make_content_range_header_field(offset_and_length, content_length));
  8642. ctoken("\r\n");
  8643. ctoken("\r\n");
  8644. if (!content(offset_and_length.first, offset_and_length.second)) {
  8645. return false;
  8646. }
  8647. ctoken("\r\n");
  8648. }
  8649. ctoken("--");
  8650. stoken(boundary);
  8651. ctoken("--");
  8652. return true;
  8653. }
  8654. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8655. const std::string &boundary,
  8656. const std::string &content_type,
  8657. size_t content_length,
  8658. std::string &data) {
  8659. process_multipart_ranges_data(
  8660. req, boundary, content_type, content_length,
  8661. [&](const std::string &token) { data += token; },
  8662. [&](const std::string &token) { data += token; },
  8663. [&](size_t offset, size_t length) {
  8664. assert(offset + length <= content_length);
  8665. data += res.body.substr(offset, length);
  8666. return true;
  8667. });
  8668. }
  8669. inline size_t get_multipart_ranges_data_length(const Request &req,
  8670. const std::string &boundary,
  8671. const std::string &content_type,
  8672. size_t content_length) {
  8673. size_t data_length = 0;
  8674. process_multipart_ranges_data(
  8675. req, boundary, content_type, content_length,
  8676. [&](const std::string &token) { data_length += token.size(); },
  8677. [&](const std::string &token) { data_length += token.size(); },
  8678. [&](size_t /*offset*/, size_t length) {
  8679. data_length += length;
  8680. return true;
  8681. });
  8682. return data_length;
  8683. }
  8684. template <typename T>
  8685. inline bool
  8686. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8687. const std::string &boundary,
  8688. const std::string &content_type,
  8689. size_t content_length, const T &is_shutting_down) {
  8690. return process_multipart_ranges_data(
  8691. req, boundary, content_type, content_length,
  8692. [&](const std::string &token) { strm.write(token); },
  8693. [&](const std::string &token) { strm.write(token); },
  8694. [&](size_t offset, size_t length) {
  8695. return write_content(strm, res.content_provider_, offset, length,
  8696. is_shutting_down);
  8697. });
  8698. }
  8699. inline bool has_framed_body(const Request &req) {
  8700. return is_chunked_transfer_encoding(req.headers) ||
  8701. req.get_header_value_u64("Content-Length") > 0;
  8702. }
  8703. inline bool is_connection_persistent(const Request &req) {
  8704. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8705. if (req.version == "HTTP/1.0" &&
  8706. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8707. return false;
  8708. }
  8709. return true;
  8710. }
  8711. inline bool expect_content(const Request &req) {
  8712. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8713. req.method == "DELETE") {
  8714. return true;
  8715. }
  8716. return has_framed_body(req);
  8717. }
  8718. #ifdef _WIN32
  8719. class WSInit {
  8720. public:
  8721. WSInit() {
  8722. WSADATA wsaData;
  8723. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8724. }
  8725. ~WSInit() {
  8726. if (is_valid_) WSACleanup();
  8727. }
  8728. bool is_valid_ = false;
  8729. };
  8730. static WSInit wsinit_;
  8731. #endif
  8732. inline std::string unescape_quoted_pairs(const std::string &s) {
  8733. std::string out;
  8734. out.reserve(s.size());
  8735. for (size_t i = 0; i < s.size(); i++) {
  8736. if (s[i] == '\\' && i + 1 < s.size()) {
  8737. out += s[++i];
  8738. } else {
  8739. out += s[i];
  8740. }
  8741. }
  8742. return out;
  8743. }
  8744. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8745. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8746. // quoted-pair, so the recipient recovers the original value.
  8747. inline std::string escape_quoted_pairs(const std::string &s) {
  8748. std::string out;
  8749. out.reserve(s.size());
  8750. for (auto c : s) {
  8751. if (c == '\\' || c == '"') { out += '\\'; }
  8752. out += c;
  8753. }
  8754. return out;
  8755. }
  8756. // RFC 9110 Section 11.6.1 defines a challenge list as
  8757. // WWW-Authenticate = #challenge
  8758. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8759. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8760. // so a server may offer several schemes, each with its own comma-separated
  8761. // auth-param list, in either order and either as separate field lines or
  8762. // packed into one. Splitting on every comma would break apart a challenge's
  8763. // own param list; splitting only on the first space would miss a Digest
  8764. // challenge that isn't first. Split on commas that aren't inside a
  8765. // quoted-string instead (split_unquoted), then track which scheme each
  8766. // resulting segment belongs to: a segment whose text before "=" contains
  8767. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8768. // leading token.
  8769. inline bool parse_www_authenticate(const Response &res,
  8770. std::map<std::string, std::string> &auth,
  8771. bool is_proxy) {
  8772. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8773. auto combined = get_combined_header_value(res.headers, auth_key);
  8774. if (combined.empty()) { return false; }
  8775. auto found_digest = false;
  8776. auto in_digest_challenge = false;
  8777. split_unquoted(
  8778. combined.data(), combined.data() + combined.size(), ',',
  8779. [&](const char *b, const char *e) {
  8780. std::string segment(b, e);
  8781. auto eq_pos = segment.find('=');
  8782. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8783. // for the first segment of a challenge, "<scheme> <key>") must be
  8784. // trimmed before its boundaries are inspected.
  8785. auto key_part = trim_copy(
  8786. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8787. auto space_pos = key_part.find_last_of(" \t");
  8788. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8789. // "<scheme>[ <key>]" starts a new challenge.
  8790. auto scheme_end =
  8791. space_pos == std::string::npos ? key_part.size() : space_pos;
  8792. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8793. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8794. // from one challenge is never paired with another's algorithm.
  8795. in_digest_challenge =
  8796. !found_digest &&
  8797. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8798. if (in_digest_challenge) { found_digest = true; }
  8799. if (space_pos == std::string::npos) {
  8800. // Bare scheme (or a token68), no auth-param on this segment.
  8801. return;
  8802. }
  8803. key_part = key_part.substr(space_pos + 1);
  8804. }
  8805. if (!in_digest_challenge) { return; }
  8806. auto val = trim_copy(segment.substr(eq_pos + 1));
  8807. auto unquoted = trim_double_quotes_copy(val);
  8808. if (unquoted.size() != val.size()) {
  8809. unquoted = unescape_quoted_pairs(unquoted);
  8810. }
  8811. auth[std::move(key_part)] = std::move(unquoted);
  8812. });
  8813. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8814. // make_digest_authentication_header() dereferences both unconditionally, so
  8815. // a challenge missing either can't produce a usable Authorization header.
  8816. // Treat it the same as no Digest challenge at all.
  8817. return found_digest && auth.find("realm") != auth.end() &&
  8818. auth.find("nonce") != auth.end();
  8819. }
  8820. class ContentProviderAdapter {
  8821. public:
  8822. explicit ContentProviderAdapter(
  8823. ContentProviderWithoutLength &&content_provider)
  8824. : content_provider_(std::move(content_provider)) {}
  8825. bool operator()(size_t offset, size_t, DataSink &sink) {
  8826. return content_provider_(offset, sink);
  8827. }
  8828. private:
  8829. ContentProviderWithoutLength content_provider_;
  8830. };
  8831. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8832. namespace fields {
  8833. inline bool is_token_char(char c) {
  8834. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8835. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8836. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8837. }
  8838. inline bool is_token(const std::string &s) {
  8839. if (s.empty()) { return false; }
  8840. for (auto c : s) {
  8841. if (!is_token_char(c)) { return false; }
  8842. }
  8843. return true;
  8844. }
  8845. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8846. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8847. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8848. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8849. inline bool is_field_content(const std::string &s) {
  8850. if (s.empty()) { return true; }
  8851. if (s.size() == 1) {
  8852. return is_field_vchar(s[0]);
  8853. } else if (s.size() == 2) {
  8854. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8855. } else {
  8856. size_t i = 0;
  8857. if (!is_field_vchar(s[i])) { return false; }
  8858. i++;
  8859. while (i < s.size() - 1) {
  8860. auto c = s[i++];
  8861. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8862. } else {
  8863. return false;
  8864. }
  8865. }
  8866. return is_field_vchar(s[i]);
  8867. }
  8868. }
  8869. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8870. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8871. return is_field_name(name) && is_field_value(value);
  8872. }
  8873. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8874. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8875. inline bool is_request_target(const std::string &s) {
  8876. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8877. }
  8878. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8879. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8880. inline bool is_host(const std::string &s) {
  8881. return std::all_of(s.begin(), s.end(), [](char c) {
  8882. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8883. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8884. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8885. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8886. });
  8887. }
  8888. } // namespace fields
  8889. // Built in memory first, like ClientImpl::write_request, so a rejected header
  8890. // never leaves a partial request on the wire.
  8891. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  8892. BufferStream bstrm;
  8893. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8894. error = Error::Write;
  8895. return false;
  8896. }
  8897. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8898. return false;
  8899. }
  8900. const auto &data = bstrm.get_buffer();
  8901. if (!write_data(strm, data.data(), data.size())) {
  8902. error = Error::Write;
  8903. return false;
  8904. }
  8905. return true;
  8906. }
  8907. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8908. WebSocketUpgradeResponse &upgrade) {
  8909. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8910. std::string key_bytes(16, '\0');
  8911. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8912. key_bytes.size());
  8913. auto client_key = base64_encode(key_bytes);
  8914. req.headers.erase("Upgrade");
  8915. req.headers.erase("Connection");
  8916. req.headers.erase("Sec-WebSocket-Key");
  8917. req.headers.erase("Sec-WebSocket-Version");
  8918. req.headers.emplace("Upgrade", "websocket");
  8919. req.headers.emplace("Connection", "Upgrade");
  8920. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8921. req.headers.emplace("Sec-WebSocket-Version", "13");
  8922. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  8923. // Verify 101 response and Sec-WebSocket-Accept header
  8924. auto expected_accept = websocket_accept_key(client_key);
  8925. auto offered_subprotocols =
  8926. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8927. return read_websocket_upgrade_response(strm, expected_accept,
  8928. offered_subprotocols, upgrade);
  8929. }
  8930. inline bool is_ip_address(const std::string &host) {
  8931. struct in_addr addr4;
  8932. struct in6_addr addr6;
  8933. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8934. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8935. }
  8936. // Resolve where a client should connect for `host`, honoring a user-supplied
  8937. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8938. // supplying the Host header and SNI; only the connection target changes.
  8939. //
  8940. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8941. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8942. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8943. // absent or empty mapping leaves `host` as the connection target; without the
  8944. // empty check the value would reach getaddrinfo as a null node and silently
  8945. // resolve to loopback.
  8946. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8947. const std::string &host, std::string &connect_host,
  8948. std::string &ip) {
  8949. connect_host = host;
  8950. ip.clear();
  8951. auto it = addr_map.find(host);
  8952. if (it == addr_map.end() || it->second.empty()) { return; }
  8953. if (is_ip_address(it->second)) {
  8954. ip = it->second;
  8955. } else {
  8956. connect_host = it->second;
  8957. }
  8958. }
  8959. } // namespace detail
  8960. /*
  8961. * Group 2: detail namespace - SSL common utilities
  8962. */
  8963. #ifdef CPPHTTPLIB_SSL_ENABLED
  8964. namespace detail {
  8965. class SSLSocketStream final : public Stream {
  8966. public:
  8967. SSLSocketStream(
  8968. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8969. time_t read_timeout_usec, time_t write_timeout_sec,
  8970. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8971. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8972. (std::chrono::steady_clock::time_point::min)());
  8973. ~SSLSocketStream() override;
  8974. bool is_readable() const override;
  8975. bool wait_readable() const override;
  8976. bool wait_writable() const override;
  8977. bool is_peer_alive() const override;
  8978. ssize_t read(char *ptr, size_t size) override;
  8979. ssize_t write(const char *ptr, size_t size) override;
  8980. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8981. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8982. socket_t socket() const override;
  8983. time_t duration() const override;
  8984. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8985. void set_max_timeout(time_t msec) override;
  8986. // See SocketStream::set_readable_hint().
  8987. void set_readable_hint() { readable_hint_ = true; }
  8988. // The error from the last read() or write() that failed in the TLS layer,
  8989. // with code Success if none did
  8990. const tls::TlsError &tls_error() const { return tls_error_; }
  8991. private:
  8992. bool ensure_readable();
  8993. socket_t sock_;
  8994. tls::session_t session_;
  8995. time_t read_timeout_sec_;
  8996. time_t read_timeout_usec_;
  8997. time_t write_timeout_sec_;
  8998. time_t write_timeout_usec_;
  8999. time_t max_timeout_msec_;
  9000. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9001. bool readable_hint_ = false;
  9002. tls::TlsError tls_error_;
  9003. };
  9004. // A TLS stream for WebSocket connections, where the receive path and the
  9005. // send path (application send() plus the heartbeat ping thread) run on
  9006. // different threads. A single TLS session must never be entered
  9007. // concurrently, so every call into the session is serialized by one mutex.
  9008. //
  9009. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9010. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9011. // call under the lock, then waits for readiness with select() outside the
  9012. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9013. // blocked waiting for data never stalls a concurrent sender.
  9014. //
  9015. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9016. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9017. class WebSocketSSLStream final : public Stream {
  9018. public:
  9019. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9020. time_t read_timeout_sec, time_t read_timeout_usec,
  9021. time_t write_timeout_sec, time_t write_timeout_usec);
  9022. ~WebSocketSSLStream() override;
  9023. bool is_readable() const override;
  9024. bool wait_readable() const override;
  9025. bool wait_writable() const override;
  9026. ssize_t read(char *ptr, size_t size) override;
  9027. ssize_t write(const char *ptr, size_t size) override;
  9028. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9029. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9030. socket_t socket() const override;
  9031. time_t duration() const override;
  9032. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9033. private:
  9034. mutable std::mutex session_mutex_;
  9035. socket_t sock_;
  9036. tls::session_t session_;
  9037. // WebSocket::close() shortens the read timeout from the closing thread
  9038. // while the receive thread is inside wait_readable(), so these two are read
  9039. // and written concurrently. The write timeouts are never mutated.
  9040. std::atomic<time_t> read_timeout_sec_;
  9041. std::atomic<time_t> read_timeout_usec_;
  9042. time_t write_timeout_sec_;
  9043. time_t write_timeout_usec_;
  9044. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9045. };
  9046. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9047. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9048. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9049. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9050. unsigned int hash_length = 0;
  9051. unsigned char hash[EVP_MAX_MD_SIZE];
  9052. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9053. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9054. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9055. std::stringstream ss;
  9056. for (auto i = 0u; i < hash_length; ++i) {
  9057. ss << std::hex << std::setw(2) << std::setfill('0')
  9058. << static_cast<unsigned int>(hash[i]);
  9059. }
  9060. return ss.str();
  9061. }
  9062. inline std::string MD5(const std::string &s) {
  9063. return message_digest(s, EVP_md5());
  9064. }
  9065. inline std::string SHA_256(const std::string &s) {
  9066. return message_digest(s, EVP_sha256());
  9067. }
  9068. inline std::string SHA_512(const std::string &s) {
  9069. return message_digest(s, EVP_sha512());
  9070. }
  9071. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9072. namespace {
  9073. template <size_t N>
  9074. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9075. std::stringstream ss;
  9076. for (size_t i = 0; i < N; ++i) {
  9077. ss << std::hex << std::setw(2) << std::setfill('0')
  9078. << static_cast<unsigned int>(hash[i]);
  9079. }
  9080. return ss.str();
  9081. }
  9082. } // namespace
  9083. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9084. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9085. // initialized once. PSA state is process-global; do not free it.
  9086. inline bool ensure_mbedtls_psa_crypto() {
  9087. static std::once_flag once;
  9088. static bool ok = false;
  9089. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9090. return ok;
  9091. }
  9092. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9093. unsigned char *out, size_t out_size) {
  9094. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9095. size_t olen = 0;
  9096. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9097. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9098. olen == out_size;
  9099. }
  9100. #endif
  9101. inline std::string MD5(const std::string &s) {
  9102. unsigned char hash[16];
  9103. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9104. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9105. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9106. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9107. hash);
  9108. #else
  9109. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9110. hash);
  9111. #endif
  9112. return hash_to_hex(hash);
  9113. }
  9114. inline std::string SHA_256(const std::string &s) {
  9115. unsigned char hash[32];
  9116. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9117. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9118. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9119. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9120. hash, 0);
  9121. #else
  9122. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9123. s.size(), hash, 0);
  9124. #endif
  9125. return hash_to_hex(hash);
  9126. }
  9127. inline std::string SHA_512(const std::string &s) {
  9128. unsigned char hash[64];
  9129. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9130. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9131. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9132. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9133. hash, 0);
  9134. #else
  9135. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9136. s.size(), hash, 0);
  9137. #endif
  9138. return hash_to_hex(hash);
  9139. }
  9140. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9141. namespace {
  9142. template <size_t N>
  9143. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9144. std::stringstream ss;
  9145. for (size_t i = 0; i < N; ++i) {
  9146. ss << std::hex << std::setw(2) << std::setfill('0')
  9147. << static_cast<unsigned int>(hash[i]);
  9148. }
  9149. return ss.str();
  9150. }
  9151. } // namespace
  9152. inline std::string MD5(const std::string &s) {
  9153. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9154. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9155. static_cast<word32>(s.size()), hash);
  9156. return hash_to_hex(hash);
  9157. }
  9158. inline std::string SHA_256(const std::string &s) {
  9159. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9160. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9161. static_cast<word32>(s.size()), hash);
  9162. return hash_to_hex(hash);
  9163. }
  9164. inline std::string SHA_512(const std::string &s) {
  9165. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9166. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9167. static_cast<word32>(s.size()), hash);
  9168. return hash_to_hex(hash);
  9169. }
  9170. #endif
  9171. template <typename T>
  9172. inline bool process_server_socket_ssl(
  9173. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9174. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9175. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9176. time_t write_timeout_usec, T callback) {
  9177. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9178. // of a pipelined request, which keep_alive() cannot see on the socket.
  9179. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9180. write_timeout_sec, write_timeout_usec);
  9181. return process_server_socket_core(
  9182. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9183. [&]() { return strm.is_readable(); },
  9184. [&](bool socket_readable, bool close_connection,
  9185. bool &connection_closed) {
  9186. if (socket_readable) { strm.set_readable_hint(); }
  9187. return callback(strm, close_connection, connection_closed);
  9188. });
  9189. }
  9190. template <typename T>
  9191. inline bool process_client_socket_ssl(
  9192. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9193. time_t read_timeout_usec, time_t write_timeout_sec,
  9194. time_t write_timeout_usec, time_t max_timeout_msec,
  9195. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9196. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9197. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9198. start_time);
  9199. return callback(strm);
  9200. }
  9201. // `uri` is req's request-target in origin form, as curl sends it, also when
  9202. // the request line carries the absolute form for a proxy.
  9203. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9204. const Request &req, const std::string &uri,
  9205. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9206. const std::string &cnonce, const std::string &username,
  9207. const std::string &password, bool is_proxy = false) {
  9208. std::string nc;
  9209. {
  9210. std::stringstream ss;
  9211. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9212. nc = ss.str();
  9213. }
  9214. std::string qop;
  9215. if (auth.find("qop") != auth.end()) {
  9216. qop = auth.at("qop");
  9217. if (qop.find("auth-int") != std::string::npos) {
  9218. qop = "auth-int";
  9219. } else if (qop.find("auth") != std::string::npos) {
  9220. qop = "auth";
  9221. } else {
  9222. qop.clear();
  9223. }
  9224. }
  9225. std::string algo = "MD5";
  9226. if (auth.find("algorithm") != auth.end()) {
  9227. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9228. // not a token would otherwise be emitted verbatim and could carry commas
  9229. // or quotes that inject further auth-params into the header below.
  9230. const auto &a = auth.at("algorithm");
  9231. if (fields::is_token(a)) { algo = a; }
  9232. }
  9233. std::string response;
  9234. {
  9235. auto H = algo == "SHA-256" ? detail::SHA_256
  9236. : algo == "SHA-512" ? detail::SHA_512
  9237. : detail::MD5;
  9238. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9239. auto A2 = req.method + ":" + uri;
  9240. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9241. if (qop.empty()) {
  9242. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9243. } else {
  9244. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9245. ":" + qop + ":" + H(A2));
  9246. }
  9247. }
  9248. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9249. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9250. // close the string early. realm, nonce and opaque come straight from the
  9251. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9252. // without this a crafted challenge injects extra auth-params into the header.
  9253. auto field =
  9254. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9255. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9256. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9257. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9258. "\", algorithm=" + algo +
  9259. (qop.empty() ? ", response=\""
  9260. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9261. "\", response=\"") +
  9262. response + "\"" +
  9263. (opaque.empty()
  9264. ? ""
  9265. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9266. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9267. return std::make_pair(key, field);
  9268. }
  9269. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9270. // backend accepts the same names.
  9271. inline bool match_hostname(const std::string &pattern,
  9272. const std::string &hostname) {
  9273. // A trailing dot on the host is ignored
  9274. auto host = hostname;
  9275. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9276. // Exact match (case-insensitive)
  9277. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9278. // Split both pattern and hostname into components by '.', keeping any empty
  9279. // one, which no name may have
  9280. auto labels = [](const std::string &s) {
  9281. std::vector<std::string> v;
  9282. size_t b = 0;
  9283. while (true) {
  9284. auto e = s.find('.', b);
  9285. v.push_back(s.substr(b, e - b));
  9286. if (e == std::string::npos) { return v; }
  9287. b = e + 1;
  9288. }
  9289. };
  9290. auto pattern_components = labels(pattern);
  9291. auto host_components = labels(host);
  9292. auto has_empty_label = [](const std::vector<std::string> &v) {
  9293. return std::any_of(v.begin(), v.end(),
  9294. [](const std::string &l) { return l.empty(); });
  9295. };
  9296. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9297. return false;
  9298. }
  9299. // Component count must match
  9300. if (host_components.size() != pattern_components.size()) { return false; }
  9301. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9302. // and an IDNA label may not have one
  9303. const auto &leftmost = pattern_components.front();
  9304. if (leftmost.find('*') != std::string::npos &&
  9305. (pattern_components.size() < 3 ||
  9306. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9307. return false;
  9308. }
  9309. // Compare each component with wildcard support
  9310. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9311. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9312. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9313. auto itr = pattern_components.begin();
  9314. for (const auto &h : host_components) {
  9315. auto &p = *itr;
  9316. auto is_leftmost = itr == pattern_components.begin();
  9317. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9318. bool partial_match = false;
  9319. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9320. const auto prefix_length = p.size() - 1;
  9321. if (prefix_length == 0) {
  9322. partial_match = true;
  9323. } else if (h.size() >= prefix_length) {
  9324. partial_match =
  9325. std::equal(p.begin(),
  9326. p.begin() + static_cast<std::string::difference_type>(
  9327. prefix_length),
  9328. h.begin(), [](const char ca, const char cb) {
  9329. return detail::case_ignore::to_lower(ca) ==
  9330. detail::case_ignore::to_lower(cb);
  9331. });
  9332. }
  9333. }
  9334. if (!partial_match) { return false; }
  9335. }
  9336. ++itr;
  9337. }
  9338. return true;
  9339. }
  9340. #ifdef _WIN32
  9341. // Verify certificate using Windows CertGetCertificateChain API.
  9342. // This provides real-time certificate validation with Windows Update
  9343. // integration, independent of the TLS backend.
  9344. inline bool verify_cert_with_windows_schannel(
  9345. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9346. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9347. if (der_cert.empty()) { return false; }
  9348. out_error = 0;
  9349. // Create Windows certificate context from DER data
  9350. auto cert_context = CertCreateCertificateContext(
  9351. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9352. static_cast<DWORD>(der_cert.size()));
  9353. if (!cert_context) {
  9354. out_error = GetLastError();
  9355. return false;
  9356. }
  9357. auto cert_guard =
  9358. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9359. // Give CryptoAPI the certificates the server sent. Without them it follows
  9360. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9361. std::vector<tls::cert_t> peer_certs;
  9362. tls::get_peer_certs(session, peer_certs);
  9363. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9364. auto store_guard = scope_exit([&] {
  9365. for (auto cert : peer_certs) {
  9366. tls::free_cert(cert);
  9367. }
  9368. if (store) { CertCloseStore(store, 0); }
  9369. });
  9370. for (auto cert : peer_certs) {
  9371. std::vector<unsigned char> der;
  9372. if (store && tls::get_cert_der(cert, der)) {
  9373. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9374. static_cast<DWORD>(der.size()),
  9375. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9376. }
  9377. }
  9378. // Setup chain parameters
  9379. CERT_CHAIN_PARA chain_para = {};
  9380. chain_para.cbSize = sizeof(chain_para);
  9381. // Require the server authentication usage along the chain, which also
  9382. // rejects roots that Windows trusts only for other purposes.
  9383. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9384. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9385. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9386. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9387. // Build certificate chain with revocation checking
  9388. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9389. auto chain_result = CertGetCertificateChain(
  9390. nullptr, cert_context, nullptr, store, &chain_para,
  9391. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9392. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9393. nullptr, &chain_context);
  9394. if (!chain_result || !chain_context) {
  9395. out_error = GetLastError();
  9396. return false;
  9397. }
  9398. auto chain_guard =
  9399. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9400. // Verify SSL policy
  9401. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9402. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9403. #ifdef AUTHTYPE_SERVER
  9404. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9405. #endif
  9406. std::wstring whost;
  9407. if (verify_hostname) {
  9408. whost = u8string_to_wstring(hostname.c_str());
  9409. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9410. }
  9411. CERT_CHAIN_POLICY_PARA policy_para = {};
  9412. policy_para.cbSize = sizeof(policy_para);
  9413. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9414. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9415. #else
  9416. policy_para.dwFlags = 0;
  9417. #endif
  9418. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9419. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9420. policy_status.cbSize = sizeof(policy_status);
  9421. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9422. &policy_para, &policy_status)) {
  9423. out_error = GetLastError();
  9424. return false;
  9425. }
  9426. if (policy_status.dwError != 0) {
  9427. out_error = policy_status.dwError;
  9428. return false;
  9429. }
  9430. return true;
  9431. }
  9432. #endif // _WIN32
  9433. // Loads CA file/dir configuration and applies the system CA policy to a
  9434. // client TLS context. PEM data and native stores are applied to the context
  9435. // directly at set time; has_custom_store reflects them for the Auto policy
  9436. // decision.
  9437. inline bool load_client_ca_config(tls::ctx_t ctx,
  9438. const std::string &ca_cert_file_path,
  9439. const std::string &ca_cert_dir_path,
  9440. bool has_custom_store, SystemCAMode mode,
  9441. uint64_t &backend_error) {
  9442. auto ret = true;
  9443. if (!ca_cert_file_path.empty()) {
  9444. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9445. backend_error = tls::get_error();
  9446. ret = false;
  9447. }
  9448. } else if (!ca_cert_dir_path.empty()) {
  9449. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9450. backend_error = tls::get_error();
  9451. ret = false;
  9452. }
  9453. }
  9454. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9455. !ca_cert_dir_path.empty() || has_custom_store;
  9456. if (mode == SystemCAMode::Enabled ||
  9457. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9458. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9459. }
  9460. return ret;
  9461. }
  9462. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9463. // loaded into another context.
  9464. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9465. std::string pem;
  9466. std::vector<tls::cert_t> certs;
  9467. tls::get_ca_certs(ctx, certs);
  9468. for (auto cert : certs) {
  9469. std::vector<unsigned char> der;
  9470. if (tls::get_cert_der(cert, der)) {
  9471. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9472. pem += "-----BEGIN CERTIFICATE-----\n";
  9473. for (size_t i = 0; i < b64.size(); i += 64) {
  9474. pem += b64.substr(i, 64);
  9475. pem += '\n';
  9476. }
  9477. pem += "-----END CERTIFICATE-----\n";
  9478. }
  9479. tls::free_cert(cert);
  9480. }
  9481. return pem;
  9482. }
  9483. // The parts of session setup that only SSLClient needs, plus the handful
  9484. // WebSocketClient also exposes; everything else takes the defaults, which is
  9485. // what keeps the two clients on one implementation.
  9486. struct ClientTlsSessionOptions {
  9487. // Both SSLClient and WebSocketClient expose this independently of
  9488. // certificate verification.
  9489. bool server_hostname_verification = true;
  9490. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9491. // When non-null, guards session creation against concurrent use of the
  9492. // context. A WebSocketClient is not safe to use from several threads to
  9493. // begin with, so it passes nothing.
  9494. std::mutex *ctx_mutex = nullptr;
  9495. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9496. // The caller decides whether Schannel has anything to say about this
  9497. // connection; see SSLClient::initialize_ssl().
  9498. bool windows_cert_verification = false;
  9499. // A server certificate verifier works on the backend's chain verification,
  9500. // so the backend keeps deciding and Schannel only adds its own check.
  9501. bool server_certificate_verifier_set = false;
  9502. #endif
  9503. };
  9504. // Filled in on failure for callers that report error details.
  9505. struct ClientTlsSessionError {
  9506. Error error = Error::Success;
  9507. int ssl_error = 0;
  9508. uint64_t backend_error = 0;
  9509. };
  9510. // Establishes a client TLS session on an already connected socket. On failure
  9511. // the session is left for the caller to free: SSLClient frees it right away,
  9512. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9513. inline bool setup_client_tls_session(
  9514. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9515. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9516. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9517. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9518. using namespace tls;
  9519. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9520. if (out_error) {
  9521. out_error->error = error;
  9522. out_error->ssl_error = ssl_error;
  9523. out_error->backend_error = backend_error;
  9524. }
  9525. return false;
  9526. };
  9527. if (!ctx) {
  9528. session = nullptr;
  9529. return fail(Error::SSLConnection, 0, 0);
  9530. }
  9531. // With Windows verification on and no server certificate verifier set,
  9532. // Schannel is the only chain verifier. The backend's trust store is a
  9533. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9534. // demand, so the backend's verdict is not used.
  9535. auto windows_verifies_chain = false;
  9536. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9537. windows_verifies_chain = options.windows_cert_verification &&
  9538. !options.server_certificate_verifier_set;
  9539. #endif
  9540. {
  9541. std::unique_lock<std::mutex> guard;
  9542. if (options.ctx_mutex) {
  9543. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9544. }
  9545. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9546. // Mbed TLS and wolfSSL need the verification mode set explicitly, on the
  9547. // context, so under the same lock; OpenSSL uses SSL_VERIFY_NONE and does
  9548. // all verification post-handshake. Unless Schannel verifies the chain
  9549. // instead, chain verification happens during the handshake even for IP
  9550. // hosts; the certificate identity is verified post-handshake via
  9551. // verify_hostname().
  9552. set_verify_client(ctx, server_certificate_verification &&
  9553. !windows_verifies_chain);
  9554. #endif
  9555. session = create_session(ctx, sock);
  9556. }
  9557. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9558. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9559. // their identity is checked post-handshake below instead. On Mbed TLS and
  9560. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9561. // options.server_hostname_verification is threaded through here.
  9562. if (!is_ip_address(host)) {
  9563. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9564. return fail(Error::SSLConnection, 0, get_error());
  9565. }
  9566. }
  9567. TlsError tls_err;
  9568. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9569. &tls_err)) {
  9570. auto error = Error::SSLConnection;
  9571. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9572. error = Error::SSLServerVerification;
  9573. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9574. error = Error::SSLServerHostnameVerification;
  9575. }
  9576. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9577. }
  9578. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9579. if (options.session_verifier) {
  9580. verification_status = options.session_verifier(session);
  9581. }
  9582. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9583. return fail(Error::SSLServerVerification, 0, get_error());
  9584. }
  9585. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9586. server_certificate_verification) {
  9587. if (!windows_verifies_chain) {
  9588. auto verify_result = get_verify_result(session);
  9589. if (verify_result != 0) {
  9590. return fail(Error::SSLServerVerification, 0,
  9591. static_cast<uint64_t>(verify_result));
  9592. }
  9593. }
  9594. auto server_cert = get_peer_cert(session);
  9595. if (!server_cert) {
  9596. return fail(Error::SSLServerVerification, 0, get_error());
  9597. }
  9598. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9599. // Identity check against the peer certificate, post-handshake for all
  9600. // backends. For IP hosts this is the only identity verification, since no
  9601. // hostname is bound during the handshake.
  9602. if (options.server_hostname_verification) {
  9603. if (!verify_hostname(server_cert, host.c_str())) {
  9604. return fail(Error::SSLServerHostnameVerification, 0,
  9605. hostname_mismatch_code());
  9606. }
  9607. }
  9608. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9609. // Windows Schannel verification, which lets Windows fetch missing roots
  9610. // and intermediates on demand. It must not be skipped: unless a server
  9611. // certificate verifier is set, it is the only chain check.
  9612. if (options.windows_cert_verification) {
  9613. std::vector<unsigned char> der;
  9614. uint64_t wincrypt_error = 0;
  9615. if (!get_cert_der(server_cert, der) ||
  9616. !verify_cert_with_windows_schannel(
  9617. der, host, options.server_hostname_verification, wincrypt_error,
  9618. session)) {
  9619. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9620. }
  9621. }
  9622. #endif
  9623. }
  9624. return true;
  9625. }
  9626. } // namespace detail
  9627. #endif // CPPHTTPLIB_SSL_ENABLED
  9628. /*
  9629. * Group 3: httplib namespace - Non-SSL public API implementations
  9630. */
  9631. inline void default_socket_options(socket_t sock) {
  9632. set_socket_opt(sock, SOL_SOCKET,
  9633. #ifdef SO_REUSEPORT
  9634. SO_REUSEPORT,
  9635. #else
  9636. SO_REUSEADDR,
  9637. #endif
  9638. 1);
  9639. }
  9640. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9641. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9642. sizeof(optval));
  9643. }
  9644. inline std::string get_bearer_token_auth(const Request &req) {
  9645. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9646. // than the prefix carries no token.
  9647. constexpr const char bearer_prefix[] = "Bearer ";
  9648. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9649. auto value = req.get_header_value("Authorization");
  9650. if (value.size() >= bearer_prefix_len &&
  9651. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9652. bearer_prefix)) {
  9653. return value.substr(bearer_prefix_len);
  9654. }
  9655. return "";
  9656. }
  9657. inline const char *status_message(int status) {
  9658. switch (status) {
  9659. case StatusCode::Continue_100: return "Continue";
  9660. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9661. case StatusCode::Processing_102: return "Processing";
  9662. case StatusCode::EarlyHints_103: return "Early Hints";
  9663. case StatusCode::OK_200: return "OK";
  9664. case StatusCode::Created_201: return "Created";
  9665. case StatusCode::Accepted_202: return "Accepted";
  9666. case StatusCode::NonAuthoritativeInformation_203:
  9667. return "Non-Authoritative Information";
  9668. case StatusCode::NoContent_204: return "No Content";
  9669. case StatusCode::ResetContent_205: return "Reset Content";
  9670. case StatusCode::PartialContent_206: return "Partial Content";
  9671. case StatusCode::MultiStatus_207: return "Multi-Status";
  9672. case StatusCode::AlreadyReported_208: return "Already Reported";
  9673. case StatusCode::IMUsed_226: return "IM Used";
  9674. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9675. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9676. case StatusCode::Found_302: return "Found";
  9677. case StatusCode::SeeOther_303: return "See Other";
  9678. case StatusCode::NotModified_304: return "Not Modified";
  9679. case StatusCode::UseProxy_305: return "Use Proxy";
  9680. case StatusCode::unused_306: return "unused";
  9681. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9682. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9683. case StatusCode::BadRequest_400: return "Bad Request";
  9684. case StatusCode::Unauthorized_401: return "Unauthorized";
  9685. case StatusCode::PaymentRequired_402: return "Payment Required";
  9686. case StatusCode::Forbidden_403: return "Forbidden";
  9687. case StatusCode::NotFound_404: return "Not Found";
  9688. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9689. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9690. case StatusCode::ProxyAuthenticationRequired_407:
  9691. return "Proxy Authentication Required";
  9692. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9693. case StatusCode::Conflict_409: return "Conflict";
  9694. case StatusCode::Gone_410: return "Gone";
  9695. case StatusCode::LengthRequired_411: return "Length Required";
  9696. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9697. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9698. case StatusCode::UriTooLong_414: return "URI Too Long";
  9699. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9700. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9701. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9702. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9703. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9704. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9705. case StatusCode::Locked_423: return "Locked";
  9706. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9707. case StatusCode::TooEarly_425: return "Too Early";
  9708. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9709. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9710. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9711. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9712. return "Request Header Fields Too Large";
  9713. case StatusCode::UnavailableForLegalReasons_451:
  9714. return "Unavailable For Legal Reasons";
  9715. case StatusCode::NotImplemented_501: return "Not Implemented";
  9716. case StatusCode::BadGateway_502: return "Bad Gateway";
  9717. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9718. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9719. case StatusCode::HttpVersionNotSupported_505:
  9720. return "HTTP Version Not Supported";
  9721. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9722. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9723. case StatusCode::LoopDetected_508: return "Loop Detected";
  9724. case StatusCode::NotExtended_510: return "Not Extended";
  9725. case StatusCode::NetworkAuthenticationRequired_511:
  9726. return "Network Authentication Required";
  9727. default:
  9728. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9729. }
  9730. }
  9731. inline std::string to_string(const Error error) {
  9732. switch (error) {
  9733. case Error::Success: return "Success (no error)";
  9734. case Error::Unknown: return "Unknown";
  9735. case Error::Connection: return "Could not establish connection";
  9736. case Error::BindIPAddress: return "Failed to bind IP address";
  9737. case Error::Read: return "Failed to read connection";
  9738. case Error::Write: return "Failed to write connection";
  9739. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9740. case Error::Canceled: return "Connection handling canceled";
  9741. case Error::SSLConnection: return "SSL connection failed";
  9742. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9743. case Error::SSLServerVerification: return "SSL server verification failed";
  9744. case Error::SSLServerHostnameVerification:
  9745. return "SSL server hostname verification failed";
  9746. case Error::UnsupportedMultipartBoundaryChars:
  9747. return "Unsupported HTTP multipart boundary characters";
  9748. case Error::Compression: return "Compression failed";
  9749. case Error::ConnectionTimeout: return "Connection timed out";
  9750. case Error::ProxyConnection: return "Proxy connection failed";
  9751. case Error::ConnectionClosed: return "Connection closed by server";
  9752. case Error::Timeout: return "Read timeout";
  9753. case Error::ResourceExhaustion: return "Resource exhaustion";
  9754. case Error::TooManyFormDataFiles: return "Too many form data files";
  9755. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9756. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9757. case Error::ExceedMaxSocketDescriptorCount:
  9758. return "Exceeded maximum socket descriptor count";
  9759. case Error::InvalidRequestLine: return "Invalid request line";
  9760. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9761. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9762. case Error::InvalidHeaders: return "Invalid headers";
  9763. case Error::MultipartParsing: return "Multipart parsing failed";
  9764. case Error::OpenFile: return "Failed to open file";
  9765. case Error::Listen: return "Failed to listen on socket";
  9766. case Error::GetSockName: return "Failed to get socket name";
  9767. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9768. case Error::HTTPParsing: return "HTTP parsing failed";
  9769. case Error::InvalidRangeHeader: return "Invalid Range header";
  9770. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9771. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9772. case Error::UserCallbackException: return "User callback threw an exception";
  9773. default: break;
  9774. }
  9775. return "Invalid";
  9776. }
  9777. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9778. os << to_string(obj);
  9779. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9780. return os;
  9781. }
  9782. inline std::string hosted_at(const std::string &hostname) {
  9783. std::vector<std::string> addrs;
  9784. hosted_at(hostname, addrs);
  9785. if (addrs.empty()) { return std::string(); }
  9786. return addrs[0];
  9787. }
  9788. inline void hosted_at(const std::string &hostname,
  9789. std::vector<std::string> &addrs) {
  9790. struct addrinfo hints;
  9791. struct addrinfo *result;
  9792. memset(&hints, 0, sizeof(struct addrinfo));
  9793. hints.ai_family = AF_UNSPEC;
  9794. hints.ai_socktype = SOCK_STREAM;
  9795. hints.ai_protocol = 0;
  9796. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9797. &result, 0)) {
  9798. #if defined __linux__ && !defined __ANDROID__
  9799. res_init();
  9800. #endif
  9801. return;
  9802. }
  9803. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9804. for (auto rp = result; rp; rp = rp->ai_next) {
  9805. const auto &addr =
  9806. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9807. std::string ip;
  9808. auto dummy = -1;
  9809. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9810. dummy)) {
  9811. addrs.emplace_back(std::move(ip));
  9812. }
  9813. }
  9814. }
  9815. inline std::string encode_uri_component(const std::string &value) {
  9816. std::ostringstream escaped;
  9817. escaped.fill('0');
  9818. escaped << std::hex;
  9819. for (auto c : value) {
  9820. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9821. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9822. escaped << c;
  9823. } else {
  9824. escaped << std::uppercase;
  9825. escaped << '%' << std::setw(2)
  9826. << static_cast<int>(static_cast<unsigned char>(c));
  9827. escaped << std::nouppercase;
  9828. }
  9829. }
  9830. return escaped.str();
  9831. }
  9832. inline std::string encode_uri(const std::string &value) {
  9833. std::ostringstream escaped;
  9834. escaped.fill('0');
  9835. escaped << std::hex;
  9836. for (auto c : value) {
  9837. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9838. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9839. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9840. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9841. escaped << c;
  9842. } else {
  9843. escaped << std::uppercase;
  9844. escaped << '%' << std::setw(2)
  9845. << static_cast<int>(static_cast<unsigned char>(c));
  9846. escaped << std::nouppercase;
  9847. }
  9848. }
  9849. return escaped.str();
  9850. }
  9851. inline std::string decode_uri_component(const std::string &value) {
  9852. std::string result;
  9853. for (size_t i = 0; i < value.size(); i++) {
  9854. if (value[i] == '%' && i + 2 < value.size()) {
  9855. auto val = 0;
  9856. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9857. result += static_cast<char>(val);
  9858. i += 2;
  9859. } else {
  9860. result += value[i];
  9861. }
  9862. } else {
  9863. result += value[i];
  9864. }
  9865. }
  9866. return result;
  9867. }
  9868. inline std::string decode_uri(const std::string &value) {
  9869. std::string result;
  9870. for (size_t i = 0; i < value.size(); i++) {
  9871. if (value[i] == '%' && i + 2 < value.size()) {
  9872. auto val = 0;
  9873. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9874. auto c = static_cast<char>(val);
  9875. // Keep escapes of the reserved characters that encode_uri leaves
  9876. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9877. // delimiter is not promoted into a real one (as with JS decodeURI).
  9878. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9879. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9880. c == '#') {
  9881. result += value[i];
  9882. result += value[i + 1];
  9883. result += value[i + 2];
  9884. } else {
  9885. result += c;
  9886. }
  9887. i += 2;
  9888. } else {
  9889. result += value[i];
  9890. }
  9891. } else {
  9892. result += value[i];
  9893. }
  9894. }
  9895. return result;
  9896. }
  9897. inline std::string encode_path_component(const std::string &component) {
  9898. std::string result;
  9899. result.reserve(component.size() * 3);
  9900. for (size_t i = 0; i < component.size(); i++) {
  9901. auto c = static_cast<unsigned char>(component[i]);
  9902. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9903. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9904. c == '_' || c == '~') {
  9905. result += static_cast<char>(c);
  9906. }
  9907. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9908. // "," / ";" / "="
  9909. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9910. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9911. c == '=') {
  9912. result += static_cast<char>(c);
  9913. }
  9914. // Colon is allowed in path segments except first segment
  9915. else if (c == ':') {
  9916. result += static_cast<char>(c);
  9917. }
  9918. // @ is allowed in path
  9919. else if (c == '@') {
  9920. result += static_cast<char>(c);
  9921. } else {
  9922. result += '%';
  9923. char hex[3];
  9924. snprintf(hex, sizeof(hex), "%02X", c);
  9925. result.append(hex, 2);
  9926. }
  9927. }
  9928. return result;
  9929. }
  9930. inline std::string decode_path_component(const std::string &component) {
  9931. std::string result;
  9932. result.reserve(component.size());
  9933. for (size_t i = 0; i < component.size(); i++) {
  9934. if (component[i] == '%' && i + 1 < component.size()) {
  9935. if (component[i + 1] == 'u') {
  9936. // Unicode %uXXXX encoding
  9937. auto val = 0;
  9938. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9939. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9940. char buff[4];
  9941. size_t len = 0;
  9942. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  9943. (len = detail::to_utf8(val, buff)) > 0) {
  9944. result.append(buff, len);
  9945. i += 5; // 'u0000'
  9946. } else {
  9947. // Not 4 hex digits, or a surrogate, which is no character: the
  9948. // escape is kept as it is rather than joining its neighbours
  9949. result += component[i];
  9950. }
  9951. } else {
  9952. // Standard %XX encoding
  9953. auto val = 0;
  9954. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9955. // 2 digits hex codes
  9956. result += static_cast<char>(val);
  9957. i += 2; // 'XX'
  9958. } else {
  9959. result += component[i];
  9960. }
  9961. }
  9962. } else {
  9963. result += component[i];
  9964. }
  9965. }
  9966. return result;
  9967. }
  9968. inline std::string encode_query_component(const std::string &component,
  9969. bool space_as_plus) {
  9970. std::string result;
  9971. result.reserve(component.size() * 3);
  9972. for (size_t i = 0; i < component.size(); i++) {
  9973. auto c = static_cast<unsigned char>(component[i]);
  9974. // Unreserved characters per RFC 3986
  9975. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9976. c == '_' || c == '~') {
  9977. result += static_cast<char>(c);
  9978. }
  9979. // Space handling
  9980. else if (c == ' ') {
  9981. if (space_as_plus) {
  9982. result += '+';
  9983. } else {
  9984. result += "%20";
  9985. }
  9986. }
  9987. // Plus sign handling
  9988. else if (c == '+') {
  9989. if (space_as_plus) {
  9990. result += "%2B";
  9991. } else {
  9992. result += static_cast<char>(c);
  9993. }
  9994. }
  9995. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9996. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9997. c == '*' || c == ',' || c == ';') {
  9998. result += static_cast<char>(c);
  9999. }
  10000. // Colon and @ are allowed in query
  10001. else if (c == ':' || c == '@') {
  10002. result += static_cast<char>(c);
  10003. }
  10004. // Forward slash is allowed in query values
  10005. else if (c == '/') {
  10006. result += static_cast<char>(c);
  10007. }
  10008. // Question mark is allowed in query values (after first ?)
  10009. else if (c == '?') {
  10010. result += static_cast<char>(c);
  10011. } else {
  10012. result += '%';
  10013. char hex[3];
  10014. snprintf(hex, sizeof(hex), "%02X", c);
  10015. result.append(hex, 2);
  10016. }
  10017. }
  10018. return result;
  10019. }
  10020. inline std::string decode_query_component(const std::string &component,
  10021. bool plus_as_space) {
  10022. std::string result;
  10023. result.reserve(component.size());
  10024. for (size_t i = 0; i < component.size(); i++) {
  10025. if (component[i] == '%' && i + 2 < component.size()) {
  10026. auto val = 0;
  10027. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10028. result += static_cast<char>(val);
  10029. i += 2;
  10030. } else {
  10031. result += component[i];
  10032. }
  10033. } else if (component[i] == '+' && plus_as_space) {
  10034. result += ' '; // + becomes space in form-urlencoded
  10035. } else {
  10036. result += component[i];
  10037. }
  10038. }
  10039. return result;
  10040. }
  10041. inline std::string sanitize_filename(const std::string &filename) {
  10042. // Extract basename: find the last path separator (/ or \)
  10043. auto pos = filename.find_last_of("/\\");
  10044. auto result =
  10045. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10046. // Strip null bytes
  10047. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10048. // Trim whitespace
  10049. {
  10050. auto start = result.find_first_not_of(" \t");
  10051. auto end = result.find_last_not_of(" \t");
  10052. result = (start == std::string::npos)
  10053. ? ""
  10054. : result.substr(start, end - start + 1);
  10055. }
  10056. // Reject . and ..
  10057. if (result == "." || result == "..") { return ""; }
  10058. return result;
  10059. }
  10060. inline std::string append_query_params(const std::string &path,
  10061. const Params &params) {
  10062. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10063. auto fragment_pos = path.find('#');
  10064. auto path_with_query = path.substr(0, fragment_pos);
  10065. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10066. path_with_query += detail::params_to_query_str(params);
  10067. if (fragment_pos != std::string::npos) {
  10068. path_with_query.append(path, fragment_pos, std::string::npos);
  10069. }
  10070. return path_with_query;
  10071. }
  10072. // Header utilities
  10073. inline std::pair<std::string, std::string>
  10074. make_range_header(const Ranges &ranges) {
  10075. std::string field = "bytes=";
  10076. auto i = 0;
  10077. for (const auto &r : ranges) {
  10078. if (i != 0) { field += ", "; }
  10079. if (r.first != -1) { field += std::to_string(r.first); }
  10080. field += '-';
  10081. if (r.second != -1) { field += std::to_string(r.second); }
  10082. i++;
  10083. }
  10084. return std::make_pair("Range", std::move(field));
  10085. }
  10086. inline std::pair<std::string, std::string>
  10087. make_basic_authentication_header(const std::string &username,
  10088. const std::string &password, bool is_proxy) {
  10089. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10090. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10091. return std::make_pair(key, std::move(field));
  10092. }
  10093. inline std::pair<std::string, std::string>
  10094. make_bearer_token_authentication_header(const std::string &token,
  10095. bool is_proxy = false) {
  10096. auto field = "Bearer " + token;
  10097. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10098. return std::make_pair(key, std::move(field));
  10099. }
  10100. namespace detail {
  10101. // Basic auth when a username or password is set, otherwise a bearer token,
  10102. // unless the request already carries the header.
  10103. inline void add_authorization_header(Request &req, const std::string &username,
  10104. const std::string &password,
  10105. const std::string &token, bool is_proxy) {
  10106. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10107. return;
  10108. }
  10109. if (!username.empty() || !password.empty()) {
  10110. req.headers.insert(
  10111. make_basic_authentication_header(username, password, is_proxy));
  10112. } else if (!token.empty()) {
  10113. req.headers.insert(
  10114. make_bearer_token_authentication_header(token, is_proxy));
  10115. }
  10116. }
  10117. } // namespace detail
  10118. // Request implementation
  10119. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10120. size_t id) const {
  10121. return detail::get_header_value_u64(headers, key, def, id);
  10122. }
  10123. inline bool Request::has_header(const std::string &key) const {
  10124. return detail::has_header(headers, key);
  10125. }
  10126. inline std::string Request::get_header_value(const std::string &key,
  10127. const char *def, size_t id) const {
  10128. return detail::get_header_value(headers, key, def, id);
  10129. }
  10130. inline size_t Request::get_header_value_count(const std::string &key) const {
  10131. return detail::get_header_value_count(headers, key);
  10132. }
  10133. inline void Request::set_header(const std::string &key,
  10134. const std::string &val) {
  10135. detail::set_header(headers, key, val);
  10136. }
  10137. inline bool Request::has_trailer(const std::string &key) const {
  10138. return trailers.find(key) != trailers.end();
  10139. }
  10140. inline std::string Request::get_trailer_value(const std::string &key,
  10141. size_t id) const {
  10142. return detail::get_multimap_value(trailers, key, id);
  10143. }
  10144. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10145. return trailers.count(key);
  10146. }
  10147. inline bool Request::has_param(const std::string &key) const {
  10148. return params.find(key) != params.end();
  10149. }
  10150. inline std::string Request::get_param_value(const std::string &key,
  10151. size_t id) const {
  10152. return detail::get_multimap_value(params, key, id);
  10153. }
  10154. inline std::vector<std::string>
  10155. Request::get_param_values(const std::string &key) const {
  10156. auto rng = params.equal_range(key);
  10157. std::vector<std::string> values;
  10158. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10159. for (auto it = rng.first; it != rng.second; ++it) {
  10160. values.push_back(it->second);
  10161. }
  10162. return values;
  10163. }
  10164. inline size_t Request::get_param_value_count(const std::string &key) const {
  10165. return params.count(key);
  10166. }
  10167. inline bool Request::is_multipart_form_data() const {
  10168. const auto &content_type = get_header_value("Content-Type");
  10169. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10170. "multipart/form-data");
  10171. }
  10172. // Multipart FormData implementation
  10173. inline std::string MultipartFormData::get_field(const std::string &key,
  10174. size_t id) const {
  10175. auto rng = fields.equal_range(key);
  10176. auto it = detail::bounded_next(rng.first, id, rng.second);
  10177. if (it != rng.second) { return it->second.content; }
  10178. return std::string();
  10179. }
  10180. inline std::vector<std::string>
  10181. MultipartFormData::get_fields(const std::string &key) const {
  10182. std::vector<std::string> values;
  10183. auto rng = fields.equal_range(key);
  10184. for (auto it = rng.first; it != rng.second; it++) {
  10185. values.push_back(it->second.content);
  10186. }
  10187. return values;
  10188. }
  10189. inline bool MultipartFormData::has_field(const std::string &key) const {
  10190. return fields.find(key) != fields.end();
  10191. }
  10192. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10193. return fields.count(key);
  10194. }
  10195. inline FormData MultipartFormData::get_file(const std::string &key,
  10196. size_t id) const {
  10197. return detail::get_multimap_value(files, key, id);
  10198. }
  10199. inline std::vector<FormData>
  10200. MultipartFormData::get_files(const std::string &key) const {
  10201. std::vector<FormData> values;
  10202. auto rng = files.equal_range(key);
  10203. for (auto it = rng.first; it != rng.second; it++) {
  10204. values.push_back(it->second);
  10205. }
  10206. return values;
  10207. }
  10208. inline bool MultipartFormData::has_file(const std::string &key) const {
  10209. return files.find(key) != files.end();
  10210. }
  10211. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10212. return files.count(key);
  10213. }
  10214. // Multipart FormData writer implementation
  10215. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10216. return detail::is_multipart_boundary_chars_valid(boundary);
  10217. }
  10218. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10219. : boundary_(detail::make_multipart_data_boundary()) {}
  10220. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10221. : boundary_(std::move(boundary)) {}
  10222. inline const std::string &MultipartFormDataWriter::boundary() const {
  10223. return boundary_;
  10224. }
  10225. inline std::string MultipartFormDataWriter::content_type() const {
  10226. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10227. }
  10228. inline std::string
  10229. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10230. return detail::serialize_multipart_formdata(items, boundary_);
  10231. }
  10232. inline size_t MultipartFormDataWriter::content_length(
  10233. const UploadFormDataItems &items) const {
  10234. return detail::get_multipart_content_length(items, boundary_);
  10235. }
  10236. inline std::string
  10237. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10238. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10239. }
  10240. inline std::string MultipartFormDataWriter::item_end() {
  10241. return detail::serialize_multipart_formdata_item_end();
  10242. }
  10243. inline std::string MultipartFormDataWriter::finish() const {
  10244. return detail::serialize_multipart_formdata_finish(boundary_);
  10245. }
  10246. // Response implementation
  10247. namespace detail {
  10248. // A response has one content source: `body`, a content provider, or a file.
  10249. // Each content setter calls this so that the one called last wins.
  10250. inline void clear_content_provider(Response &res) {
  10251. auto releaser = std::move(res.content_provider_resource_releaser_);
  10252. auto success = res.content_provider_success_;
  10253. res.content_length_ = 0;
  10254. res.content_provider_ = nullptr;
  10255. res.content_provider_resource_releaser_ = nullptr;
  10256. res.is_chunked_content_provider_ = false;
  10257. res.is_file_content_provider_ = false;
  10258. res.content_provider_success_ = false;
  10259. res.content_coding_ = EncodingType::None;
  10260. res.file_content_path_.clear();
  10261. res.file_content_content_type_.clear();
  10262. if (releaser) { releaser(success); }
  10263. }
  10264. inline void clear_content(Response &res) {
  10265. res.body.clear();
  10266. clear_content_provider(res);
  10267. }
  10268. // The Content-Type of the old content goes with it.
  10269. inline void set_content_type(Response &res, const std::string &content_type) {
  10270. res.headers.erase("Content-Type");
  10271. res.set_header("Content-Type", content_type);
  10272. }
  10273. // `body` is public, so it can be assigned directly after a provider or a file
  10274. // was set. It came last, so it wins.
  10275. inline void prefer_assigned_body(Response &res) {
  10276. if (!res.body.empty() &&
  10277. (res.content_provider_ || !res.file_content_path_.empty())) {
  10278. clear_content_provider(res);
  10279. }
  10280. }
  10281. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10282. inline bool body_allowed_for_status(int status) {
  10283. return status >= 200 && status != StatusCode::NoContent_204 &&
  10284. status != StatusCode::NotModified_304;
  10285. }
  10286. // Only a 206 response is served as a partial representation. range_error()
  10287. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10288. // status would start from an unchecked offset.
  10289. inline bool is_partial_content(const Request &req, const Response &res) {
  10290. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10291. }
  10292. // Sets the Content-Length or Transfer-Encoding framing the body that
  10293. // Server::write_response_core() writes, or closes the connection after a body
  10294. // that has neither. Only the library sets them: one from a handler would go
  10295. // out next to it, or describe some other body.
  10296. inline void set_framing_headers(const Request &req, Response &res,
  10297. const std::string &boundary,
  10298. const std::string &content_type) {
  10299. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10300. auto head_length = req.method == "HEAD"
  10301. ? res.get_header_value("Content-Length")
  10302. : std::string();
  10303. res.headers.erase("Content-Length");
  10304. res.headers.erase("Transfer-Encoding");
  10305. if (!body_allowed_for_status(res.status)) { return; }
  10306. if (res.content_provider_) {
  10307. if (res.content_length_ == 0) {
  10308. if (res.is_chunked_content_provider_) {
  10309. res.set_header("Transfer-Encoding", "chunked");
  10310. } else if (req.method != "HEAD") {
  10311. // RFC 9112 6.3: a body with neither ends where the connection does.
  10312. res.headers.erase("Keep-Alive");
  10313. if (!has_header_token(res.headers, "Connection", "close")) {
  10314. res.set_header("Connection", "close");
  10315. }
  10316. }
  10317. return;
  10318. }
  10319. // The part Server::write_content_with_provider() writes.
  10320. auto length = res.content_length_;
  10321. if (is_partial_content(req, res)) {
  10322. length = req.ranges.size() == 1
  10323. ? get_range_offset_and_length(req.ranges[0], length).second
  10324. : get_multipart_ranges_data_length(req, boundary,
  10325. content_type, length);
  10326. }
  10327. res.set_header("Content-Length", std::to_string(length));
  10328. } else if (!res.body.empty()) {
  10329. res.set_header("Content-Length", std::to_string(res.body.size()));
  10330. } else {
  10331. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10332. }
  10333. }
  10334. } // namespace detail
  10335. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10336. size_t id) const {
  10337. return detail::get_header_value_u64(headers, key, def, id);
  10338. }
  10339. inline bool Response::has_header(const std::string &key) const {
  10340. return headers.find(key) != headers.end();
  10341. }
  10342. inline std::string Response::get_header_value(const std::string &key,
  10343. const char *def,
  10344. size_t id) const {
  10345. return detail::get_header_value(headers, key, def, id);
  10346. }
  10347. inline size_t Response::get_header_value_count(const std::string &key) const {
  10348. return detail::get_header_value_count(headers, key);
  10349. }
  10350. inline void Response::set_header(const std::string &key,
  10351. const std::string &val) {
  10352. detail::set_header(headers, key, val);
  10353. }
  10354. inline bool Response::has_trailer(const std::string &key) const {
  10355. return trailers.find(key) != trailers.end();
  10356. }
  10357. inline std::string Response::get_trailer_value(const std::string &key,
  10358. size_t id) const {
  10359. return detail::get_multimap_value(trailers, key, id);
  10360. }
  10361. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10362. return trailers.count(key);
  10363. }
  10364. inline void Response::set_redirect(const std::string &url, int stat) {
  10365. if (detail::fields::is_field_value(url)) {
  10366. set_header("Location", url);
  10367. if (300 <= stat && stat < 400) {
  10368. this->status = stat;
  10369. } else {
  10370. this->status = StatusCode::Found_302;
  10371. }
  10372. }
  10373. }
  10374. inline void Response::set_content(const char *s, size_t n,
  10375. const std::string &content_type) {
  10376. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10377. detail::clear_content_provider(*this);
  10378. detail::set_content_type(*this, content_type);
  10379. }
  10380. inline void Response::set_content(const std::string &s,
  10381. const std::string &content_type) {
  10382. set_content(s.data(), s.size(), content_type);
  10383. }
  10384. inline void Response::set_content(std::string &&s,
  10385. const std::string &content_type) {
  10386. body = std::move(s);
  10387. detail::clear_content_provider(*this);
  10388. detail::set_content_type(*this, content_type);
  10389. }
  10390. inline void Response::set_content_provider(
  10391. size_t in_length, const std::string &content_type, ContentProvider provider,
  10392. ContentProviderResourceReleaser resource_releaser) {
  10393. detail::clear_content(*this);
  10394. detail::set_content_type(*this, content_type);
  10395. content_length_ = in_length;
  10396. if (in_length > 0) { content_provider_ = std::move(provider); }
  10397. content_provider_resource_releaser_ = std::move(resource_releaser);
  10398. }
  10399. inline void Response::set_content_provider(
  10400. const std::string &content_type, ContentProviderWithoutLength provider,
  10401. ContentProviderResourceReleaser resource_releaser) {
  10402. detail::clear_content(*this);
  10403. detail::set_content_type(*this, content_type);
  10404. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10405. content_provider_resource_releaser_ = std::move(resource_releaser);
  10406. }
  10407. inline void Response::set_chunked_content_provider(
  10408. const std::string &content_type, ContentProviderWithoutLength provider,
  10409. ContentProviderResourceReleaser resource_releaser) {
  10410. set_content_provider(content_type, std::move(provider),
  10411. std::move(resource_releaser));
  10412. is_chunked_content_provider_ = true;
  10413. }
  10414. inline void Response::set_file_content(const std::string &path,
  10415. const std::string &content_type) {
  10416. detail::clear_content(*this);
  10417. headers.erase("Content-Type");
  10418. file_content_path_ = path;
  10419. file_content_content_type_ = content_type;
  10420. }
  10421. inline void Response::set_file_content(const std::string &path) {
  10422. set_file_content(path, std::string());
  10423. }
  10424. // Result implementation
  10425. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10426. size_t def,
  10427. size_t id) const {
  10428. return detail::get_header_value_u64(request_headers_, key, def, id);
  10429. }
  10430. inline bool Result::has_request_header(const std::string &key) const {
  10431. return request_headers_.find(key) != request_headers_.end();
  10432. }
  10433. inline std::string Result::get_request_header_value(const std::string &key,
  10434. const char *def,
  10435. size_t id) const {
  10436. return detail::get_header_value(request_headers_, key, def, id);
  10437. }
  10438. inline size_t
  10439. Result::get_request_header_value_count(const std::string &key) const {
  10440. return request_headers_.count(key);
  10441. }
  10442. // Stream implementation
  10443. inline ssize_t Stream::write(const char *ptr) {
  10444. return write(ptr, strlen(ptr));
  10445. }
  10446. inline ssize_t Stream::write(const std::string &s) {
  10447. return write(s.data(), s.size());
  10448. }
  10449. // BodyReader implementation
  10450. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10451. if (!stream) {
  10452. last_error = Error::Connection;
  10453. return -1;
  10454. }
  10455. if (eof) { return 0; }
  10456. if (!chunked) {
  10457. // Content-Length based reading
  10458. if (has_content_length && bytes_read >= content_length) {
  10459. eof = true;
  10460. return 0;
  10461. }
  10462. auto to_read = len;
  10463. if (has_content_length) {
  10464. auto remaining = content_length - bytes_read;
  10465. to_read = (std::min)(len, remaining);
  10466. }
  10467. auto n = stream->read(buf, to_read);
  10468. if (n < 0) {
  10469. last_error = stream->get_error();
  10470. if (last_error == Error::Success) { last_error = Error::Read; }
  10471. eof = true;
  10472. return n;
  10473. }
  10474. if (n == 0) {
  10475. // Unexpected EOF before content_length
  10476. last_error = stream->get_error();
  10477. if (last_error == Error::Success) { last_error = Error::Read; }
  10478. eof = true;
  10479. return 0;
  10480. }
  10481. bytes_read += static_cast<size_t>(n);
  10482. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10483. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10484. last_error = Error::ExceedMaxPayloadSize;
  10485. eof = true;
  10486. return -1;
  10487. }
  10488. return n;
  10489. }
  10490. // Chunked transfer encoding: delegate to shared decoder instance.
  10491. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10492. size_t chunk_offset = 0;
  10493. size_t chunk_total = 0;
  10494. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10495. if (n < 0) {
  10496. last_error = stream->get_error();
  10497. if (last_error == Error::Success) { last_error = Error::Read; }
  10498. eof = true;
  10499. return n;
  10500. }
  10501. if (n == 0) {
  10502. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10503. eof = true;
  10504. return 0;
  10505. }
  10506. bytes_read += static_cast<size_t>(n);
  10507. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10508. last_error = Error::ExceedMaxPayloadSize;
  10509. eof = true;
  10510. return -1;
  10511. }
  10512. return n;
  10513. }
  10514. // ThreadPool implementation
  10515. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10516. time_t idle_timeout_sec)
  10517. : base_thread_count_(n), max_queued_requests_(mqr),
  10518. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10519. shutdown_(false) {
  10520. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10521. if (max_n != 0 && max_n < n) {
  10522. std::string msg = "max_threads must be >= base_threads";
  10523. throw std::invalid_argument(msg);
  10524. }
  10525. #endif
  10526. max_thread_count_ = max_n == 0 ? n : max_n;
  10527. threads_.reserve(base_thread_count_);
  10528. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10529. try {
  10530. #endif
  10531. for (size_t i = 0; i < base_thread_count_; i++) {
  10532. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10533. }
  10534. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10535. } catch (...) {
  10536. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10537. // signal the workers we already spawned to exit and join them so the
  10538. // vector destructor does not see joinable threads (which would call
  10539. // std::terminate). Then rethrow so the caller learns of the failure.
  10540. {
  10541. std::unique_lock<std::mutex> lock(mutex_);
  10542. shutdown_ = true;
  10543. }
  10544. cond_.notify_all();
  10545. for (auto &t : threads_) {
  10546. if (t.joinable()) { t.join(); }
  10547. }
  10548. throw;
  10549. }
  10550. #endif
  10551. }
  10552. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10553. {
  10554. std::unique_lock<std::mutex> lock(mutex_);
  10555. if (shutdown_) { return false; }
  10556. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10557. return false;
  10558. }
  10559. jobs_.push_back(std::move(fn));
  10560. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10561. if (jobs_.size() > idle_thread_count_ &&
  10562. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10563. cleanup_finished_threads();
  10564. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10565. }
  10566. }
  10567. cond_.notify_one();
  10568. return true;
  10569. }
  10570. inline void ThreadPool::shutdown() {
  10571. {
  10572. std::unique_lock<std::mutex> lock(mutex_);
  10573. shutdown_ = true;
  10574. }
  10575. cond_.notify_all();
  10576. for (auto &t : threads_) {
  10577. if (t.joinable()) { t.join(); }
  10578. }
  10579. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10580. // with worker threads that call move_to_finished() concurrently.
  10581. std::list<std::thread> remaining_dynamic;
  10582. {
  10583. std::unique_lock<std::mutex> lock(mutex_);
  10584. remaining_dynamic = std::move(dynamic_threads_);
  10585. }
  10586. for (auto &t : remaining_dynamic) {
  10587. if (t.joinable()) { t.join(); }
  10588. }
  10589. std::unique_lock<std::mutex> lock(mutex_);
  10590. cleanup_finished_threads();
  10591. }
  10592. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10593. // Must be called with mutex_ held
  10594. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10595. if (it->get_id() == id) {
  10596. finished_threads_.push_back(std::move(*it));
  10597. dynamic_threads_.erase(it);
  10598. return;
  10599. }
  10600. }
  10601. }
  10602. inline void ThreadPool::cleanup_finished_threads() {
  10603. // Must be called with mutex_ held
  10604. for (auto &t : finished_threads_) {
  10605. if (t.joinable()) { t.join(); }
  10606. }
  10607. finished_threads_.clear();
  10608. }
  10609. inline void ThreadPool::worker(bool is_dynamic) {
  10610. for (;;) {
  10611. std::function<void()> fn;
  10612. {
  10613. std::unique_lock<std::mutex> lock(mutex_);
  10614. idle_thread_count_++;
  10615. if (is_dynamic) {
  10616. auto has_work =
  10617. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10618. [&] { return !jobs_.empty() || shutdown_; });
  10619. if (!has_work) {
  10620. // Timed out with no work - exit this dynamic thread
  10621. idle_thread_count_--;
  10622. move_to_finished(std::this_thread::get_id());
  10623. break;
  10624. }
  10625. } else {
  10626. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10627. }
  10628. idle_thread_count_--;
  10629. if (shutdown_ && jobs_.empty()) { break; }
  10630. fn = std::move(jobs_.front());
  10631. jobs_.pop_front();
  10632. }
  10633. assert(true == static_cast<bool>(fn));
  10634. fn();
  10635. }
  10636. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10637. !defined(LIBRESSL_VERSION_NUMBER)
  10638. OPENSSL_thread_stop();
  10639. #endif
  10640. }
  10641. /*
  10642. * Group 1 (continued): detail namespace - Stream implementations
  10643. */
  10644. namespace detail {
  10645. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10646. time_t timeout_sec, time_t timeout_usec,
  10647. time_t &actual_timeout_sec,
  10648. time_t &actual_timeout_usec) {
  10649. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10650. auto actual_timeout_msec =
  10651. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10652. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10653. actual_timeout_sec = actual_timeout_msec / 1000;
  10654. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10655. }
  10656. // Socket stream implementation
  10657. inline SocketStream::SocketStream(
  10658. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10659. time_t write_timeout_sec, time_t write_timeout_usec,
  10660. time_t max_timeout_msec,
  10661. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10662. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10663. read_timeout_usec_(read_timeout_usec),
  10664. write_timeout_sec_(write_timeout_sec),
  10665. write_timeout_usec_(write_timeout_usec),
  10666. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10667. read_buff_(read_buff_size_, 0) {}
  10668. inline SocketStream::~SocketStream() = default;
  10669. inline bool SocketStream::is_readable() const {
  10670. return read_buff_off_ < read_buff_content_size_;
  10671. }
  10672. inline bool SocketStream::wait_readable() const {
  10673. if (max_timeout_msec_ <= 0) {
  10674. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10675. }
  10676. time_t read_timeout_sec;
  10677. time_t read_timeout_usec;
  10678. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10679. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10680. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10681. }
  10682. inline bool SocketStream::wait_writable() const {
  10683. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10684. }
  10685. inline bool SocketStream::ensure_readable() {
  10686. if (readable_hint_) {
  10687. readable_hint_ = false;
  10688. return true;
  10689. }
  10690. return wait_readable();
  10691. }
  10692. inline const char *SocketStream::buffered_data(size_t &size) const {
  10693. size = read_buff_content_size_ - read_buff_off_;
  10694. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10695. }
  10696. inline void SocketStream::consume_buffered(size_t size) {
  10697. assert(size <= read_buff_content_size_ - read_buff_off_);
  10698. read_buff_off_ += size;
  10699. }
  10700. inline bool SocketStream::is_peer_alive() const {
  10701. return detail::is_socket_alive(sock_);
  10702. }
  10703. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10704. #ifdef _WIN32
  10705. size =
  10706. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10707. #else
  10708. size = (std::min)(size,
  10709. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10710. #endif
  10711. if (read_buff_off_ < read_buff_content_size_) {
  10712. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10713. if (size <= remaining_size) {
  10714. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10715. read_buff_off_ += size;
  10716. return static_cast<ssize_t>(size);
  10717. } else {
  10718. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10719. read_buff_off_ += remaining_size;
  10720. return static_cast<ssize_t>(remaining_size);
  10721. }
  10722. }
  10723. if (!ensure_readable()) {
  10724. error_ = Error::Timeout;
  10725. return -1;
  10726. }
  10727. read_buff_off_ = 0;
  10728. read_buff_content_size_ = 0;
  10729. if (size < read_buff_size_) {
  10730. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10731. CPPHTTPLIB_RECV_FLAGS);
  10732. if (n <= 0) {
  10733. if (n == 0) {
  10734. error_ = Error::ConnectionClosed;
  10735. } else {
  10736. error_ = Error::Read;
  10737. }
  10738. return n;
  10739. } else if (n <= static_cast<ssize_t>(size)) {
  10740. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10741. return n;
  10742. } else {
  10743. memcpy(ptr, read_buff_.data(), size);
  10744. read_buff_off_ = size;
  10745. read_buff_content_size_ = static_cast<size_t>(n);
  10746. return static_cast<ssize_t>(size);
  10747. }
  10748. } else {
  10749. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10750. if (n <= 0) {
  10751. if (n == 0) {
  10752. error_ = Error::ConnectionClosed;
  10753. } else {
  10754. error_ = Error::Read;
  10755. }
  10756. }
  10757. return n;
  10758. }
  10759. }
  10760. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10761. if (!wait_writable()) { return -1; }
  10762. #if defined(_WIN32) && !defined(_WIN64)
  10763. size =
  10764. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10765. #endif
  10766. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10767. }
  10768. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10769. int &port) const {
  10770. return detail::get_remote_ip_and_port(sock_, ip, port);
  10771. }
  10772. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10773. int &port) const {
  10774. return detail::get_local_ip_and_port(sock_, ip, port);
  10775. }
  10776. inline socket_t SocketStream::socket() const { return sock_; }
  10777. inline time_t SocketStream::duration() const {
  10778. return static_cast<time_t>(
  10779. std::chrono::duration_cast<std::chrono::milliseconds>(
  10780. std::chrono::steady_clock::now() - start_time_)
  10781. .count());
  10782. }
  10783. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10784. read_timeout_sec_ = sec;
  10785. read_timeout_usec_ = usec;
  10786. }
  10787. inline void SocketStream::set_max_timeout(time_t msec) {
  10788. max_timeout_msec_ = msec;
  10789. start_time_ = std::chrono::steady_clock::now();
  10790. }
  10791. // Buffer stream implementation
  10792. inline bool BufferStream::is_readable() const { return true; }
  10793. inline bool BufferStream::wait_readable() const { return true; }
  10794. inline bool BufferStream::wait_writable() const { return true; }
  10795. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10796. #if defined(_MSC_VER) && _MSC_VER < 1910
  10797. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10798. #else
  10799. auto len_read = buffer.copy(ptr, size, position);
  10800. #endif
  10801. position += static_cast<size_t>(len_read);
  10802. return static_cast<ssize_t>(len_read);
  10803. }
  10804. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10805. buffer.append(ptr, size);
  10806. return static_cast<ssize_t>(size);
  10807. }
  10808. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10809. int & /*port*/) const {}
  10810. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10811. int & /*port*/) const {}
  10812. inline socket_t BufferStream::socket() const { return 0; }
  10813. inline time_t BufferStream::duration() const { return 0; }
  10814. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10815. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10816. : MatcherBase(pattern) {
  10817. constexpr const char marker[] = "/:";
  10818. // One past the last ending position of a path param substring
  10819. std::size_t last_param_end = 0;
  10820. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10821. // Needed to ensure that parameter names are unique during matcher
  10822. // construction
  10823. // If exceptions are disabled, only last duplicate path
  10824. // parameter will be set
  10825. std::unordered_set<std::string> param_name_set;
  10826. #endif
  10827. while (true) {
  10828. const auto marker_pos = pattern.find(
  10829. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10830. if (marker_pos == std::string::npos) { break; }
  10831. static_fragments_.push_back(
  10832. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10833. const auto param_name_start = marker_pos + str_len(marker);
  10834. auto sep_pos = pattern.find(separator, param_name_start);
  10835. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10836. auto param_name =
  10837. pattern.substr(param_name_start, sep_pos - param_name_start);
  10838. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10839. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10840. std::string msg = "Encountered path parameter '" + param_name +
  10841. "' multiple times in route pattern '" + pattern + "'.";
  10842. throw std::invalid_argument(msg);
  10843. }
  10844. #endif
  10845. param_names_.push_back(std::move(param_name));
  10846. last_param_end = sep_pos + 1;
  10847. }
  10848. if (last_param_end < pattern.length()) {
  10849. static_fragments_.push_back(pattern.substr(last_param_end));
  10850. }
  10851. }
  10852. inline bool PathParamsMatcher::match(Request &request) const {
  10853. request.matches = std::smatch();
  10854. request.path_params.clear();
  10855. // A pattern without parameters is just a literal path to compare against
  10856. if (param_names_.empty()) { return request.path == pattern(); }
  10857. request.path_params.reserve(param_names_.size());
  10858. // One past the position at which the path matched the pattern last time
  10859. std::size_t starting_pos = 0;
  10860. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10861. const auto &fragment = static_fragments_[i];
  10862. if (starting_pos + fragment.length() > request.path.length()) {
  10863. return false;
  10864. }
  10865. // Avoid unnecessary allocation by using strncmp instead of substr +
  10866. // comparison
  10867. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10868. fragment.length()) != 0) {
  10869. return false;
  10870. }
  10871. starting_pos += fragment.length();
  10872. // Should only happen when we have a static fragment after a param
  10873. // Example: '/users/:id/subscriptions'
  10874. // The 'subscriptions' fragment here does not have a corresponding param
  10875. if (i >= param_names_.size()) { continue; }
  10876. auto sep_pos = request.path.find(separator, starting_pos);
  10877. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10878. const auto &param_name = param_names_[i];
  10879. request.path_params.emplace(
  10880. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10881. // Mark everything up to '/' as matched
  10882. starting_pos = sep_pos + 1;
  10883. }
  10884. // Returns false if the path is longer than the pattern
  10885. return starting_pos >= request.path.length();
  10886. }
  10887. inline bool RegexMatcher::match(Request &request) const {
  10888. request.path_params.clear();
  10889. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10890. // a non-match rather than risking a stack overflow in std::regex_match.
  10891. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10892. return false;
  10893. }
  10894. return std::regex_match(request.path, request.matches, regex_);
  10895. }
  10896. // Enclose IPv6 address in brackets if needed
  10897. inline std::string prepare_host_string(const std::string &host) {
  10898. // Enclose IPv6 address in brackets (but not if already enclosed)
  10899. if (host.find(':') == std::string::npos ||
  10900. (!host.empty() && host[0] == '[')) {
  10901. // IPv4, hostname, or already bracketed IPv6
  10902. return host;
  10903. } else {
  10904. // IPv6 address without brackets
  10905. return "[" + host + "]";
  10906. }
  10907. }
  10908. inline std::string make_host_and_port_string(const std::string &host, int port,
  10909. bool is_ssl) {
  10910. auto result = prepare_host_string(host);
  10911. // Append port if not default
  10912. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10913. ; // do nothing
  10914. } else {
  10915. result += ":" + std::to_string(port);
  10916. }
  10917. return result;
  10918. }
  10919. // Create "host:port" string always including port number (for CONNECT method)
  10920. inline std::string
  10921. make_host_and_port_string_always_port(const std::string &host, int port) {
  10922. return prepare_host_string(host) + ":" + std::to_string(port);
  10923. }
  10924. // Value for the Host header a client sends when the caller supplied none.
  10925. // Only the value: callers decide where in their header list it goes.
  10926. inline std::string make_default_host_header_value(const std::string &host,
  10927. int port, bool is_ssl,
  10928. int address_family) {
  10929. if (address_family == AF_UNIX) { return "localhost"; }
  10930. return make_host_and_port_string(host, port, is_ssl);
  10931. }
  10932. inline void add_default_user_agent_header(Request &req) {
  10933. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10934. if (!req.has_header("User-Agent")) {
  10935. req.set_header("User-Agent",
  10936. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10937. }
  10938. #else
  10939. (void)req;
  10940. #endif
  10941. }
  10942. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10943. NormalizedTarget normalize_target(const std::string &host);
  10944. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10945. bool host_matches_no_proxy(const NormalizedTarget &target,
  10946. const std::vector<NoProxyEntry> &entries);
  10947. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10948. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10949. if (prefix_bits == 0) { return true; }
  10950. int full_bytes = prefix_bits / 8;
  10951. int rem_bits = prefix_bits % 8;
  10952. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10953. static_cast<size_t>(full_bytes)) != 0) {
  10954. return false;
  10955. }
  10956. if (rem_bits == 0) { return true; }
  10957. auto i = static_cast<size_t>(full_bytes);
  10958. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10959. return (ip[i] & mask) == (net[i] & mask);
  10960. }
  10961. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10962. if (token.empty()) { return false; }
  10963. if (token == "*") {
  10964. out.kind = NoProxyKind::Wildcard;
  10965. return true;
  10966. }
  10967. auto slash = token.find('/');
  10968. std::string addr_part =
  10969. (slash == std::string::npos) ? token : token.substr(0, slash);
  10970. std::string prefix_part =
  10971. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10972. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10973. // don't silently treat it as a /32 (or /128).
  10974. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10975. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10976. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10977. // when brackets are present.
  10978. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10979. addr_part.back() == ']';
  10980. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10981. if (!bracketed) {
  10982. struct in_addr v4;
  10983. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10984. int prefix = 32;
  10985. if (!prefix_part.empty() &&
  10986. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  10987. prefix)) {
  10988. return false;
  10989. }
  10990. out.kind = NoProxyKind::IPv4Cidr;
  10991. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10992. out.prefix_bits = prefix;
  10993. return true;
  10994. }
  10995. }
  10996. struct in6_addr v6;
  10997. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10998. int prefix = 128;
  10999. if (!prefix_part.empty() &&
  11000. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11001. prefix)) {
  11002. return false;
  11003. }
  11004. out.kind = NoProxyKind::IPv6Cidr;
  11005. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11006. out.prefix_bits = prefix;
  11007. return true;
  11008. }
  11009. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11010. // the entry is malformed — don't fall through to the hostname branch.
  11011. if (bracketed) { return false; }
  11012. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11013. if (slash != std::string::npos) { return false; }
  11014. // Port-specific entries (host:port) are not supported.
  11015. if (token.find(':') != std::string::npos) { return false; }
  11016. std::string hostname = case_ignore::to_lower(token);
  11017. while (!hostname.empty() && hostname.front() == '.') {
  11018. hostname.erase(hostname.begin());
  11019. }
  11020. while (!hostname.empty() && hostname.back() == '.') {
  11021. hostname.pop_back();
  11022. }
  11023. if (hostname.empty()) { return false; }
  11024. out.kind = NoProxyKind::HostnameSuffix;
  11025. out.hostname_pattern = std::move(hostname);
  11026. return true;
  11027. }
  11028. inline std::vector<NoProxyEntry>
  11029. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11030. std::vector<NoProxyEntry> entries;
  11031. entries.reserve(patterns.size());
  11032. for (const auto &p : patterns) {
  11033. auto trimmed = trim_copy(p);
  11034. if (trimmed.empty()) { continue; }
  11035. NoProxyEntry entry;
  11036. if (parse_no_proxy_entry(trimmed, entry)) {
  11037. entries.push_back(std::move(entry));
  11038. }
  11039. }
  11040. return entries;
  11041. }
  11042. inline NormalizedTarget normalize_target(const std::string &host) {
  11043. NormalizedTarget t;
  11044. std::string h = host;
  11045. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11046. h = h.substr(1, h.size() - 2);
  11047. }
  11048. // Strip a single trailing dot so "example.com." canonicalizes to
  11049. // "example.com".
  11050. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11051. t.hostname = case_ignore::to_lower(h);
  11052. if (!t.hostname.empty()) {
  11053. struct in_addr v4;
  11054. struct in6_addr v6;
  11055. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11056. t.is_ipv4 = true;
  11057. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11058. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11059. t.is_ipv6 = true;
  11060. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11061. }
  11062. }
  11063. return t;
  11064. }
  11065. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11066. const std::vector<NoProxyEntry> &entries) {
  11067. if (target.hostname.empty()) { return false; }
  11068. for (const auto &e : entries) {
  11069. switch (e.kind) {
  11070. case NoProxyKind::Wildcard: return true;
  11071. case NoProxyKind::IPv4Cidr:
  11072. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11073. return true;
  11074. }
  11075. break;
  11076. case NoProxyKind::IPv6Cidr:
  11077. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11078. return true;
  11079. }
  11080. break;
  11081. case NoProxyKind::HostnameSuffix:
  11082. if (target.is_ipv4 || target.is_ipv6) { break; }
  11083. if (target.hostname == e.hostname_pattern) { return true; }
  11084. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11085. // an entry of "example.com".
  11086. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11087. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11088. if (target.hostname[offset - 1] == '.' &&
  11089. target.hostname.compare(offset, e.hostname_pattern.size(),
  11090. e.hostname_pattern) == 0) {
  11091. return true;
  11092. }
  11093. }
  11094. break;
  11095. }
  11096. }
  11097. return false;
  11098. }
  11099. template <typename T>
  11100. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11101. T header_writer, Error &error) {
  11102. for (const auto &h : headers) {
  11103. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11104. error = Error::InvalidHeaders;
  11105. return false;
  11106. }
  11107. }
  11108. if (header_writer(strm, headers) <= 0) {
  11109. error = Error::Write;
  11110. return false;
  11111. }
  11112. return true;
  11113. }
  11114. } // namespace detail
  11115. /*
  11116. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11117. */
  11118. #ifdef CPPHTTPLIB_SSL_ENABLED
  11119. namespace detail {
  11120. // SSL socket stream implementation
  11121. inline SSLSocketStream::SSLSocketStream(
  11122. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11123. time_t read_timeout_usec, time_t write_timeout_sec,
  11124. time_t write_timeout_usec, time_t max_timeout_msec,
  11125. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11126. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11127. read_timeout_usec_(read_timeout_usec),
  11128. write_timeout_sec_(write_timeout_sec),
  11129. write_timeout_usec_(write_timeout_usec),
  11130. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11131. tls_error_.code = tls::ErrorCode::Success;
  11132. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11133. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11134. // Note: create_session() also clears this, but SSLClient currently
  11135. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11136. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11137. // SSL session was created.
  11138. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11139. #endif
  11140. }
  11141. inline SSLSocketStream::~SSLSocketStream() = default;
  11142. inline bool SSLSocketStream::is_readable() const {
  11143. return tls::pending(session_) > 0;
  11144. }
  11145. inline bool SSLSocketStream::wait_readable() const {
  11146. if (max_timeout_msec_ <= 0) {
  11147. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11148. }
  11149. time_t read_timeout_sec;
  11150. time_t read_timeout_usec;
  11151. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11152. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11153. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  11154. }
  11155. inline bool SSLSocketStream::wait_writable() const {
  11156. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11157. !tls::is_peer_closed(session_, sock_);
  11158. }
  11159. inline bool SSLSocketStream::ensure_readable() {
  11160. if (readable_hint_) {
  11161. readable_hint_ = false;
  11162. return true;
  11163. }
  11164. return wait_readable();
  11165. }
  11166. inline bool SSLSocketStream::is_peer_alive() const {
  11167. return !tls::is_peer_closed(session_, sock_);
  11168. }
  11169. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11170. if (tls::pending(session_) > 0) {
  11171. tls::TlsError err;
  11172. auto ret = tls::read(session_, ptr, size, err);
  11173. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11174. error_ = Error::ConnectionClosed;
  11175. } else if (ret < 0) {
  11176. tls_error_ = err;
  11177. }
  11178. return ret;
  11179. } else if (ensure_readable()) {
  11180. tls::TlsError err;
  11181. auto ret = tls::read(session_, ptr, size, err);
  11182. if (ret < 0) {
  11183. auto n = 1000;
  11184. #ifdef _WIN32
  11185. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11186. (err.code == tls::ErrorCode::SyscallError &&
  11187. WSAGetLastError() == WSAETIMEDOUT))) {
  11188. #else
  11189. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11190. #endif
  11191. if (tls::pending(session_) > 0) {
  11192. ret = tls::read(session_, ptr, size, err);
  11193. if (ret >= 0) { return ret; }
  11194. break;
  11195. } else if (wait_readable()) {
  11196. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11197. ret = tls::read(session_, ptr, size, err);
  11198. if (ret >= 0) { return ret; }
  11199. } else {
  11200. break;
  11201. }
  11202. }
  11203. assert(ret < 0);
  11204. tls_error_ = err;
  11205. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11206. error_ = Error::ConnectionClosed;
  11207. }
  11208. return ret;
  11209. } else {
  11210. error_ = Error::Timeout;
  11211. return -1;
  11212. }
  11213. }
  11214. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11215. if (wait_writable()) {
  11216. auto handle_size =
  11217. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11218. tls::TlsError err;
  11219. auto ret = tls::write(session_, ptr, handle_size, err);
  11220. if (ret < 0) {
  11221. auto n = 1000;
  11222. #ifdef _WIN32
  11223. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11224. (err.code == tls::ErrorCode::SyscallError &&
  11225. WSAGetLastError() == WSAETIMEDOUT))) {
  11226. #else
  11227. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11228. #endif
  11229. if (wait_writable()) {
  11230. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11231. ret = tls::write(session_, ptr, handle_size, err);
  11232. if (ret >= 0) { return ret; }
  11233. } else {
  11234. break;
  11235. }
  11236. }
  11237. assert(ret < 0);
  11238. tls_error_ = err;
  11239. }
  11240. return ret;
  11241. }
  11242. return -1;
  11243. }
  11244. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11245. int &port) const {
  11246. detail::get_remote_ip_and_port(sock_, ip, port);
  11247. }
  11248. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11249. int &port) const {
  11250. detail::get_local_ip_and_port(sock_, ip, port);
  11251. }
  11252. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11253. inline time_t SSLSocketStream::duration() const {
  11254. return static_cast<time_t>(
  11255. std::chrono::duration_cast<std::chrono::milliseconds>(
  11256. std::chrono::steady_clock::now() - start_time_)
  11257. .count());
  11258. }
  11259. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11260. read_timeout_sec_ = sec;
  11261. read_timeout_usec_ = usec;
  11262. }
  11263. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11264. max_timeout_msec_ = msec;
  11265. start_time_ = std::chrono::steady_clock::now();
  11266. }
  11267. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11268. tls::session_t session,
  11269. time_t read_timeout_sec,
  11270. time_t read_timeout_usec,
  11271. time_t write_timeout_sec,
  11272. time_t write_timeout_usec)
  11273. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11274. read_timeout_usec_(read_timeout_usec),
  11275. write_timeout_sec_(write_timeout_sec),
  11276. write_timeout_usec_(write_timeout_usec),
  11277. start_time_(std::chrono::steady_clock::now()) {
  11278. // The receive and send paths run on different threads, so each TLS call is
  11279. // driven in non-blocking mode and readiness is awaited with select()
  11280. // outside the session lock. Set the socket non-blocking once here; it is
  11281. // never flipped back, so no thread races on the flag.
  11282. detail::set_nonblocking(sock_, true);
  11283. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11284. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11285. #endif
  11286. }
  11287. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11288. inline bool WebSocketSSLStream::is_readable() const {
  11289. std::lock_guard<std::mutex> guard(session_mutex_);
  11290. return tls::pending(session_) > 0;
  11291. }
  11292. inline bool WebSocketSSLStream::wait_readable() const {
  11293. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11294. }
  11295. inline bool WebSocketSSLStream::wait_writable() const {
  11296. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11297. // that probe toggles the socket's blocking flag, which would race with the
  11298. // concurrent reader on a permanently non-blocking socket.
  11299. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11300. }
  11301. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11302. tls::TlsError err;
  11303. auto n = 1000;
  11304. while (--n >= 0) {
  11305. {
  11306. std::lock_guard<std::mutex> guard(session_mutex_);
  11307. auto ret = tls::read(session_, ptr, size, err);
  11308. if (ret > 0) { return ret; }
  11309. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11310. error_ = Error::ConnectionClosed;
  11311. return ret;
  11312. }
  11313. }
  11314. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11315. // direction: the send path shares this session, so output it left pending
  11316. // has to be flushed before more input can be decrypted. Anything else is
  11317. // a hard error.
  11318. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11319. #ifdef _WIN32
  11320. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11321. needs_readable =
  11322. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11323. WSAGetLastError() == WSAETIMEDOUT);
  11324. #endif
  11325. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11326. error_ = Error::Read;
  11327. return -1;
  11328. }
  11329. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11330. error_ = Error::Timeout;
  11331. return -1;
  11332. }
  11333. }
  11334. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11335. // to tell a timeout from a close would otherwise see whatever the previous
  11336. // failure left behind (error_ is never cleared on success).
  11337. error_ = Error::Read;
  11338. return -1;
  11339. }
  11340. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11341. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11342. tls::TlsError err;
  11343. auto n = 1000;
  11344. while (--n >= 0) {
  11345. {
  11346. std::lock_guard<std::mutex> guard(session_mutex_);
  11347. auto ret = tls::write(session_, ptr, handle_size, err);
  11348. if (ret >= 0) { return ret; }
  11349. }
  11350. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11351. // or a post-handshake message must be consumed before the record goes
  11352. // out. Anything else is a hard error.
  11353. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11354. #ifdef _WIN32
  11355. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11356. needs_writable =
  11357. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11358. WSAGetLastError() == WSAETIMEDOUT);
  11359. #endif
  11360. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11361. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11362. }
  11363. return -1;
  11364. }
  11365. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11366. int &port) const {
  11367. detail::get_remote_ip_and_port(sock_, ip, port);
  11368. }
  11369. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11370. int &port) const {
  11371. detail::get_local_ip_and_port(sock_, ip, port);
  11372. }
  11373. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11374. inline time_t WebSocketSSLStream::duration() const {
  11375. return static_cast<time_t>(
  11376. std::chrono::duration_cast<std::chrono::milliseconds>(
  11377. std::chrono::steady_clock::now() - start_time_)
  11378. .count());
  11379. }
  11380. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11381. read_timeout_sec_ = sec;
  11382. read_timeout_usec_ = usec;
  11383. }
  11384. } // namespace detail
  11385. #endif // CPPHTTPLIB_SSL_ENABLED
  11386. /*
  11387. * Group 4: Server implementation
  11388. */
  11389. // HTTP server implementation
  11390. inline Server::Server()
  11391. : new_task_queue([] {
  11392. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11393. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11394. }) {
  11395. #ifndef _WIN32
  11396. signal(SIGPIPE, SIG_IGN);
  11397. #endif
  11398. }
  11399. inline Server::~Server() = default;
  11400. inline std::unique_ptr<detail::MatcherBase>
  11401. Server::make_matcher(const std::string &pattern) {
  11402. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11403. // a path params pattern
  11404. if (pattern.find("/:") != std::string::npos) {
  11405. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11406. }
  11407. // A pattern with no regex metacharacter only has to be compared literally,
  11408. // which is what PathParamsMatcher already does when it captures no
  11409. // parameter, so std::regex is only worth building for the patterns that
  11410. // actually need it
  11411. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11412. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11413. }
  11414. return detail::make_unique<detail::RegexMatcher>(pattern);
  11415. }
  11416. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11417. return add_handler(get_handlers_, pattern, std::move(handler));
  11418. }
  11419. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11420. return add_handler(post_handlers_, pattern, std::move(handler));
  11421. }
  11422. inline Server &Server::Post(const std::string &pattern,
  11423. HandlerWithContentReader handler) {
  11424. return add_handler(post_handlers_for_content_reader_, pattern,
  11425. std::move(handler));
  11426. }
  11427. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11428. return add_handler(put_handlers_, pattern, std::move(handler));
  11429. }
  11430. inline Server &Server::Put(const std::string &pattern,
  11431. HandlerWithContentReader handler) {
  11432. return add_handler(put_handlers_for_content_reader_, pattern,
  11433. std::move(handler));
  11434. }
  11435. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11436. return add_handler(patch_handlers_, pattern, std::move(handler));
  11437. }
  11438. inline Server &Server::Patch(const std::string &pattern,
  11439. HandlerWithContentReader handler) {
  11440. return add_handler(patch_handlers_for_content_reader_, pattern,
  11441. std::move(handler));
  11442. }
  11443. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11444. return add_handler(delete_handlers_, pattern, std::move(handler));
  11445. }
  11446. inline Server &Server::Delete(const std::string &pattern,
  11447. HandlerWithContentReader handler) {
  11448. return add_handler(delete_handlers_for_content_reader_, pattern,
  11449. std::move(handler));
  11450. }
  11451. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11452. return add_handler(options_handlers_, pattern, std::move(handler));
  11453. }
  11454. inline const std::set<std::string> &Server::builtin_methods() {
  11455. thread_local const std::set<std::string> methods{
  11456. "GET", "HEAD", "POST", "PUT", "DELETE",
  11457. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11458. return methods;
  11459. }
  11460. inline Server::CustomHandlerEntry *
  11461. Server::custom_entry_for_registration(const std::string &method) {
  11462. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11463. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11464. // routing() before the custom tables are consulted, so a route registered
  11465. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11466. // there and would be reachable, but they carry protocol-level meaning
  11467. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11468. // library does not route.
  11469. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11470. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11471. has_invalid_registration_ = true;
  11472. return nullptr;
  11473. }
  11474. return &custom_handlers_[method];
  11475. }
  11476. inline Server &Server::CustomRoute(const std::string &method,
  11477. const std::string &pattern,
  11478. Handler handler) {
  11479. auto *entry = custom_entry_for_registration(method);
  11480. if (!entry) { return *this; }
  11481. return add_handler(entry->handlers, pattern, std::move(handler));
  11482. }
  11483. inline Server &Server::CustomRoute(const std::string &method,
  11484. const std::string &pattern,
  11485. HandlerWithContentReader handler) {
  11486. auto *entry = custom_entry_for_registration(method);
  11487. if (!entry) { return *this; }
  11488. return add_handler(entry->handlers_for_content_reader, pattern,
  11489. std::move(handler));
  11490. }
  11491. inline const Server::CustomHandlerEntry *
  11492. Server::find_custom_entry(const std::string &method) const {
  11493. // find() alone would be correct here. The empty() check is what keeps the
  11494. // per-request cost off servers that never call CustomRoute(), which is the
  11495. // overwhelmingly common case; keep it rather than walking into the tree.
  11496. if (custom_handlers_.empty()) { return nullptr; }
  11497. auto it = custom_handlers_.find(method);
  11498. return it == custom_handlers_.end() ? nullptr : &it->second;
  11499. }
  11500. inline Server &Server::WebSocket(const std::string &pattern,
  11501. WebSocketHandler handler) {
  11502. websocket_handlers_.push_back(
  11503. {make_matcher(pattern), std::move(handler), nullptr});
  11504. return *this;
  11505. }
  11506. inline Server &Server::WebSocket(const std::string &pattern,
  11507. WebSocketHandler handler,
  11508. SubProtocolSelector sub_protocol_selector) {
  11509. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11510. std::move(sub_protocol_selector)});
  11511. return *this;
  11512. }
  11513. inline bool Server::set_base_dir(const std::string &dir,
  11514. const std::string &mount_point) {
  11515. return set_mount_point(mount_point, dir);
  11516. }
  11517. inline bool Server::set_mount_point(const std::string &mount_point,
  11518. const std::string &dir, Headers headers) {
  11519. detail::FileStat stat(dir);
  11520. if (stat.is_dir()) {
  11521. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11522. if (!mnt.empty() && mnt[0] == '/') {
  11523. // Without the resolved directory, a file could not be checked to be
  11524. // inside it.
  11525. std::string resolved_base;
  11526. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11527. return false;
  11528. }
  11529. #if defined(_WIN32)
  11530. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11531. resolved_base += '\\';
  11532. }
  11533. #else
  11534. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11535. #endif
  11536. base_dirs_.push_back(
  11537. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11538. return true;
  11539. }
  11540. }
  11541. return false;
  11542. }
  11543. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11544. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11545. if (it->mount_point == mount_point) {
  11546. base_dirs_.erase(it);
  11547. return true;
  11548. }
  11549. }
  11550. return false;
  11551. }
  11552. inline Server &
  11553. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11554. const std::string &mime) {
  11555. file_extension_and_mimetype_map_[ext] = mime;
  11556. return *this;
  11557. }
  11558. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11559. default_file_mimetype_ = mime;
  11560. return *this;
  11561. }
  11562. inline Server &Server::set_file_request_handler(Handler handler) {
  11563. file_request_handler_ = std::move(handler);
  11564. return *this;
  11565. }
  11566. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11567. std::true_type) {
  11568. error_handler_ = std::move(handler);
  11569. return *this;
  11570. }
  11571. inline Server &Server::set_error_handler_core(Handler handler,
  11572. std::false_type) {
  11573. error_handler_ = [handler](const Request &req, Response &res) {
  11574. handler(req, res);
  11575. return HandlerResponse::Handled;
  11576. };
  11577. return *this;
  11578. }
  11579. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11580. exception_handler_ = std::move(handler);
  11581. return *this;
  11582. }
  11583. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11584. pre_routing_handler_ = std::move(handler);
  11585. return *this;
  11586. }
  11587. inline Server &Server::set_post_routing_handler(Handler handler) {
  11588. post_routing_handler_ = std::move(handler);
  11589. return *this;
  11590. }
  11591. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11592. pre_request_handler_ = std::move(handler);
  11593. return *this;
  11594. }
  11595. inline Server &Server::set_logger(Logger logger) {
  11596. logger_ = std::move(logger);
  11597. return *this;
  11598. }
  11599. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11600. error_logger_ = std::move(error_logger);
  11601. return *this;
  11602. }
  11603. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11604. pre_compression_logger_ = std::move(logger);
  11605. return *this;
  11606. }
  11607. inline Server &
  11608. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11609. expect_100_continue_handler_ = std::move(handler);
  11610. return *this;
  11611. }
  11612. inline Server &Server::set_start_handler(StartHandler handler) {
  11613. start_handler_ = std::move(handler);
  11614. return *this;
  11615. }
  11616. inline Server &Server::set_address_family(int family) {
  11617. address_family_ = family;
  11618. return *this;
  11619. }
  11620. inline Server &Server::set_tcp_nodelay(bool on) {
  11621. tcp_nodelay_ = on;
  11622. return *this;
  11623. }
  11624. inline Server &Server::set_ipv6_v6only(bool on) {
  11625. ipv6_v6only_ = on;
  11626. return *this;
  11627. }
  11628. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11629. socket_options_ = std::move(socket_options);
  11630. return *this;
  11631. }
  11632. inline Server &Server::set_default_headers(Headers headers) {
  11633. default_headers_ = std::move(headers);
  11634. return *this;
  11635. }
  11636. inline Server &Server::set_header_writer(
  11637. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11638. header_writer_ = writer;
  11639. return *this;
  11640. }
  11641. inline Server &
  11642. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11643. trusted_proxies_ = proxies;
  11644. return *this;
  11645. }
  11646. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11647. keep_alive_max_count_ = count;
  11648. return *this;
  11649. }
  11650. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11651. keep_alive_timeout_sec_ = sec;
  11652. return *this;
  11653. }
  11654. template <class Rep, class Period>
  11655. inline Server &Server::set_keep_alive_timeout(
  11656. const std::chrono::duration<Rep, Period> &duration) {
  11657. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11658. set_keep_alive_timeout(sec);
  11659. });
  11660. return *this;
  11661. }
  11662. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11663. read_timeout_sec_ = sec;
  11664. read_timeout_usec_ = usec;
  11665. return *this;
  11666. }
  11667. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11668. write_timeout_sec_ = sec;
  11669. write_timeout_usec_ = usec;
  11670. return *this;
  11671. }
  11672. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11673. idle_interval_sec_ = sec;
  11674. idle_interval_usec_ = usec;
  11675. return *this;
  11676. }
  11677. inline Server &Server::set_payload_max_length(size_t length) {
  11678. payload_max_length_ = length;
  11679. return *this;
  11680. }
  11681. inline Server &Server::set_static_file_compression(bool on) {
  11682. static_file_compression_ = on;
  11683. return *this;
  11684. }
  11685. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11686. static_file_compression_min_length_ = length;
  11687. return *this;
  11688. }
  11689. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11690. static_file_compression_max_length_ = length;
  11691. return *this;
  11692. }
  11693. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11694. websocket_max_missed_pongs_ = count;
  11695. return *this;
  11696. }
  11697. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11698. websocket_ping_interval_sec_ = sec;
  11699. return *this;
  11700. }
  11701. template <class Rep, class Period>
  11702. inline Server &Server::set_websocket_ping_interval(
  11703. const std::chrono::duration<Rep, Period> &duration) {
  11704. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11705. set_websocket_ping_interval(sec);
  11706. });
  11707. return *this;
  11708. }
  11709. inline bool Server::bind_to_port(const std::string &host, int port,
  11710. int socket_flags) {
  11711. auto ret = bind_internal(host, port, socket_flags);
  11712. if (ret == -1) { is_decommissioned = true; }
  11713. return ret >= 0;
  11714. }
  11715. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11716. auto ret = bind_internal(host, 0, socket_flags);
  11717. if (ret == -1) { is_decommissioned = true; }
  11718. return ret;
  11719. }
  11720. inline bool Server::listen_after_bind() { return listen_internal(); }
  11721. inline bool Server::listen(const std::string &host, int port,
  11722. int socket_flags) {
  11723. return bind_to_port(host, port, socket_flags) && listen_internal();
  11724. }
  11725. inline bool Server::is_running() const { return is_running_; }
  11726. inline void Server::wait_until_ready() const {
  11727. while (!is_running_ && !is_decommissioned) {
  11728. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11729. }
  11730. }
  11731. inline void Server::stop() noexcept {
  11732. // Release the listening socket whether or not the accept loop is running:
  11733. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11734. // exchange is what makes this safe to call concurrently with the accept loop.
  11735. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11736. if (sock != INVALID_SOCKET) {
  11737. detail::shutdown_socket(sock);
  11738. detail::close_socket(sock);
  11739. }
  11740. is_decommissioned = false;
  11741. }
  11742. inline void Server::decommission() { is_decommissioned = true; }
  11743. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11744. auto len = strlen(s);
  11745. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11746. len -= 2;
  11747. {
  11748. // RFC 9112 §3: exactly one SP between the method, the target and the
  11749. // version. Taking other whitespace as a separator too lets recipients
  11750. // that parse more strictly see a different request.
  11751. auto end = s + len;
  11752. if (std::count(s, end, ' ') != 2) { return false; }
  11753. auto sp1 = std::find(s, end, ' ');
  11754. auto sp2 = std::find(sp1 + 1, end, ' ');
  11755. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11756. req.method.assign(s, sp1);
  11757. req.target.assign(sp1 + 1, sp2);
  11758. req.version.assign(sp2 + 1, end);
  11759. }
  11760. // A method outside the built-in set is accepted only when a handler has been
  11761. // registered for it with CustomRoute().
  11762. const auto &methods = builtin_methods();
  11763. if (methods.find(req.method) == methods.end() &&
  11764. !find_custom_entry(req.method)) {
  11765. output_error_log(Error::InvalidHTTPMethod, &req);
  11766. return false;
  11767. }
  11768. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11769. output_error_log(Error::InvalidHTTPVersion, &req);
  11770. return false;
  11771. }
  11772. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11773. // would leave this server routing a different path than a cache or a
  11774. // filter in front of it sees.
  11775. if (!detail::fields::is_request_target(req.target) ||
  11776. req.target.find('#') != std::string::npos) {
  11777. return false;
  11778. }
  11779. {
  11780. detail::divide(req.target, '?',
  11781. [&](const char *lhs_data, std::size_t lhs_size,
  11782. const char *rhs_data, std::size_t rhs_size) {
  11783. req.path =
  11784. decode_path_component(std::string(lhs_data, lhs_size));
  11785. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11786. });
  11787. }
  11788. return true;
  11789. }
  11790. inline bool Server::write_response(Stream &strm, bool close_connection,
  11791. Request &req, Response &res) {
  11792. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11793. // incorrectly to the error content.
  11794. req.ranges.clear();
  11795. return write_response_core(strm, close_connection, req, res, false);
  11796. }
  11797. inline bool Server::write_response_with_content(Stream &strm,
  11798. bool close_connection,
  11799. const Request &req,
  11800. Response &res) {
  11801. return write_response_core(strm, close_connection, req, res, true);
  11802. }
  11803. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11804. const Request &req, Response &res,
  11805. bool need_apply_ranges) {
  11806. assert(res.status != -1);
  11807. if (400 <= res.status && error_handler_ &&
  11808. error_handler_(req, res) == HandlerResponse::Handled) {
  11809. need_apply_ranges = true;
  11810. }
  11811. if (!detail::body_allowed_for_status(res.status)) {
  11812. detail::clear_content(res);
  11813. }
  11814. detail::prefer_assigned_body(res);
  11815. std::string content_type;
  11816. std::string boundary;
  11817. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11818. // Prepare additional headers
  11819. if (close_connection ||
  11820. detail::has_header_token(req.headers, "Connection", "close") ||
  11821. 400 <= res.status || // Don't leave connections open after errors
  11822. // The client withholds the body until `100 Continue`, which was never
  11823. // sent, so whether and when the body follows is unknown.
  11824. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11825. // The body was left partway, e.g. by a content receiver that returned
  11826. // false, so the rest of it cannot be told from the next request.
  11827. (req.body_read_started_ && !req.body_consumed_)) {
  11828. res.set_header("Connection", "close");
  11829. } else {
  11830. std::string s = "timeout=";
  11831. s += std::to_string(keep_alive_timeout_sec_);
  11832. if (keep_alive_max_count_ > 0) {
  11833. s += ", max=";
  11834. s += std::to_string(keep_alive_max_count_);
  11835. }
  11836. res.set_header("Keep-Alive", s);
  11837. }
  11838. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11839. !res.has_header("Content-Type")) {
  11840. res.set_header("Content-Type", "text/plain");
  11841. }
  11842. detail::set_framing_headers(req, res, boundary, content_type);
  11843. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11844. res.set_header("Accept-Ranges", "bytes");
  11845. }
  11846. if (post_routing_handler_) {
  11847. post_routing_handler_(req, res);
  11848. // Again, for a body or framing headers the handler changed.
  11849. detail::set_framing_headers(req, res, boundary, content_type);
  11850. }
  11851. // Response line and headers
  11852. detail::BufferStream bstrm;
  11853. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11854. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11855. // Combine a small body with the headers so the whole response leaves in a
  11856. // single write. A large body is written on its own instead: a copy of it
  11857. // costs more than the extra write saves.
  11858. auto send_body =
  11859. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  11860. auto body_is_separate = false;
  11861. auto provider_done = false;
  11862. if (send_body && !res.body.empty() && !res.content_provider_) {
  11863. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11864. bstrm.write(res.body.data(), res.body.size());
  11865. } else {
  11866. body_is_separate = true;
  11867. }
  11868. } else if (send_body && res.content_provider_ &&
  11869. res.is_file_content_provider_ &&
  11870. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11871. // A small file is read into the same buffer. Other providers may produce
  11872. // their data over time, so they are never held back.
  11873. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11874. return false;
  11875. }
  11876. provider_done = true;
  11877. }
  11878. // Log before writing to avoid race condition with client-side code that
  11879. // accesses logger-captured data immediately after receiving the response.
  11880. output_log(req, res);
  11881. // Flush buffer
  11882. auto &data = bstrm.get_buffer();
  11883. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11884. if (body_is_separate) {
  11885. return detail::write_data(strm, res.body.data(), res.body.size());
  11886. }
  11887. // Streaming body
  11888. if (send_body && res.content_provider_) {
  11889. if (!provider_done &&
  11890. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11891. return false;
  11892. }
  11893. res.content_provider_success_ = true;
  11894. }
  11895. return true;
  11896. }
  11897. inline bool
  11898. Server::write_content_with_provider(Stream &strm, const Request &req,
  11899. Response &res, const std::string &boundary,
  11900. const std::string &content_type) {
  11901. auto is_shutting_down = [this]() {
  11902. return this->svr_sock_ == INVALID_SOCKET;
  11903. };
  11904. if (res.content_length_ > 0) {
  11905. if (!detail::is_partial_content(req, res)) {
  11906. return detail::write_content(strm, res.content_provider_, 0,
  11907. res.content_length_, is_shutting_down);
  11908. } else if (req.ranges.size() == 1) {
  11909. auto offset_and_length = detail::get_range_offset_and_length(
  11910. req.ranges[0], res.content_length_);
  11911. return detail::write_content(strm, res.content_provider_,
  11912. offset_and_length.first,
  11913. offset_and_length.second, is_shutting_down);
  11914. } else {
  11915. return detail::write_multipart_ranges_data(
  11916. strm, req, res, boundary, content_type, res.content_length_,
  11917. is_shutting_down);
  11918. }
  11919. } else {
  11920. if (res.is_chunked_content_provider_) {
  11921. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11922. // re-negotiating here would disagree with them, e.g. once a handler's
  11923. // own Content-Encoding header suppresses the negotiation.
  11924. auto compressor = detail::make_compressor(res.content_coding_);
  11925. if (!compressor) {
  11926. compressor = detail::make_unique<detail::nocompressor>();
  11927. }
  11928. return detail::write_content_chunked(strm, res.content_provider_,
  11929. is_shutting_down, *compressor);
  11930. } else {
  11931. return detail::write_content_without_length(strm, res.content_provider_,
  11932. is_shutting_down);
  11933. }
  11934. }
  11935. }
  11936. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11937. FormFields::iterator cur_field;
  11938. FormFiles::iterator cur_file;
  11939. auto is_text_field = false;
  11940. size_t count = 0;
  11941. if (read_content_core(
  11942. strm, req, res,
  11943. // Regular
  11944. [&](const char *buf, size_t n) {
  11945. // Prevent arithmetic overflow when checking sizes.
  11946. // Avoid computing (req.body.size() + n) directly because
  11947. // adding two unsigned `size_t` values can wrap around and
  11948. // produce a small result instead of indicating overflow.
  11949. // Instead, check using subtraction: ensure `n` does not
  11950. // exceed the remaining capacity `max_size() - size()`.
  11951. if (req.body.size() >= req.body.max_size() ||
  11952. n > req.body.max_size() - req.body.size()) {
  11953. return false;
  11954. }
  11955. // Limit decompressed body size to payload_max_length_ to protect
  11956. // against "zip bomb" attacks where a small compressed payload
  11957. // decompresses to a massive size.
  11958. if (payload_max_length_ > 0 &&
  11959. (req.body.size() >= payload_max_length_ ||
  11960. n > payload_max_length_ - req.body.size())) {
  11961. return false;
  11962. }
  11963. req.body.append(buf, n);
  11964. return true;
  11965. },
  11966. // Multipart FormData
  11967. [&](const FormData &file) {
  11968. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  11969. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11970. output_error_log(Error::TooManyFormDataFiles, &req);
  11971. return false;
  11972. }
  11973. if (file.filename.empty()) {
  11974. cur_field = req.form.fields.emplace(
  11975. file.name, FormField{file.name, file.content, file.headers});
  11976. is_text_field = true;
  11977. } else {
  11978. cur_file = req.form.files.emplace(file.name, file);
  11979. is_text_field = false;
  11980. }
  11981. return true;
  11982. },
  11983. [&](const char *buf, size_t n) {
  11984. if (is_text_field) {
  11985. auto &content = cur_field->second.content;
  11986. if (content.size() + n > content.max_size()) { return false; }
  11987. content.append(buf, n);
  11988. } else {
  11989. auto &content = cur_file->second.content;
  11990. if (content.size() + n > content.max_size()) { return false; }
  11991. content.append(buf, n);
  11992. }
  11993. return true;
  11994. })) {
  11995. const auto &content_type = req.get_header_value("Content-Type");
  11996. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  11997. "application/x-www-form-urlencoded")) {
  11998. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  11999. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12000. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12001. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12002. return false;
  12003. }
  12004. detail::parse_query_text(req.body, req.params);
  12005. }
  12006. return true;
  12007. }
  12008. return false;
  12009. }
  12010. inline bool Server::read_content_with_content_receiver(
  12011. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12012. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12013. return read_content_core(strm, req, res, std::move(receiver),
  12014. std::move(multipart_header),
  12015. std::move(multipart_receiver));
  12016. }
  12017. inline bool Server::read_content_core(
  12018. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12019. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12020. detail::FormDataParser multipart_form_data_parser;
  12021. ContentReceiverWithProgress out;
  12022. if (req.is_multipart_form_data()) {
  12023. const auto &content_type = req.get_header_value("Content-Type");
  12024. std::string boundary;
  12025. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12026. res.status = StatusCode::BadRequest_400;
  12027. output_error_log(Error::MultipartParsing, &req);
  12028. return false;
  12029. }
  12030. multipart_form_data_parser.set_boundary(std::move(boundary));
  12031. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12032. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12033. multipart_receiver);
  12034. };
  12035. } else {
  12036. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12037. size_t /*len*/) { return receiver(buf, n); };
  12038. }
  12039. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12040. // For non-SSL builds we still scan non-persistent connections for stray
  12041. // body bytes so the payload limit is enforced (413). On keep-alive,
  12042. // pending bytes may be the next request (issue #2450), so skip.
  12043. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  12044. if (!req.has_header("Content-Length") &&
  12045. !detail::is_chunked_transfer_encoding(req.headers)) {
  12046. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  12047. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  12048. auto has_data = strm.is_readable();
  12049. if (!has_data) {
  12050. auto s = strm.socket();
  12051. if (s != INVALID_SOCKET) {
  12052. has_data = detail::select_read(s, 0, 0) > 0;
  12053. }
  12054. }
  12055. if (has_data) {
  12056. // Route through the same decompressing reader used by the
  12057. // length-framed and chunked paths below, so payload_max_length_ is
  12058. // enforced on the decompressed size here too instead of only on the
  12059. // compressed wire bytes.
  12060. return detail::read_content(strm, req, payload_max_length_, res.status,
  12061. nullptr, out, true);
  12062. }
  12063. }
  12064. return true;
  12065. }
  12066. #else
  12067. if (!req.has_header("Content-Length") &&
  12068. !detail::is_chunked_transfer_encoding(req.headers)) {
  12069. return true;
  12070. }
  12071. #endif
  12072. // A second read would start where the first one stopped, or in the next
  12073. // request.
  12074. if (req.body_read_started_) { return false; }
  12075. // The client is waiting for this before it sends the body.
  12076. if (req.expect_100_continue_pending_) {
  12077. req.expect_100_continue_pending_ = false;
  12078. detail::write_response_line(strm, StatusCode::Continue_100);
  12079. strm.write("\r\n");
  12080. }
  12081. // Set before reading, since a receiver may also stop by throwing.
  12082. req.body_read_started_ = true;
  12083. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12084. out, true)) {
  12085. return false;
  12086. }
  12087. req.body_consumed_ = true;
  12088. if (req.is_multipart_form_data()) {
  12089. if (!multipart_form_data_parser.is_valid()) {
  12090. res.status = StatusCode::BadRequest_400;
  12091. output_error_log(Error::MultipartParsing, &req);
  12092. return false;
  12093. }
  12094. }
  12095. return true;
  12096. }
  12097. inline bool Server::handle_file_request(Request &req, Response &res) {
  12098. for (const auto &entry : base_dirs_) {
  12099. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12100. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12101. // One that already ends in '/' (the root mount among them) carries its own
  12102. // boundary; set_mount_point() guarantees the mount point is not empty.
  12103. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12104. (entry.mount_point.back() == '/' ||
  12105. req.path.size() == entry.mount_point.size() ||
  12106. req.path[entry.mount_point.size()] == '/')) {
  12107. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12108. if (detail::is_valid_path(sub_path)) {
  12109. auto path = entry.base_dir + sub_path;
  12110. if (path.back() == '/') { path += "index.html"; }
  12111. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12112. // but symlinks/junctions can still escape the base directory. A path
  12113. // that cannot be resolved, which includes one that does not exist, is
  12114. // not served from here.
  12115. std::string resolved_path;
  12116. if (!detail::canonicalize_path(path.c_str(), resolved_path)) {
  12117. continue;
  12118. }
  12119. if (!detail::is_path_within_base(resolved_path,
  12120. entry.resolved_base_dir)) {
  12121. res.status = StatusCode::Forbidden_403;
  12122. return true;
  12123. }
  12124. detail::FileStat stat(path);
  12125. if (stat.is_dir()) {
  12126. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12127. // in the name from reading as a scheme.
  12128. auto name = req.path.substr(req.path.rfind('/') + 1);
  12129. res.set_redirect("./" + encode_path_component(name) + "/",
  12130. StatusCode::MovedPermanently_301);
  12131. return true;
  12132. }
  12133. if (stat.is_file()) {
  12134. for (const auto &kv : entry.headers) {
  12135. res.set_header(kv.first, kv.second);
  12136. }
  12137. auto content_type = detail::find_content_type(
  12138. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12139. auto encoding = detail::EncodingType::None;
  12140. if (static_file_compression_) {
  12141. encoding =
  12142. static_file_encoding(req, res, content_type, stat.size());
  12143. }
  12144. // The ETag names the representation actually sent, so a client that
  12145. // cached the compressed form revalidates against the compressed ETag
  12146. // and still gets a 304, while one that took identity keeps the plain
  12147. // ETag.
  12148. auto etag = detail::compute_etag(
  12149. stat, encoding == detail::EncodingType::None
  12150. ? std::string()
  12151. : std::string("-") + detail::encoding_name(encoding));
  12152. if (!etag.empty()) { res.set_header("ETag", etag); }
  12153. auto mtime = stat.mtime();
  12154. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12155. if (!last_modified.empty()) {
  12156. res.set_header("Last-Modified", last_modified);
  12157. }
  12158. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12159. check_if_range(req, etag, mtime);
  12160. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12161. if (!mm->is_open()) {
  12162. output_error_log(Error::OpenFile, &req);
  12163. return false;
  12164. }
  12165. detail::set_file_content_provider(res, mm, content_type, encoding);
  12166. if (req.method != "HEAD" && file_request_handler_) {
  12167. file_request_handler_(req, res);
  12168. }
  12169. return true;
  12170. } else {
  12171. output_error_log(Error::OpenFile, &req);
  12172. }
  12173. }
  12174. }
  12175. }
  12176. return false;
  12177. }
  12178. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12179. const std::string &etag,
  12180. time_t mtime) const {
  12181. // Handle conditional GET:
  12182. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12183. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12184. if (req.has_header("If-None-Match")) {
  12185. if (!etag.empty()) {
  12186. auto val =
  12187. detail::get_combined_header_value(req.headers, "If-None-Match");
  12188. // NOTE: We use exact string matching here. This works correctly
  12189. // because our server always generates weak ETags (W/"..."), and
  12190. // clients typically send back the same ETag they received.
  12191. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12192. // If-None-Match, where W/"x" and "x" would match, but this
  12193. // simplified implementation requires exact matches.
  12194. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12195. [&](const char *b, const char *e) {
  12196. auto seg_len = static_cast<size_t>(e - b);
  12197. return (seg_len == 1 && *b == '*') ||
  12198. (seg_len == etag.size() &&
  12199. std::equal(b, e, etag.begin()));
  12200. });
  12201. if (ret) {
  12202. res.status = StatusCode::NotModified_304;
  12203. return true;
  12204. }
  12205. }
  12206. } else if (req.has_header("If-Modified-Since")) {
  12207. auto val = req.get_header_value("If-Modified-Since");
  12208. auto t = detail::parse_http_date(val);
  12209. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12210. res.status = StatusCode::NotModified_304;
  12211. return true;
  12212. }
  12213. }
  12214. return false;
  12215. }
  12216. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12217. time_t mtime) const {
  12218. // Handle If-Range for partial content requests (RFC 9110
  12219. // Section 13.1.5). If-Range is only evaluated when Range header is
  12220. // present. If the validator matches, serve partial content; otherwise
  12221. // serve full content.
  12222. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12223. auto val = req.get_header_value("If-Range");
  12224. auto is_valid_range = [&]() {
  12225. if (detail::is_strong_etag(val)) {
  12226. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12227. // comparison.
  12228. return (!etag.empty() && val == etag);
  12229. } else if (detail::is_weak_etag(val)) {
  12230. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12231. return false;
  12232. } else {
  12233. // HTTP-date comparison
  12234. auto t = detail::parse_http_date(val);
  12235. return (t != static_cast<time_t>(-1) && mtime <= t);
  12236. }
  12237. };
  12238. if (!is_valid_range()) {
  12239. // Validator doesn't match: ignore Range and serve full content
  12240. req.ranges.clear();
  12241. return false;
  12242. }
  12243. }
  12244. return true;
  12245. }
  12246. inline socket_t
  12247. Server::create_server_socket(const std::string &host, int port,
  12248. int socket_flags,
  12249. SocketOptions socket_options) const {
  12250. return detail::create_socket(
  12251. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12252. ipv6_v6only_, std::move(socket_options),
  12253. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12254. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12255. output_error_log(Error::BindIPAddress, nullptr);
  12256. return false;
  12257. }
  12258. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12259. output_error_log(Error::Listen, nullptr);
  12260. return false;
  12261. }
  12262. return true;
  12263. });
  12264. }
  12265. inline int Server::bind_internal(const std::string &host, int port,
  12266. int socket_flags) {
  12267. if (is_decommissioned) { return -1; }
  12268. if (!is_valid()) { return -1; }
  12269. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12270. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12271. if (port == 0) {
  12272. struct sockaddr_storage addr;
  12273. socklen_t addr_len = sizeof(addr);
  12274. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12275. &addr_len) == -1) {
  12276. output_error_log(Error::GetSockName, nullptr);
  12277. return -1;
  12278. }
  12279. if (addr.ss_family == AF_INET) {
  12280. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12281. } else if (addr.ss_family == AF_INET6) {
  12282. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12283. } else {
  12284. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12285. return -1;
  12286. }
  12287. } else {
  12288. return port;
  12289. }
  12290. }
  12291. inline bool Server::listen_internal() {
  12292. // A stop() between bind and listen leaves nothing to accept on. Report
  12293. // failure instead of returning success without ever serving, and mark the
  12294. // server decommissioned the way any failed listen does so that a concurrent
  12295. // wait_until_ready() wakes up instead of spinning forever.
  12296. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12297. is_decommissioned = true;
  12298. return false;
  12299. }
  12300. auto ret = true;
  12301. is_running_ = true;
  12302. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12303. if (start_handler_) { start_handler_(); }
  12304. {
  12305. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12306. while (svr_sock_ != INVALID_SOCKET) {
  12307. #ifndef _WIN32
  12308. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12309. #endif
  12310. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12311. idle_interval_usec_);
  12312. if (val == 0) { // Timeout
  12313. task_queue->on_idle();
  12314. continue;
  12315. }
  12316. #ifndef _WIN32
  12317. }
  12318. #endif
  12319. #if defined _WIN32
  12320. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12321. // OVERLAPPED
  12322. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12323. #elif defined SOCK_CLOEXEC
  12324. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12325. #else
  12326. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12327. #endif
  12328. if (sock == INVALID_SOCKET) {
  12329. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12330. // touches the CRT errno, so the two have to be asked platform by
  12331. // platform rather than by testing errno here.
  12332. if (detail::is_accept_resource_error()) {
  12333. // The per-process descriptor limit or the network stack's buffer
  12334. // space has been reached. Try to accept new connections after a
  12335. // short sleep.
  12336. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12337. continue;
  12338. } else if (detail::is_accept_transient_error()) {
  12339. continue;
  12340. }
  12341. // Take the descriptor out of svr_sock_ before closing it: a later
  12342. // stop() would otherwise shutdown()/close() a value the OS may have
  12343. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12344. // gone. The exchange also settles the race with a concurrent stop(),
  12345. // since whichever side takes the descriptor closes it exactly once.
  12346. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12347. if (listen_sock != INVALID_SOCKET) {
  12348. detail::close_socket(listen_sock);
  12349. ret = false;
  12350. output_error_log(Error::Connection, nullptr);
  12351. } else {
  12352. ; // The server socket was closed by user.
  12353. }
  12354. break;
  12355. }
  12356. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12357. read_timeout_sec_, read_timeout_usec_);
  12358. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12359. write_timeout_sec_, write_timeout_usec_);
  12360. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12361. if (!task_queue->enqueue(
  12362. [this, sock]() { process_and_close_socket(sock); })) {
  12363. output_error_log(Error::ResourceExhaustion, nullptr);
  12364. detail::shutdown_socket(sock);
  12365. detail::close_socket(sock);
  12366. }
  12367. }
  12368. task_queue->shutdown();
  12369. }
  12370. is_decommissioned = !ret;
  12371. return ret;
  12372. }
  12373. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  12374. if (pre_routing_handler_ &&
  12375. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12376. return true;
  12377. }
  12378. // File handler
  12379. if ((req.method == "GET" || req.method == "HEAD") &&
  12380. handle_file_request(req, res)) {
  12381. return true;
  12382. }
  12383. const auto *custom = find_custom_entry(req.method);
  12384. // The second clause mirrors what expect_content() does unconditionally for
  12385. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12386. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12387. // `allprop`) would skip its handler and fall through to 404.
  12388. if (detail::expect_content(req) ||
  12389. (custom && !custom->handlers_for_content_reader.empty())) {
  12390. // Content reader handler
  12391. {
  12392. // Track whether the ContentReader was aborted due to the decompressed
  12393. // payload exceeding `payload_max_length_`.
  12394. // The user handler runs after the lambda returns, so we must restore the
  12395. // 413 status if the handler overwrites it.
  12396. bool content_reader_payload_too_large = false;
  12397. ContentReader reader(
  12398. [&](ContentReceiver receiver) {
  12399. auto result = read_content_with_content_receiver(
  12400. strm, req, res, std::move(receiver), nullptr, nullptr);
  12401. if (!result) {
  12402. output_error_log(Error::Read, &req);
  12403. if (res.status == StatusCode::PayloadTooLarge_413) {
  12404. content_reader_payload_too_large = true;
  12405. }
  12406. }
  12407. return result;
  12408. },
  12409. [&](FormDataHeader header, ContentReceiver receiver) {
  12410. auto result = read_content_with_content_receiver(
  12411. strm, req, res, nullptr, std::move(header),
  12412. std::move(receiver));
  12413. if (!result) {
  12414. output_error_log(Error::Read, &req);
  12415. if (res.status == StatusCode::PayloadTooLarge_413) {
  12416. content_reader_payload_too_large = true;
  12417. }
  12418. }
  12419. return result;
  12420. });
  12421. bool dispatched = false;
  12422. if (req.method == "POST") {
  12423. dispatched = dispatch_request_for_content_reader(
  12424. req, res, std::move(reader), post_handlers_for_content_reader_);
  12425. } else if (req.method == "PUT") {
  12426. dispatched = dispatch_request_for_content_reader(
  12427. req, res, std::move(reader), put_handlers_for_content_reader_);
  12428. } else if (req.method == "PATCH") {
  12429. dispatched = dispatch_request_for_content_reader(
  12430. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12431. } else if (req.method == "DELETE") {
  12432. dispatched = dispatch_request_for_content_reader(
  12433. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12434. } else if (custom) {
  12435. dispatched = dispatch_request_for_content_reader(
  12436. req, res, std::move(reader), custom->handlers_for_content_reader);
  12437. }
  12438. if (dispatched) {
  12439. if (content_reader_payload_too_large) {
  12440. // Enforce the limit: override any status the handler may have set
  12441. // and return false so the error path sends a plain 413 response.
  12442. res.status = StatusCode::PayloadTooLarge_413;
  12443. detail::clear_content(res);
  12444. return false;
  12445. }
  12446. return true;
  12447. }
  12448. }
  12449. // NOTE: `req.body` is not read here. For a regular handler the body is
  12450. // read inside dispatch_request(), after the route has matched and the
  12451. // pre-request handler has approved the request, so that a rejected
  12452. // request (e.g. failed authentication) never forces us to buffer a
  12453. // potentially large body.
  12454. }
  12455. // Regular handler
  12456. if (req.method == "GET" || req.method == "HEAD") {
  12457. return dispatch_request(req, res, get_handlers_, strm);
  12458. } else if (req.method == "POST") {
  12459. return dispatch_request(req, res, post_handlers_, strm);
  12460. } else if (req.method == "PUT") {
  12461. return dispatch_request(req, res, put_handlers_, strm);
  12462. } else if (req.method == "DELETE") {
  12463. return dispatch_request(req, res, delete_handlers_, strm);
  12464. } else if (req.method == "OPTIONS") {
  12465. return dispatch_request(req, res, options_handlers_, strm);
  12466. } else if (req.method == "PATCH") {
  12467. return dispatch_request(req, res, patch_handlers_, strm);
  12468. } else if (custom) {
  12469. return dispatch_request(req, res, custom->handlers, strm);
  12470. }
  12471. res.status = StatusCode::BadRequest_400;
  12472. return false;
  12473. }
  12474. inline bool Server::dispatch_request(Request &req, Response &res,
  12475. const Handlers &handlers, Stream &strm) {
  12476. for (const auto &x : handlers) {
  12477. const auto &matcher = x.first;
  12478. const auto &handler = x.second;
  12479. if (matcher->match(req)) {
  12480. req.matched_route = matcher->pattern();
  12481. // Run the pre-request handler before reading the body so a rejected
  12482. // request (e.g. failed authentication) never forces us to buffer a
  12483. // potentially large body. `req.matched_route` is available here.
  12484. if (pre_request_handler_ &&
  12485. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12486. return true;
  12487. }
  12488. // The route matched and the request was approved; read the body now.
  12489. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12490. output_error_log(Error::Read, &req);
  12491. return false;
  12492. }
  12493. handler(req, res);
  12494. return true;
  12495. }
  12496. }
  12497. return false;
  12498. }
  12499. // Decides the content coding for a response served straight from a file. Both
  12500. // the ETag, which has to name the representation actually sent, and
  12501. // `apply_static_file_compression()` go through this, so the two cannot drift
  12502. // apart.
  12503. inline detail::EncodingType
  12504. Server::static_file_encoding(const Request &req, const Response &res,
  12505. const std::string &content_type,
  12506. size_t length) const {
  12507. if (!static_file_compression_) { return detail::EncodingType::None; }
  12508. // Nothing to compress, and an empty file already answers with
  12509. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12510. // turn an empty body into a 20-byte gzip stream.
  12511. if (length == 0) { return detail::EncodingType::None; }
  12512. // A file that already fits in a single packet gains nothing from being made
  12513. // smaller, since it still travels in that one segment, and a file of a few
  12514. // bytes comes out larger than it went in.
  12515. if (length < static_file_compression_min_length_) {
  12516. return detail::EncodingType::None;
  12517. }
  12518. // RFC 9110 applies Range to the representation after content coding, so a
  12519. // compressed 206 would mean compressing the whole file and then slicing it.
  12520. // Serve ranges from the identity representation instead.
  12521. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12522. if (static_file_compression_max_length_ > 0 &&
  12523. length > static_file_compression_max_length_) {
  12524. return detail::EncodingType::None;
  12525. }
  12526. return detail::encoding_type(req, res, content_type);
  12527. }
  12528. // Compresses a file-backed content provider into `res.body`. Returns false when
  12529. // the response is left untouched.
  12530. inline bool Server::apply_static_file_compression(const Request &req,
  12531. Response &res) const {
  12532. auto type = res.content_coding_;
  12533. if (type == detail::EncodingType::None || !res.content_provider_) {
  12534. return false;
  12535. }
  12536. auto compressor = detail::make_compressor(type);
  12537. if (!compressor) { return false; }
  12538. output_pre_compression_log(req, res);
  12539. std::string compressed;
  12540. if (!detail::compress_content_provider(res.content_provider_,
  12541. res.content_length_, *compressor,
  12542. compressed)) {
  12543. return false;
  12544. }
  12545. res.body.swap(compressed);
  12546. // The provider was consumed in full, so its releaser hears about a success.
  12547. res.content_provider_success_ = true;
  12548. detail::clear_content_provider(res);
  12549. res.set_header("Content-Encoding", detail::encoding_name(type));
  12550. res.set_header("Vary", "Accept-Encoding");
  12551. return true;
  12552. }
  12553. inline void Server::apply_ranges(const Request &req, Response &res,
  12554. std::string &content_type,
  12555. std::string &boundary) const {
  12556. // A known-length content provider leaves `res.body` empty, so the compressor
  12557. // at the end of this function never runs for one (issue #2545). A file-backed
  12558. // provider is fully readable right here, so compress it and answer with an
  12559. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12560. // takes the same path as `set_content()` from here on. Range requests never
  12561. // get a content coding, so `Content-Range` still names identity bytes and
  12562. // none of the range handling below applies.
  12563. if (apply_static_file_compression(req, res)) { return; }
  12564. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12565. auto it = res.headers.find("Content-Type");
  12566. if (it != res.headers.end()) {
  12567. content_type = it->second;
  12568. res.headers.erase(it);
  12569. }
  12570. boundary = detail::make_multipart_data_boundary();
  12571. res.set_header("Content-Type",
  12572. "multipart/byteranges; boundary=" + boundary);
  12573. }
  12574. auto type = detail::encoding_type(req, res);
  12575. if (res.body.empty()) {
  12576. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12577. res.status == StatusCode::PartialContent_206) {
  12578. auto offset_and_length = detail::get_range_offset_and_length(
  12579. req.ranges[0], res.content_length_);
  12580. auto content_range = detail::make_content_range_header_field(
  12581. offset_and_length, res.content_length_);
  12582. res.set_header("Content-Range", content_range);
  12583. } else if (res.is_chunked_content_provider_) {
  12584. res.content_coding_ = type;
  12585. if (type != detail::EncodingType::None) {
  12586. res.set_header("Content-Encoding", detail::encoding_name(type));
  12587. res.set_header("Vary", "Accept-Encoding");
  12588. }
  12589. }
  12590. } else {
  12591. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12592. ;
  12593. } else if (req.ranges.size() == 1) {
  12594. auto offset_and_length =
  12595. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12596. auto offset = offset_and_length.first;
  12597. auto length = offset_and_length.second;
  12598. auto content_range = detail::make_content_range_header_field(
  12599. offset_and_length, res.body.size());
  12600. res.set_header("Content-Range", content_range);
  12601. assert(offset + length <= res.body.size());
  12602. res.body = res.body.substr(offset, length);
  12603. } else {
  12604. std::string data;
  12605. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12606. res.body.size(), data);
  12607. res.body.swap(data);
  12608. }
  12609. if (type != detail::EncodingType::None) {
  12610. output_pre_compression_log(req, res);
  12611. if (auto compressor = detail::make_compressor(type)) {
  12612. std::string compressed;
  12613. if (compressor->compress(res.body.data(), res.body.size(), true,
  12614. [&](const char *data, size_t data_len) {
  12615. compressed.append(data, data_len);
  12616. return true;
  12617. })) {
  12618. res.body.swap(compressed);
  12619. res.set_header("Content-Encoding", detail::encoding_name(type));
  12620. res.set_header("Vary", "Accept-Encoding");
  12621. }
  12622. }
  12623. }
  12624. res.content_length_ = res.body.size();
  12625. }
  12626. }
  12627. inline bool Server::dispatch_request_for_content_reader(
  12628. Request &req, Response &res, ContentReader content_reader,
  12629. const HandlersForContentReader &handlers) const {
  12630. for (const auto &x : handlers) {
  12631. const auto &matcher = x.first;
  12632. const auto &handler = x.second;
  12633. if (matcher->match(req)) {
  12634. req.matched_route = matcher->pattern();
  12635. if (!pre_request_handler_ ||
  12636. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12637. handler(req, res, content_reader);
  12638. }
  12639. return true;
  12640. }
  12641. }
  12642. return false;
  12643. }
  12644. inline std::string
  12645. get_client_ip(const std::string &x_forwarded_for,
  12646. const std::vector<std::string> &trusted_proxies) {
  12647. // X-Forwarded-For is a comma-separated list per RFC 7239
  12648. std::vector<std::string> ip_list;
  12649. detail::split(x_forwarded_for.data(),
  12650. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12651. [&](const char *b, const char *e) {
  12652. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12653. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12654. });
  12655. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12656. // no segments. Signal "no client IP derived" with an empty string so the
  12657. // caller can fall back to the connection-level remote address.
  12658. if (ip_list.empty()) { return std::string(); }
  12659. // Each hop appends the address it received the request from, so the rightmost
  12660. // entries are the ones written by our own infrastructure while the leftmost
  12661. // are whatever the original client chose to send. Walk from the right and
  12662. // skip trusted proxies; the first address that is not a trusted proxy is the
  12663. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12664. // from the left instead lets a client forge an arbitrary address by following
  12665. // it with a trusted proxy's address, which the left-to-right scan then
  12666. // returned as the client.
  12667. for (size_t i = ip_list.size(); i-- > 0;) {
  12668. const auto &ip = ip_list[i];
  12669. auto is_trusted_proxy =
  12670. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12671. [&](const std::string &proxy) { return ip == proxy; });
  12672. if (!is_trusted_proxy) { return ip; }
  12673. }
  12674. // Every hop was a trusted proxy; fall back to the first entry.
  12675. return ip_list.front();
  12676. }
  12677. inline bool
  12678. Server::process_request(Stream &strm, const std::string &remote_addr,
  12679. int remote_port, const std::string &local_addr,
  12680. int local_port, bool close_connection,
  12681. bool &connection_closed,
  12682. const std::function<void(Request &)> &setup_request,
  12683. bool *websocket_upgraded) {
  12684. std::array<char, 2048> buf{};
  12685. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12686. // The read timeout bounds the request line and headers as a whole, so a
  12687. // client sending them a byte at a time cannot hold the worker any longer.
  12688. strm.set_max_timeout(read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000);
  12689. // Connection has been closed on client
  12690. if (!line_reader.getline()) { return false; }
  12691. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12692. // clients send an extra CRLF after a request body, which would otherwise be
  12693. // parsed as the next request on a persistent connection.
  12694. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12695. return false;
  12696. }
  12697. Request req;
  12698. req.start_time_ = std::chrono::steady_clock::now();
  12699. req.remote_addr = remote_addr;
  12700. req.remote_port = remote_port;
  12701. req.local_addr = local_addr;
  12702. req.local_port = local_port;
  12703. Response res;
  12704. res.version = "HTTP/1.1";
  12705. res.headers = default_headers_;
  12706. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12707. // close the connection after that response, whichever path wrote it (an
  12708. // error status, a handler, or a rejected request). Reading on would also
  12709. // parse whatever the client sent next on a connection it considers done.
  12710. auto honor_connection_close = detail::scope_exit([&] {
  12711. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12712. connection_closed = true;
  12713. }
  12714. });
  12715. // Request line and headers. A rejected message leaves the rest of it (and
  12716. // any body) unread, so the connection cannot be reused: the leftover bytes
  12717. // would be parsed as the next request.
  12718. if (!parse_request_line(line_reader.ptr(), req)) {
  12719. connection_closed = true;
  12720. res.status = StatusCode::BadRequest_400;
  12721. output_error_log(Error::InvalidRequestLine, &req);
  12722. return write_response(strm, close_connection, req, res);
  12723. }
  12724. // Request headers
  12725. if (!detail::read_headers(strm, req.headers)) {
  12726. connection_closed = true;
  12727. res.status = StatusCode::BadRequest_400;
  12728. output_error_log(Error::InvalidHeaders, &req);
  12729. return write_response(strm, close_connection, req, res);
  12730. }
  12731. strm.set_max_timeout(0);
  12732. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12733. // which would otherwise let an intermediary and this parser disagree on
  12734. // where the body ends and enable request smuggling. Three cases: a
  12735. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12736. // or empty), which would otherwise be read as "no body"; a non-zero
  12737. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12738. // tolerated for compatibility with existing clients); and a
  12739. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12740. // length undeterminable. None of them may fall through to the "no body"
  12741. // path, or the body bytes are parsed as the next request on a persistent
  12742. // connection.
  12743. auto is_invalid_content_length = false;
  12744. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12745. is_invalid_content_length);
  12746. if (is_invalid_content_length ||
  12747. detail::has_conflicting_content_length(req.headers) ||
  12748. (req.has_header("Transfer-Encoding") &&
  12749. !detail::is_chunked_transfer_encoding(req.headers))) {
  12750. connection_closed = true;
  12751. res.status = StatusCode::BadRequest_400;
  12752. return write_response(strm, close_connection, req, res);
  12753. }
  12754. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12755. // HTTP/1.0 request, is honoured, but the connection closes after the
  12756. // response.
  12757. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  12758. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12759. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12760. // the same authority.
  12761. auto host_count = req.get_header_value_count("Host");
  12762. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12763. !detail::fields::is_host(req.get_header_value("Host"))) {
  12764. connection_closed = true;
  12765. res.status = StatusCode::BadRequest_400;
  12766. output_error_log(Error::InvalidHeaders, &req);
  12767. return write_response(strm, close_connection, req, res);
  12768. }
  12769. // Check if the request URI doesn't exceed the limit
  12770. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12771. connection_closed = true;
  12772. res.status = StatusCode::UriTooLong_414;
  12773. output_error_log(Error::ExceedUriMaxLength, &req);
  12774. return write_response(strm, close_connection, req, res);
  12775. }
  12776. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12777. connection_closed = true;
  12778. }
  12779. if (req.version == "HTTP/1.0" &&
  12780. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12781. connection_closed = true;
  12782. }
  12783. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12784. // itself a trusted proxy. Otherwise any direct client could spoof
  12785. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12786. auto is_trusted_peer = std::any_of(
  12787. trusted_proxies_.begin(), trusted_proxies_.end(),
  12788. [&](const std::string &proxy) { return proxy == remote_addr; });
  12789. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12790. // Some proxies append the address they observed as a separate
  12791. // X-Forwarded-For field line instead of extending the one the client sent
  12792. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12793. // be scanned. Reading only the first occurrence would hand back the
  12794. // client-supplied, and therefore forgeable, value.
  12795. auto x_forwarded_for =
  12796. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12797. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12798. req.remote_addr = derived.empty() ? remote_addr : derived;
  12799. } else {
  12800. req.remote_addr = remote_addr;
  12801. }
  12802. req.remote_port = remote_port;
  12803. req.local_addr = local_addr;
  12804. req.local_port = local_port;
  12805. if (req.has_header("Accept")) {
  12806. auto accept_header =
  12807. detail::get_combined_header_value(req.headers, "Accept");
  12808. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12809. connection_closed = true;
  12810. res.status = StatusCode::BadRequest_400;
  12811. output_error_log(Error::HTTPParsing, &req);
  12812. return write_response(strm, close_connection, req, res);
  12813. }
  12814. }
  12815. if (req.has_header("Range")) {
  12816. const auto &range_header_value = req.get_header_value("Range");
  12817. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12818. connection_closed = true;
  12819. res.status = StatusCode::RangeNotSatisfiable_416;
  12820. output_error_log(Error::InvalidRangeHeader, &req);
  12821. return write_response(strm, close_connection, req, res);
  12822. }
  12823. }
  12824. if (setup_request) { setup_request(req); }
  12825. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12826. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12827. // must be ignored. An expectation we do not recognize is left alone; the
  12828. // 417 the section allows for one is a MAY, not a requirement.
  12829. //
  12830. // `100 Continue` itself is deferred until the body is actually read (see
  12831. // read_content_core), so a request rejected by a later handler never
  12832. // invites the client to send a body nobody will read.
  12833. if (req.version != "HTTP/1.0" &&
  12834. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12835. int status = StatusCode::Continue_100;
  12836. if (expect_100_continue_handler_) {
  12837. status = expect_100_continue_handler_(req, res);
  12838. }
  12839. if (status == StatusCode::Continue_100) {
  12840. req.expect_100_continue_pending_ = true;
  12841. } else {
  12842. if (res.status == -1) { res.status = status; }
  12843. connection_closed = true;
  12844. return write_response(strm, true, req, res);
  12845. }
  12846. }
  12847. // Setup `is_connection_closed` method
  12848. auto sock = strm.socket();
  12849. req.is_connection_closed = [sock]() {
  12850. return !detail::is_socket_alive(sock);
  12851. };
  12852. // WebSocket upgrade
  12853. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12854. // that authentication and other middleware can reject the request with an
  12855. // HTTP response (e.g., 401) before the protocol switches.
  12856. // The response says so when this connection closes after it.
  12857. auto close_after_response = close_connection || connection_closed;
  12858. if (detail::is_websocket_upgrade(req)) {
  12859. if (pre_routing_handler_ &&
  12860. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12861. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12862. return write_response_with_content(strm, close_after_response, req, res);
  12863. }
  12864. // Find matching WebSocket handler
  12865. for (const auto &entry : websocket_handlers_) {
  12866. if (entry.matcher->match(req)) {
  12867. req.matched_route = entry.matcher->pattern();
  12868. if (pre_request_handler_ &&
  12869. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12870. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12871. return write_response_with_content(strm, close_after_response, req,
  12872. res);
  12873. }
  12874. // Compute accept key
  12875. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12876. auto accept_key = detail::websocket_accept_key(client_key);
  12877. // Negotiate subprotocol
  12878. std::string selected_subprotocol;
  12879. if (entry.sub_protocol_selector) {
  12880. auto protocol_header = detail::get_combined_header_value(
  12881. req.headers, "Sec-WebSocket-Protocol");
  12882. if (!protocol_header.empty()) {
  12883. std::vector<std::string> protocols;
  12884. detail::split(protocol_header.data(),
  12885. protocol_header.data() + protocol_header.size(), ',',
  12886. [&](const char *b, const char *e) {
  12887. protocols.emplace_back(b, e);
  12888. });
  12889. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12890. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12891. if (std::find(protocols.begin(), protocols.end(),
  12892. selected_subprotocol) == protocols.end()) {
  12893. selected_subprotocol.clear();
  12894. }
  12895. }
  12896. }
  12897. // Send 101 Switching Protocols
  12898. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12899. "Upgrade: websocket\r\n"
  12900. "Connection: Upgrade\r\n"
  12901. "Sec-WebSocket-Accept: " +
  12902. accept_key + "\r\n";
  12903. if (!selected_subprotocol.empty()) {
  12904. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12905. return false;
  12906. }
  12907. handshake_response +=
  12908. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12909. }
  12910. handshake_response += "\r\n";
  12911. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12912. 0) {
  12913. return false;
  12914. }
  12915. connection_closed = true;
  12916. if (websocket_upgraded) { *websocket_upgraded = true; }
  12917. {
  12918. #ifdef CPPHTTPLIB_SSL_ENABLED
  12919. if (req.ssl) {
  12920. // wss: the heartbeat ping thread and the read path enter the same
  12921. // TLS session from different threads. Hand the WebSocket a stream
  12922. // that serializes every TLS call, so the shared SSLSocketStream on
  12923. // the plain HTTP/HTTPS paths stays untouched.
  12924. auto ws_strm =
  12925. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12926. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12927. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12928. write_timeout_sec_, write_timeout_usec_));
  12929. ws::WebSocket ws(std::move(ws_strm), req, true,
  12930. websocket_ping_interval_sec_,
  12931. websocket_max_missed_pongs_);
  12932. entry.handler(req, ws);
  12933. return true;
  12934. }
  12935. #endif
  12936. // Use WebSocket-specific read timeout instead of HTTP timeout
  12937. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12938. 0);
  12939. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12940. websocket_max_missed_pongs_);
  12941. entry.handler(req, ws);
  12942. }
  12943. return true;
  12944. }
  12945. }
  12946. // No matching handler - fall through to 404
  12947. }
  12948. // Routing
  12949. auto routed = false;
  12950. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12951. routed = routing(req, res, strm);
  12952. #else
  12953. try {
  12954. routed = routing(req, res, strm);
  12955. } catch (std::exception &) {
  12956. if (exception_handler_) {
  12957. auto ep = std::current_exception();
  12958. exception_handler_(req, res, ep);
  12959. routed = true;
  12960. } else {
  12961. res.status = StatusCode::InternalServerError_500;
  12962. }
  12963. } catch (...) {
  12964. if (exception_handler_) {
  12965. auto ep = std::current_exception();
  12966. exception_handler_(req, res, ep);
  12967. routed = true;
  12968. } else {
  12969. res.status = StatusCode::InternalServerError_500;
  12970. }
  12971. }
  12972. #endif
  12973. auto ret = false;
  12974. if (routed) {
  12975. if (res.status == -1) {
  12976. res.status = req.ranges.empty() ? StatusCode::OK_200
  12977. : StatusCode::PartialContent_206;
  12978. }
  12979. // Before the Range checks below, so they see the body's own length.
  12980. detail::prefer_assigned_body(res);
  12981. // Serve file content by using a content provider
  12982. auto file_open_error = false;
  12983. if (!res.file_content_path_.empty()) {
  12984. const auto &path = res.file_content_path_;
  12985. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12986. if (!mm->is_open()) {
  12987. res.status = StatusCode::NotFound_404;
  12988. output_error_log(Error::OpenFile, &req);
  12989. file_open_error = true;
  12990. } else {
  12991. auto content_type = res.file_content_content_type_;
  12992. if (content_type.empty()) {
  12993. // One the handler set after set_file_content()
  12994. content_type = res.get_header_value("Content-Type");
  12995. }
  12996. if (content_type.empty()) {
  12997. content_type = detail::find_content_type(
  12998. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12999. }
  13000. detail::set_file_content_provider(
  13001. res, mm, content_type,
  13002. static_file_encoding(req, res, content_type, mm->size()));
  13003. }
  13004. }
  13005. if (file_open_error) {
  13006. ret = write_response(strm, close_after_response, req, res);
  13007. } else if (detail::range_error(req, res)) {
  13008. detail::clear_content(res);
  13009. res.status = StatusCode::RangeNotSatisfiable_416;
  13010. ret = write_response(strm, close_after_response, req, res);
  13011. } else {
  13012. ret = write_response_with_content(strm, close_after_response, req, res);
  13013. }
  13014. } else {
  13015. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13016. ret = write_response(strm, close_after_response, req, res);
  13017. }
  13018. // Drain any unconsumed framed body to prevent request smuggling on
  13019. // keep-alive. Without framing there is no body to drain — reading would
  13020. // consume the next request (issue #2450). If the response has committed the
  13021. // connection to close, there is no next request to protect. A body read in
  13022. // part cannot be drained from where it stopped, so the connection closes.
  13023. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13024. !detail::has_header_token(res.headers, "Connection", "close")) {
  13025. int dummy_status;
  13026. if (req.body_read_started_ ||
  13027. !detail::read_content(
  13028. strm, req, payload_max_length_, dummy_status, nullptr,
  13029. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  13030. connection_closed = true;
  13031. }
  13032. }
  13033. return ret;
  13034. }
  13035. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13036. inline bool Server::process_and_close_socket(socket_t sock) {
  13037. std::string remote_addr;
  13038. int remote_port = 0;
  13039. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13040. std::string local_addr;
  13041. int local_port = 0;
  13042. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13043. bool websocket_upgraded = false;
  13044. auto ret = serve_guarded([&]() {
  13045. return detail::process_server_socket(
  13046. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13047. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13048. write_timeout_usec_,
  13049. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13050. return process_request(strm, remote_addr, remote_port, local_addr,
  13051. local_port, close_connection,
  13052. connection_closed, nullptr,
  13053. &websocket_upgraded);
  13054. });
  13055. });
  13056. detail::drain_and_close_socket(sock);
  13057. return ret;
  13058. }
  13059. inline void Server::output_log(const Request &req, const Response &res) const {
  13060. if (logger_) {
  13061. std::lock_guard<std::mutex> guard(logger_mutex_);
  13062. logger_(req, res);
  13063. }
  13064. }
  13065. inline void Server::output_pre_compression_log(const Request &req,
  13066. const Response &res) const {
  13067. if (pre_compression_logger_) {
  13068. std::lock_guard<std::mutex> guard(logger_mutex_);
  13069. pre_compression_logger_(req, res);
  13070. }
  13071. }
  13072. inline void Server::output_error_log(const Error &err,
  13073. const Request *req) const {
  13074. if (error_logger_) {
  13075. std::lock_guard<std::mutex> guard(logger_mutex_);
  13076. error_logger_(err, req);
  13077. }
  13078. }
  13079. /*
  13080. * Group 5: ClientImpl and Client (Universal) implementation
  13081. */
  13082. // HTTP client implementation
  13083. inline ClientImpl::ClientImpl(const std::string &host)
  13084. : ClientImpl(host, 80, std::string(), std::string()) {}
  13085. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13086. : ClientImpl(host, port, std::string(), std::string()) {}
  13087. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13088. const std::string &client_cert_path,
  13089. const std::string &client_key_path)
  13090. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13091. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13092. inline ClientImpl::~ClientImpl() {
  13093. // Wait until all the requests in flight are handled.
  13094. size_t retry_count = 10;
  13095. while (retry_count-- > 0) {
  13096. {
  13097. std::lock_guard<std::mutex> guard(socket_mutex_);
  13098. if (socket_requests_in_flight_ == 0) { break; }
  13099. }
  13100. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13101. }
  13102. std::lock_guard<std::mutex> guard(socket_mutex_);
  13103. shutdown_socket(socket_);
  13104. close_socket(socket_);
  13105. }
  13106. inline bool ClientImpl::is_valid() const { return true; }
  13107. inline bool
  13108. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13109. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13110. if (no_proxy_entries_.empty()) { return true; }
  13111. // host_ is const so its normalized form is invariant; cache it. The
  13112. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13113. if (host == host_) {
  13114. if (!host_normalized_valid_) {
  13115. host_normalized_ = detail::normalize_target(host_);
  13116. host_normalized_valid_ = true;
  13117. }
  13118. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13119. }
  13120. auto target = detail::normalize_target(host);
  13121. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13122. }
  13123. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13124. if (is_proxy_enabled_for_host(host_)) {
  13125. return detail::create_client_socket(
  13126. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13127. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13128. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13129. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13130. }
  13131. // Check is custom IP or hostname specified for host_
  13132. std::string connect_host;
  13133. std::string ip;
  13134. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13135. return detail::create_client_socket(
  13136. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13137. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13138. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13139. write_timeout_usec_, interface_, error);
  13140. }
  13141. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13142. Error &error) {
  13143. auto sock = create_client_socket(error);
  13144. if (sock == INVALID_SOCKET) { return false; }
  13145. socket.sock = sock;
  13146. return true;
  13147. }
  13148. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13149. return create_and_connect_socket(socket, error);
  13150. }
  13151. inline bool ClientImpl::setup_proxy_connection(
  13152. Socket & /*socket*/,
  13153. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13154. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13155. return true;
  13156. }
  13157. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13158. bool /*shutdown_gracefully*/) {
  13159. // If there are any requests in flight from threads other than us, then it's
  13160. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13161. assert(socket_requests_in_flight_ == 0 ||
  13162. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13163. }
  13164. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13165. if (socket.sock == INVALID_SOCKET) { return; }
  13166. detail::shutdown_socket(socket.sock);
  13167. }
  13168. inline void ClientImpl::close_socket(Socket &socket) {
  13169. // If there are requests in flight in another thread, usually closing
  13170. // the socket will be fine and they will simply receive an error when
  13171. // using the closed socket, but it is still a bug since rarely the OS
  13172. // may reassign the socket id to be used for a new socket, and then
  13173. // suddenly they will be operating on a live socket that is different
  13174. // than the one they intended!
  13175. assert(socket_requests_in_flight_ == 0 ||
  13176. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13177. // It is also a bug if this happens while SSL is still active
  13178. #ifdef CPPHTTPLIB_SSL_ENABLED
  13179. assert(socket.ssl == nullptr);
  13180. #endif
  13181. if (socket.sock == INVALID_SOCKET) { return; }
  13182. detail::close_socket(socket.sock);
  13183. socket.sock = INVALID_SOCKET;
  13184. }
  13185. inline void ClientImpl::disconnect(bool gracefully) {
  13186. shutdown_ssl(socket_, gracefully);
  13187. shutdown_socket(socket_);
  13188. close_socket(socket_);
  13189. }
  13190. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13191. Response &res,
  13192. bool skip_100_continue) const {
  13193. std::array<char, 2048> buf{};
  13194. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13195. if (!line_reader.getline()) { return false; }
  13196. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13197. res.reason)) {
  13198. return req.method == "CONNECT";
  13199. }
  13200. // Skip interim (1xx) responses along with their header fields, except a 100
  13201. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13202. // HTTP on the connection, so it is final. A server sending them without end
  13203. // would hold the client, so there may be only so many.
  13204. size_t interim_count = 0;
  13205. while (100 <= res.status && res.status < 200 &&
  13206. res.status != StatusCode::SwitchingProtocol_101 &&
  13207. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13208. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13209. return false;
  13210. }
  13211. Headers interim_headers;
  13212. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13213. if (!line_reader.getline()) { return false; } // next response line
  13214. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13215. res.reason)) {
  13216. return false;
  13217. }
  13218. }
  13219. return true;
  13220. }
  13221. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13222. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13223. auto ret = send_(req, res, error);
  13224. if (error == Error::SSLPeerCouldBeClosed_) {
  13225. assert(!ret);
  13226. ret = send_(req, res, error);
  13227. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13228. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13229. }
  13230. return ret;
  13231. }
  13232. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13233. #ifdef CPPHTTPLIB_SSL_ENABLED
  13234. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13235. // client that failed to set up its TLS context keeps reporting why.
  13236. if (is_valid()) {
  13237. last_ssl_error_ = 0;
  13238. last_backend_error_ = 0;
  13239. }
  13240. #endif
  13241. {
  13242. std::lock_guard<std::mutex> guard(socket_mutex_);
  13243. // Set this to false immediately - if it ever gets set to true by the end
  13244. // of the request, we know another thread instructed us to close the
  13245. // socket.
  13246. socket_should_be_closed_when_request_is_done_ = false;
  13247. auto is_alive = false;
  13248. if (socket_.is_open()) {
  13249. is_alive = detail::is_socket_alive(socket_.sock);
  13250. #ifdef CPPHTTPLIB_SSL_ENABLED
  13251. if (is_alive && is_ssl()) {
  13252. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13253. is_alive = false;
  13254. }
  13255. }
  13256. #endif
  13257. if (!is_alive) {
  13258. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13259. disconnect(/*gracefully=*/false);
  13260. }
  13261. }
  13262. if (!is_alive) {
  13263. if (!ensure_socket_connection(socket_, error)) {
  13264. output_error_log(error, &req);
  13265. return false;
  13266. }
  13267. {
  13268. auto success = true;
  13269. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13270. error)) {
  13271. if (!success) { output_error_log(error, &req); }
  13272. return success;
  13273. }
  13274. }
  13275. }
  13276. // Mark the current socket as being in use so that it cannot be closed by
  13277. // anyone else while this request is ongoing, even though we will be
  13278. // releasing the mutex.
  13279. if (socket_requests_in_flight_ > 1) {
  13280. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13281. }
  13282. socket_requests_in_flight_ += 1;
  13283. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13284. }
  13285. for (const auto &header : default_headers_) {
  13286. if (req.headers.find(header.first) == req.headers.end()) {
  13287. req.headers.insert(header);
  13288. }
  13289. }
  13290. auto ret = false;
  13291. auto close_connection = !keep_alive_;
  13292. auto se = detail::scope_exit([&]() {
  13293. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13294. std::lock_guard<std::mutex> guard(socket_mutex_);
  13295. socket_requests_in_flight_ -= 1;
  13296. if (socket_requests_in_flight_ <= 0) {
  13297. assert(socket_requests_in_flight_ == 0);
  13298. socket_requests_are_from_thread_ = std::thread::id();
  13299. }
  13300. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13301. !ret) {
  13302. disconnect(/*gracefully=*/true);
  13303. }
  13304. });
  13305. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13306. return handle_request(strm, req, res, close_connection, error);
  13307. });
  13308. if (!ret) {
  13309. if (error == Error::Success) {
  13310. error = Error::Unknown;
  13311. output_error_log(error, &req);
  13312. }
  13313. }
  13314. return ret;
  13315. }
  13316. inline Result ClientImpl::send(const Request &req) {
  13317. auto req2 = req;
  13318. return send_(std::move(req2));
  13319. }
  13320. inline Result ClientImpl::send_(Request &&req) {
  13321. auto res = detail::make_unique<Response>();
  13322. auto error = Error::Success;
  13323. #ifdef CPPHTTPLIB_SSL_ENABLED
  13324. // Hold the request lock until the Result has read this request's TLS error
  13325. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13326. #endif
  13327. auto ret = send(req, *res, error);
  13328. #ifdef CPPHTTPLIB_SSL_ENABLED
  13329. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13330. last_ssl_error_, last_backend_error_};
  13331. #else
  13332. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13333. #endif
  13334. }
  13335. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13336. const std::string &ct) {
  13337. (void)for_stream;
  13338. // Default headers are meant for the origin and may carry its credentials, so
  13339. // keep them off the CONNECT request the proxy reads.
  13340. if (r.method != "CONNECT") {
  13341. for (const auto &header : default_headers_) {
  13342. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13343. }
  13344. }
  13345. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13346. // prepend it rather than appending it after the caller's own fields.
  13347. if (!r.has_header("Host")) {
  13348. r.headers.emplace_front(
  13349. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13350. address_family_));
  13351. }
  13352. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13353. if (!r.content_receiver) {
  13354. if (!r.has_header("Accept-Encoding")) {
  13355. std::string accept_encoding;
  13356. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13357. accept_encoding = "br";
  13358. #endif
  13359. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13360. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13361. accept_encoding += "gzip, deflate";
  13362. #endif
  13363. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13364. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13365. accept_encoding += "zstd";
  13366. #endif
  13367. r.set_header("Accept-Encoding", accept_encoding);
  13368. }
  13369. detail::add_default_user_agent_header(r);
  13370. }
  13371. if (!r.body.empty()) {
  13372. if (!ct.empty() && !r.has_header("Content-Type")) {
  13373. r.headers.emplace("Content-Type", ct);
  13374. }
  13375. if (!r.has_header("Content-Length")) {
  13376. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13377. }
  13378. }
  13379. }
  13380. inline ClientImpl::StreamHandle
  13381. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13382. const Params &params, const Headers &headers,
  13383. const std::string &body,
  13384. const std::string &content_type) {
  13385. StreamHandle handle;
  13386. handle.response = detail::make_unique<Response>();
  13387. handle.error = Error::Success;
  13388. // Encode the target exactly like the buffered send path does, so that the
  13389. // same `path` produces the same request line through either API.
  13390. auto raw_query_path =
  13391. params.empty() ? path : append_query_params(path, params);
  13392. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13393. handle.connection_ = detail::make_unique<ClientConnection>();
  13394. {
  13395. std::lock_guard<std::mutex> guard(socket_mutex_);
  13396. auto is_alive = false;
  13397. if (socket_.is_open()) {
  13398. is_alive = detail::is_socket_alive(socket_.sock);
  13399. #ifdef CPPHTTPLIB_SSL_ENABLED
  13400. if (is_alive && is_ssl()) {
  13401. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13402. is_alive = false;
  13403. }
  13404. }
  13405. #endif
  13406. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13407. }
  13408. if (!is_alive) {
  13409. if (!ensure_socket_connection(socket_, handle.error)) {
  13410. handle.response.reset();
  13411. return handle;
  13412. }
  13413. {
  13414. auto success = true;
  13415. auto start_time = std::chrono::steady_clock::now();
  13416. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13417. success, handle.error)) {
  13418. if (!success) { handle.response.reset(); }
  13419. return handle;
  13420. }
  13421. }
  13422. }
  13423. transfer_socket_ownership_to_handle(handle);
  13424. }
  13425. #ifdef CPPHTTPLIB_SSL_ENABLED
  13426. if (is_ssl() && handle.connection_->session) {
  13427. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13428. handle.connection_->sock, handle.connection_->session,
  13429. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13430. write_timeout_usec_);
  13431. } else {
  13432. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13433. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13434. write_timeout_sec_, write_timeout_usec_);
  13435. }
  13436. #else
  13437. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13438. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13439. write_timeout_sec_, write_timeout_usec_);
  13440. #endif
  13441. handle.stream_ = handle.socket_stream_.get();
  13442. Request req;
  13443. req.method = method;
  13444. req.path = query_path;
  13445. req.headers = headers;
  13446. req.body = body;
  13447. prepare_default_headers(req, true, content_type);
  13448. auto &strm = *handle.stream_;
  13449. // Build the request line and headers in memory first, like write_request()
  13450. // does, so that a rejected header leaves nothing on the wire.
  13451. {
  13452. detail::BufferStream bstrm;
  13453. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13454. handle.error = Error::Write;
  13455. handle.response.reset();
  13456. return handle;
  13457. }
  13458. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13459. handle.error)) {
  13460. handle.response.reset();
  13461. return handle;
  13462. }
  13463. const auto &data = bstrm.get_buffer();
  13464. if (!detail::write_data(strm, data.data(), data.size())) {
  13465. handle.error = Error::Write;
  13466. handle.response.reset();
  13467. return handle;
  13468. }
  13469. }
  13470. if (!body.empty()) {
  13471. if (strm.write(body.data(), body.size()) < 0) {
  13472. handle.error = Error::Write;
  13473. handle.response.reset();
  13474. return handle;
  13475. }
  13476. }
  13477. if (!read_response_line(strm, req, *handle.response) ||
  13478. !detail::read_headers(strm, handle.response->headers)) {
  13479. handle.error = Error::Read;
  13480. handle.response.reset();
  13481. return handle;
  13482. }
  13483. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13484. // (204/304) response legitimately carries framing headers with no body.
  13485. if (method != "HEAD" &&
  13486. handle.response->status != StatusCode::NoContent_204 &&
  13487. handle.response->status != StatusCode::NotModified_304 &&
  13488. detail::has_conflicting_content_length(handle.response->headers)) {
  13489. handle.error = Error::Read;
  13490. handle.response.reset();
  13491. return handle;
  13492. }
  13493. handle.body_reader_.stream = handle.stream_;
  13494. handle.body_reader_.payload_max_length = payload_max_length_;
  13495. if (handle.response->has_header("Content-Length")) {
  13496. bool is_invalid = false;
  13497. auto content_length = detail::get_header_value_u64(
  13498. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13499. if (is_invalid) {
  13500. handle.error = Error::Read;
  13501. handle.response.reset();
  13502. return handle;
  13503. }
  13504. handle.body_reader_.has_content_length = true;
  13505. handle.body_reader_.content_length = content_length;
  13506. }
  13507. handle.body_reader_.chunked =
  13508. detail::is_chunked_transfer_encoding(handle.response->headers);
  13509. auto content_encoding = detail::get_combined_header_value(
  13510. handle.response->headers, "Content-Encoding");
  13511. if (!content_encoding.empty()) {
  13512. // Same policy as prepare_content_receiver(): reject a coding we know about
  13513. // but were not built with, pass an unrecognized one through as-is.
  13514. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13515. if (!handle.decompressor_) {
  13516. if (detail::is_known_content_encoding(content_encoding)) {
  13517. handle.error = Error::UnsupportedContentEncoding;
  13518. handle.response.reset();
  13519. return handle;
  13520. }
  13521. } else if (!handle.decompressor_->is_valid()) {
  13522. handle.error = Error::Compression;
  13523. handle.response.reset();
  13524. return handle;
  13525. }
  13526. }
  13527. return handle;
  13528. }
  13529. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13530. if (!is_valid() || !response) { return -1; }
  13531. if (decompressor_) { return read_with_decompression(buf, len); }
  13532. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13533. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13534. trailers_parsed_ = true;
  13535. if (body_reader_.chunked_decoder) {
  13536. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13537. response->trailers, response->headers)) {
  13538. return n;
  13539. }
  13540. } else {
  13541. detail::ChunkedDecoder dec(*stream_);
  13542. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13543. return n;
  13544. }
  13545. }
  13546. }
  13547. return n;
  13548. }
  13549. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13550. size_t len) {
  13551. if (decompress_offset_ < decompress_buffer_.size()) {
  13552. auto available = decompress_buffer_.size() - decompress_offset_;
  13553. auto to_copy = (std::min)(len, available);
  13554. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13555. decompress_offset_ += to_copy;
  13556. decompressed_bytes_read_ += to_copy;
  13557. return static_cast<ssize_t>(to_copy);
  13558. }
  13559. decompress_buffer_.clear();
  13560. decompress_offset_ = 0;
  13561. constexpr size_t kDecompressionBufferSize = 8192;
  13562. char compressed_buf[kDecompressionBufferSize];
  13563. while (true) {
  13564. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13565. sizeof(compressed_buf));
  13566. if (n <= 0) { return n; }
  13567. auto exceeded = false;
  13568. bool decompress_ok = decompressor_->decompress(
  13569. compressed_buf, static_cast<size_t>(n),
  13570. [&](const char *data, size_t data_len) {
  13571. decompress_buffer_.append(data, data_len);
  13572. auto limit = body_reader_.payload_max_length;
  13573. exceeded =
  13574. limit > 0 &&
  13575. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13576. return !exceeded;
  13577. });
  13578. if (!decompress_ok) {
  13579. body_reader_.last_error =
  13580. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13581. return -1;
  13582. }
  13583. if (!decompress_buffer_.empty()) { break; }
  13584. }
  13585. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13586. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13587. decompress_offset_ = to_copy;
  13588. decompressed_bytes_read_ += to_copy;
  13589. return static_cast<ssize_t>(to_copy);
  13590. }
  13591. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13592. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13593. return;
  13594. }
  13595. trailers_parsed_ = true;
  13596. const auto bufsiz = 128;
  13597. char line_buf[bufsiz];
  13598. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13599. if (!line_reader.getline()) { return; }
  13600. if (!detail::parse_trailers(line_reader, response->trailers,
  13601. response->headers)) {
  13602. return;
  13603. }
  13604. }
  13605. namespace detail {
  13606. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13607. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13608. size_t &out_chunk_offset,
  13609. size_t &out_chunk_total) {
  13610. if (finished) { return 0; }
  13611. if (chunk_remaining == 0) {
  13612. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13613. if (!lr.getline()) { return -1; }
  13614. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13615. // the line terminator is never mistaken for line content.
  13616. const char *eol = lr.ptr() + lr.size();
  13617. if (lr.end_with_crlf()) {
  13618. eol -= 2;
  13619. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13620. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13621. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13622. // has to come off here or the check below would reject the line.
  13623. eol -= 1;
  13624. }
  13625. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13626. const char *p = lr.ptr();
  13627. int v = 0;
  13628. if (p == eol || !is_hex(*p, v)) { return -1; }
  13629. size_t chunk_len = 0;
  13630. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13631. for (; p < eol && is_hex(*p, v); ++p) {
  13632. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13633. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13634. }
  13635. while (p < eol && is_space_or_tab(*p)) {
  13636. ++p;
  13637. }
  13638. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13639. // terminator, and it is built from tokens and quoted-strings, so it never
  13640. // holds a CR, LF or any other control character. getline() reads up to the
  13641. // CRLF, so a bare LF left in here would be swallowed as extension text
  13642. // while an intermediary that ends the line on it delimits the chunks
  13643. // differently, and the two disagree on where the body ends (request
  13644. // smuggling).
  13645. if (p < eol && *p != ';') { return -1; }
  13646. for (; p < eol; ++p) {
  13647. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13648. }
  13649. if (chunk_len == 0) {
  13650. chunk_remaining = 0;
  13651. finished = true;
  13652. out_chunk_offset = 0;
  13653. out_chunk_total = 0;
  13654. return 0;
  13655. }
  13656. chunk_remaining = chunk_len;
  13657. last_chunk_total = chunk_remaining;
  13658. last_chunk_offset = 0;
  13659. }
  13660. auto to_read = (std::min)(chunk_remaining, len);
  13661. auto n = strm.read(buf, to_read);
  13662. if (n <= 0) { return -1; }
  13663. auto offset_before = last_chunk_offset;
  13664. last_chunk_offset += static_cast<size_t>(n);
  13665. chunk_remaining -= static_cast<size_t>(n);
  13666. out_chunk_offset = offset_before;
  13667. out_chunk_total = last_chunk_total;
  13668. if (chunk_remaining == 0) {
  13669. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13670. if (!lr.getline()) { return -1; }
  13671. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13672. }
  13673. return n;
  13674. }
  13675. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13676. const Headers &src_headers) {
  13677. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13678. if (!lr.getline()) { return false; }
  13679. return parse_trailers(lr, dest, src_headers);
  13680. }
  13681. } // namespace detail
  13682. inline void
  13683. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13684. handle.connection_->sock = socket_.sock;
  13685. #ifdef CPPHTTPLIB_SSL_ENABLED
  13686. handle.connection_->session = socket_.ssl;
  13687. socket_.ssl = nullptr;
  13688. #endif
  13689. socket_.sock = INVALID_SOCKET;
  13690. }
  13691. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13692. Response &res, bool close_connection,
  13693. Error &error) {
  13694. if (req.path.empty()) {
  13695. error = Error::Connection;
  13696. output_error_log(error, &req);
  13697. return false;
  13698. }
  13699. auto req_save = req;
  13700. bool ret;
  13701. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13702. auto req2 = req;
  13703. req2.path = "http://" +
  13704. detail::make_host_and_port_string(host_, port_, false) +
  13705. req.path;
  13706. ret = process_request(strm, req2, res, close_connection, error);
  13707. req = std::move(req2);
  13708. req.path = req_save.path;
  13709. } else {
  13710. ret = process_request(strm, req, res, close_connection, error);
  13711. }
  13712. if (!ret) { return false; }
  13713. {
  13714. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13715. // for this to be safe.
  13716. // This is safe to call because handle_request is only called by send_
  13717. // which locks the request mutex during the process. It would be a bug
  13718. // to call it from a different thread since it's a thread-safety issue
  13719. // to do these things to the socket if another thread is using the socket.
  13720. std::lock_guard<std::mutex> guard(socket_mutex_);
  13721. // Also when the request asked for it (e.g. a body that was never sent),
  13722. // so that a redirect or an auth retry below does not reuse the socket.
  13723. if (socket_should_be_closed_when_request_is_done_ ||
  13724. detail::has_header_token(res.headers, "Connection", "close") ||
  13725. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13726. disconnect(/*gracefully=*/true);
  13727. }
  13728. }
  13729. if (300 < res.status && res.status < 400 && follow_location_) {
  13730. req = std::move(req_save);
  13731. // The client that followed the redirect has answered any challenge it
  13732. // could. Retrying below would sign another host's challenge and send it
  13733. // here.
  13734. return redirect(req, res, error);
  13735. }
  13736. #ifdef CPPHTTPLIB_SSL_ENABLED
  13737. if ((res.status == StatusCode::Unauthorized_401 ||
  13738. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13739. req.authorization_count_ < 5) {
  13740. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13741. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13742. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13743. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13744. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13745. return ret;
  13746. }
  13747. const auto &username =
  13748. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13749. const auto &password =
  13750. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13751. if (!username.empty() && !password.empty()) {
  13752. std::map<std::string, std::string> auth;
  13753. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13754. Request new_req = req;
  13755. new_req.authorization_count_ += 1;
  13756. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13757. : "Authorization");
  13758. new_req.headers.insert(detail::make_digest_authentication_header(
  13759. req, make_request_target(req), auth, new_req.authorization_count_,
  13760. detail::random_string(10), username, password, is_proxy));
  13761. Response new_res;
  13762. ret = send(new_req, new_res, error);
  13763. if (ret) { res = std::move(new_res); }
  13764. }
  13765. }
  13766. }
  13767. #endif
  13768. return ret;
  13769. }
  13770. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13771. if (req.redirect_count_ == 0) {
  13772. error = Error::ExceedRedirectCount;
  13773. output_error_log(error, &req);
  13774. return false;
  13775. }
  13776. auto location = res.get_header_value("location");
  13777. if (location.empty()) { return false; }
  13778. detail::UrlComponents uc;
  13779. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13780. uc)) {
  13781. return false;
  13782. }
  13783. // Only follow http/https redirects
  13784. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13785. return false;
  13786. }
  13787. auto scheme = is_ssl() ? "https" : "http";
  13788. auto next_scheme = std::move(uc.scheme);
  13789. auto next_host = std::move(uc.host);
  13790. auto port_str = std::move(uc.port);
  13791. auto next_path = std::move(uc.path);
  13792. auto next_query = std::move(uc.query);
  13793. auto next_port = port_;
  13794. if (!port_str.empty()) {
  13795. if (!detail::parse_port(port_str, next_port)) { return false; }
  13796. } else if (!next_scheme.empty()) {
  13797. next_port = next_scheme == "https" ? 443 : 80;
  13798. }
  13799. if (next_scheme.empty()) { next_scheme = scheme; }
  13800. if (next_host.empty()) { next_host = host_; }
  13801. if (next_path.empty()) { next_path = "/"; }
  13802. auto path = std::move(next_path) + next_query;
  13803. // Same host redirect - use current client
  13804. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13805. return detail::redirect(*this, req, res, path, location, error);
  13806. }
  13807. // Cross-host/scheme redirect - create new client with robust setup
  13808. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13809. path, location, error);
  13810. }
  13811. // New method for robust redirect client creation
  13812. inline bool ClientImpl::create_redirect_client(
  13813. const std::string &scheme, const std::string &host, int port, Request &req,
  13814. Response &res, const std::string &path, const std::string &location,
  13815. Error &error) {
  13816. // Determine if we need SSL
  13817. auto need_ssl = (scheme == "https");
  13818. // Clean up request headers that are host/client specific
  13819. // Remove headers that should not be carried over to new host
  13820. auto headers_to_remove = std::vector<std::string>{
  13821. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13822. for (const auto &header_name : headers_to_remove) {
  13823. auto it = req.headers.find(header_name);
  13824. while (it != req.headers.end()) {
  13825. it = req.headers.erase(it);
  13826. it = req.headers.find(header_name);
  13827. }
  13828. }
  13829. // Create appropriate client type and handle redirect
  13830. if (need_ssl) {
  13831. #ifdef CPPHTTPLIB_SSL_ENABLED
  13832. // Create SSL client for HTTPS redirect
  13833. SSLClient redirect_client(host, port);
  13834. // Setup basic client configuration first
  13835. setup_redirect_client(redirect_client);
  13836. redirect_client.enable_server_certificate_verification(
  13837. server_certificate_verification_);
  13838. redirect_client.enable_server_hostname_verification(
  13839. server_hostname_verification_);
  13840. redirect_client.system_ca_mode_ = system_ca_mode_;
  13841. // Transfer CA certificate to redirect client
  13842. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13843. if (is_ssl()) {
  13844. auto &self = static_cast<SSLClient &>(*this);
  13845. // A store given to set_ca_cert_store() lives only in this client's
  13846. // context, which then holds all that is trusted.
  13847. if (self.ca_cert_store_set_) {
  13848. std::string pem;
  13849. {
  13850. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  13851. pem = detail::ca_certs_to_pem(self.ctx_);
  13852. }
  13853. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13854. redirect_client.ca_cert_store_set_ = true;
  13855. } else {
  13856. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13857. ca_cert_pem_.size());
  13858. }
  13859. redirect_client.set_session_verifier(self.session_verifier_);
  13860. if (self.server_certificate_verifier_) {
  13861. redirect_client.set_server_certificate_verifier(
  13862. self.server_certificate_verifier_);
  13863. }
  13864. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13865. redirect_client.enable_windows_cert_verification_ =
  13866. self.enable_windows_cert_verification_;
  13867. #endif
  13868. }
  13869. // Client certificates are set through constructor for SSLClient
  13870. // NOTE: SSLClient constructor already takes client_cert_path and
  13871. // client_key_path so we need to create it properly if client certs are
  13872. // needed
  13873. // Execute the redirect
  13874. return detail::redirect(redirect_client, req, res, path, location, error);
  13875. #else
  13876. // SSL not supported - set appropriate error
  13877. error = Error::SSLConnection;
  13878. output_error_log(error, &req);
  13879. return false;
  13880. #endif
  13881. } else {
  13882. // HTTP redirect
  13883. ClientImpl redirect_client(host, port);
  13884. // Setup client with robust configuration
  13885. setup_redirect_client(redirect_client);
  13886. // Execute the redirect
  13887. return detail::redirect(redirect_client, req, res, path, location, error);
  13888. }
  13889. }
  13890. // New method for robust client setup (based on basic_manual_redirect.cpp
  13891. // logic)
  13892. template <typename ClientType>
  13893. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13894. // Copy basic settings first
  13895. client.set_connection_timeout(connection_timeout_sec_,
  13896. connection_timeout_usec_);
  13897. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13898. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13899. client.set_max_timeout(max_timeout_msec_);
  13900. if (has_payload_max_length_) {
  13901. client.set_payload_max_length(payload_max_length_);
  13902. }
  13903. client.set_keep_alive(keep_alive_);
  13904. client.set_follow_location(
  13905. true); // Enable redirects to handle multi-step redirects
  13906. client.set_path_encode(path_encode_);
  13907. client.set_compress(compress_);
  13908. client.set_decompress(decompress_);
  13909. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13910. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13911. // 15.4, credentials must not be forwarded when redirecting to a different
  13912. // host. This function is only called for cross-host redirects; same-host
  13913. // redirects are handled directly in ClientImpl::redirect().
  13914. // Copy the proxy configuration unconditionally; the per-target bypass is
  13915. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13916. // still use the proxy.
  13917. client.no_proxy_entries_ = no_proxy_entries_;
  13918. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13919. client.set_proxy(proxy_host_, proxy_port_);
  13920. if (!proxy_basic_auth_username_.empty() ||
  13921. !proxy_basic_auth_password_.empty()) {
  13922. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13923. proxy_basic_auth_password_);
  13924. }
  13925. if (!proxy_bearer_token_auth_token_.empty()) {
  13926. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13927. }
  13928. #ifdef CPPHTTPLIB_SSL_ENABLED
  13929. if (!proxy_digest_auth_username_.empty()) {
  13930. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13931. proxy_digest_auth_password_);
  13932. }
  13933. #endif
  13934. }
  13935. // Copy network and socket settings
  13936. client.addr_map_ = addr_map_;
  13937. client.set_address_family(address_family_);
  13938. client.set_tcp_nodelay(tcp_nodelay_);
  13939. client.set_ipv6_v6only(ipv6_v6only_);
  13940. if (socket_options_) { client.set_socket_options(socket_options_); }
  13941. if (!interface_.empty()) { client.set_interface(interface_); }
  13942. // Copy logging and headers
  13943. if (logger_) { client.set_logger(logger_); }
  13944. if (error_logger_) { client.set_error_logger(error_logger_); }
  13945. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13946. // Each new client should generate its own headers based on its target host
  13947. }
  13948. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13949. const Request &req,
  13950. Error &error) const {
  13951. auto is_shutting_down = []() { return false; };
  13952. if (req.is_chunked_content_provider_) {
  13953. auto compressor = compress_ ? detail::create_compressor().first
  13954. : std::unique_ptr<detail::compressor>();
  13955. if (!compressor) {
  13956. compressor = detail::make_unique<detail::nocompressor>();
  13957. }
  13958. return detail::write_content_chunked(strm, req.content_provider_,
  13959. is_shutting_down, *compressor, error);
  13960. } else {
  13961. return detail::write_content_with_progress(
  13962. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13963. req.upload_progress, error);
  13964. }
  13965. }
  13966. // What goes on the request line for req: its path, encoded and without the
  13967. // fragment, with `req.params` as the query when the path has none.
  13968. inline std::string ClientImpl::make_request_target(const Request &req) const {
  13969. auto target = detail::encode_request_target(req.path, path_encode_);
  13970. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  13971. target = append_query_params(target, req.params);
  13972. }
  13973. return target;
  13974. }
  13975. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13976. bool close_connection, Error &error,
  13977. bool skip_body, bool &rejected_locally) {
  13978. rejected_locally = false;
  13979. // Prepare additional headers
  13980. if (close_connection) {
  13981. if (!req.has_header("Connection")) {
  13982. req.set_header("Connection", "close");
  13983. }
  13984. }
  13985. std::string ct_for_defaults;
  13986. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13987. ct_for_defaults = "text/plain";
  13988. }
  13989. prepare_default_headers(req, false, ct_for_defaults);
  13990. if (req.body.empty()) {
  13991. if (req.content_provider_) {
  13992. if (!req.is_chunked_content_provider_) {
  13993. if (!req.has_header("Content-Length")) {
  13994. auto length = std::to_string(req.content_length_);
  13995. req.set_header("Content-Length", length);
  13996. }
  13997. }
  13998. } else {
  13999. if (req.method == "POST" || req.method == "PUT" ||
  14000. req.method == "PATCH") {
  14001. req.set_header("Content-Length", "0");
  14002. }
  14003. }
  14004. }
  14005. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14006. // it opens is read by the origin. Each credential goes only to its own hop.
  14007. auto is_connect = req.method == "CONNECT";
  14008. if (!is_connect) {
  14009. detail::add_authorization_header(req, basic_auth_username_,
  14010. basic_auth_password_,
  14011. bearer_token_auth_token_, false);
  14012. }
  14013. // Proxy-Authorization is only sent when the proxy reads this message —
  14014. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14015. // would leak proxy credentials to the destination server.
  14016. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14017. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14018. proxy_basic_auth_password_,
  14019. proxy_bearer_token_auth_token_, true);
  14020. }
  14021. // Request line and headers
  14022. {
  14023. detail::BufferStream bstrm;
  14024. auto path_with_query = make_request_target(req);
  14025. // The query already came in through `req.path`; still populate
  14026. // `req.params` for handlers/users who read them.
  14027. auto query_part = detail::query_of(req.path);
  14028. if (!query_part.empty()) {
  14029. detail::parse_query_text(query_part, req.params);
  14030. }
  14031. // Write request line and headers
  14032. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14033. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14034. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14035. // fail the request cleanly instead of emitting a request-line-less,
  14036. // header-injecting request.
  14037. error = Error::Write;
  14038. rejected_locally = true;
  14039. output_error_log(error, &req);
  14040. return false;
  14041. }
  14042. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14043. error)) {
  14044. rejected_locally = true;
  14045. output_error_log(error, &req);
  14046. return false;
  14047. }
  14048. // Flush buffer
  14049. auto &data = bstrm.get_buffer();
  14050. if (!detail::write_data(strm, data.data(), data.size())) {
  14051. error = Error::Write;
  14052. output_error_log(error, &req);
  14053. return false;
  14054. }
  14055. }
  14056. // After sending request line and headers, wait briefly for an early server
  14057. // response (e.g. 4xx) and avoid sending a potentially large request body
  14058. // unnecessarily. This workaround is only enabled on Windows because Unix
  14059. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14060. // buffering can accept large writes even when the peer already responded.
  14061. // Check the stream first (which covers SSL via `is_readable()`), then
  14062. // fall back to select on the socket. Only perform the wait for very large
  14063. // request bodies to avoid interfering with normal small requests and
  14064. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14065. // response. Skip this check when using Expect: 100-continue, as the protocol
  14066. // handles early responses properly.
  14067. #if defined(_WIN32)
  14068. if (!skip_body &&
  14069. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14070. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14071. auto start = std::chrono::high_resolution_clock::now();
  14072. for (;;) {
  14073. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14074. // from SSL internals. If the underlying socket is readable, assume an
  14075. // early response may be present.
  14076. auto sock = strm.socket();
  14077. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14078. return false;
  14079. }
  14080. // Fallback to stream-level check for non-socket streams or when the
  14081. // socket isn't reporting readable. Avoid using `is_readable()` for
  14082. // SSL, since `SSL_pending()` may report buffered records that do not
  14083. // indicate a complete application-level response yet.
  14084. if (!is_ssl() && strm.is_readable()) { return false; }
  14085. auto now = std::chrono::high_resolution_clock::now();
  14086. auto elapsed =
  14087. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14088. .count();
  14089. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14090. break;
  14091. }
  14092. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14093. }
  14094. }
  14095. #endif
  14096. // Body
  14097. if (skip_body) { return true; }
  14098. return write_request_body(strm, req, error);
  14099. }
  14100. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14101. Error &error) {
  14102. if (req.body.empty()) {
  14103. return write_content_with_provider(strm, req, error);
  14104. }
  14105. if (req.upload_progress) {
  14106. auto body_size = req.body.size();
  14107. size_t written = 0;
  14108. auto data = req.body.data();
  14109. while (written < body_size) {
  14110. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14111. if (!detail::write_data(strm, data + written, to_write)) {
  14112. error = Error::Write;
  14113. output_error_log(error, &req);
  14114. return false;
  14115. }
  14116. written += to_write;
  14117. if (!req.upload_progress(written, body_size)) {
  14118. error = Error::Canceled;
  14119. output_error_log(error, &req);
  14120. return false;
  14121. }
  14122. }
  14123. } else {
  14124. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14125. error = Error::Write;
  14126. output_error_log(error, &req);
  14127. return false;
  14128. }
  14129. }
  14130. return true;
  14131. }
  14132. inline std::unique_ptr<Response>
  14133. ClientImpl::send_with_content_provider_and_receiver(
  14134. Request &req, const char *body, size_t content_length,
  14135. ContentProvider content_provider,
  14136. ContentProviderWithoutLength content_provider_without_length,
  14137. const std::string &content_type, ContentReceiver content_receiver,
  14138. Error &error) {
  14139. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14140. auto enc = compress_
  14141. ? detail::create_compressor()
  14142. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14143. nullptr, nullptr);
  14144. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14145. if (enc.first && !content_provider_without_length) {
  14146. auto &compressor = enc.first;
  14147. if (content_provider) {
  14148. auto ok = true;
  14149. auto finished = false;
  14150. size_t offset = 0;
  14151. DataSink data_sink;
  14152. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14153. if (ok) {
  14154. auto last = offset + data_len == content_length;
  14155. auto ret = compressor->compress(
  14156. data, data_len, last,
  14157. [&](const char *compressed_data, size_t compressed_data_len) {
  14158. req.body.append(compressed_data, compressed_data_len);
  14159. return true;
  14160. });
  14161. if (ret) {
  14162. offset += data_len;
  14163. } else {
  14164. ok = false;
  14165. }
  14166. }
  14167. return ok;
  14168. };
  14169. // As in detail::write_content_with_progress(): the body is framed by
  14170. // content_length, so a provider that finishes early has truncated it.
  14171. // Stop and report that instead of calling the provider forever.
  14172. data_sink.done = [&]() { finished = true; };
  14173. while (ok && !finished && offset < content_length) {
  14174. if (!content_provider(offset, content_length - offset, data_sink)) {
  14175. error = Error::Canceled;
  14176. output_error_log(error, &req);
  14177. return nullptr;
  14178. }
  14179. }
  14180. // A short body here means either the provider stopped early or the
  14181. // compressor gave up. The branch below reports a failing compressor as
  14182. // Error::Compression, so keep the two distinguishable.
  14183. if (offset < content_length) {
  14184. error = ok ? Error::Write : Error::Compression;
  14185. output_error_log(error, &req);
  14186. return nullptr;
  14187. }
  14188. } else {
  14189. if (!compressor->compress(body, content_length, true,
  14190. [&](const char *data, size_t data_len) {
  14191. req.body.append(data, data_len);
  14192. return true;
  14193. })) {
  14194. error = Error::Compression;
  14195. output_error_log(error, &req);
  14196. return nullptr;
  14197. }
  14198. }
  14199. } else {
  14200. if (content_provider) {
  14201. req.content_length_ = content_length;
  14202. req.content_provider_ = std::move(content_provider);
  14203. req.is_chunked_content_provider_ = false;
  14204. } else if (content_provider_without_length) {
  14205. req.content_length_ = 0;
  14206. req.content_provider_ = detail::ContentProviderAdapter(
  14207. std::move(content_provider_without_length));
  14208. req.is_chunked_content_provider_ = true;
  14209. req.set_header("Transfer-Encoding", "chunked");
  14210. } else {
  14211. req.body.assign(body, content_length);
  14212. }
  14213. }
  14214. if (content_receiver) {
  14215. req.content_receiver =
  14216. [content_receiver](const char *data, size_t data_length,
  14217. size_t /*offset*/, size_t /*total_length*/) {
  14218. return content_receiver(data, data_length);
  14219. };
  14220. }
  14221. auto res = detail::make_unique<Response>();
  14222. return send(req, *res, error) ? std::move(res) : nullptr;
  14223. }
  14224. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14225. const std::string &method, const std::string &path, const Headers &headers,
  14226. const char *body, size_t content_length, ContentProvider content_provider,
  14227. ContentProviderWithoutLength content_provider_without_length,
  14228. const std::string &content_type, ContentReceiver content_receiver,
  14229. UploadProgress progress) {
  14230. Request req;
  14231. req.method = method;
  14232. req.headers = headers;
  14233. req.path = path;
  14234. req.upload_progress = std::move(progress);
  14235. if (max_timeout_msec_ > 0) {
  14236. req.start_time_ = std::chrono::steady_clock::now();
  14237. }
  14238. auto error = Error::Success;
  14239. #ifdef CPPHTTPLIB_SSL_ENABLED
  14240. // Hold the request lock until the Result has read this request's TLS error
  14241. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14242. #endif
  14243. auto res = send_with_content_provider_and_receiver(
  14244. req, body, content_length, std::move(content_provider),
  14245. std::move(content_provider_without_length), content_type,
  14246. std::move(content_receiver), error);
  14247. #ifdef CPPHTTPLIB_SSL_ENABLED
  14248. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14249. last_backend_error_};
  14250. #else
  14251. return Result{std::move(res), error, std::move(req.headers)};
  14252. #endif
  14253. }
  14254. inline void ClientImpl::output_log(const Request &req,
  14255. const Response &res) const {
  14256. if (logger_) {
  14257. std::lock_guard<std::mutex> guard(logger_mutex_);
  14258. logger_(req, res);
  14259. }
  14260. }
  14261. inline void ClientImpl::output_error_log(const Error &err,
  14262. const Request *req) const {
  14263. if (error_logger_) {
  14264. std::lock_guard<std::mutex> guard(logger_mutex_);
  14265. error_logger_(err, req);
  14266. }
  14267. }
  14268. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14269. Response &res, bool close_connection,
  14270. Error &error) {
  14271. // Auto-add Expect: 100-continue for large bodies
  14272. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14273. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14274. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14275. req.set_header("Expect", "100-continue");
  14276. }
  14277. }
  14278. // Check for Expect: 100-continue
  14279. auto expect_100_continue =
  14280. detail::has_header_token(req.headers, "Expect", "100-continue");
  14281. // Send request (skip body if using Expect: 100-continue)
  14282. auto rejected_locally = false;
  14283. auto write_request_success =
  14284. write_request(strm, req, close_connection, error, expect_100_continue,
  14285. rejected_locally);
  14286. // A failed write normally still reads the response below, since the server
  14287. // may have answered early (e.g. 413/414) and closed while the body was being
  14288. // sent. A request rejected before any byte reached the socket gets no such
  14289. // response, and waiting for one would block until the read timeout.
  14290. if (rejected_locally) { return false; }
  14291. #ifdef CPPHTTPLIB_SSL_ENABLED
  14292. if (is_ssl() && !expect_100_continue) {
  14293. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14294. if (!is_proxy_enabled) {
  14295. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14296. error = Error::SSLPeerCouldBeClosed_;
  14297. output_error_log(error, &req);
  14298. return false;
  14299. }
  14300. }
  14301. }
  14302. #endif
  14303. // Handle Expect: 100-continue.
  14304. //
  14305. // Wait for an interim/early response by attempting to read the status line
  14306. // under a short timeout, instead of trusting raw socket readability. Over
  14307. // TLS, post-handshake records (e.g. session tickets) make the socket
  14308. // readable without any HTTP response being available; relying on
  14309. // `select_read` there caused the body to be withheld forever and the
  14310. // request to fail with `Read` (#2458). If no status line arrives within the
  14311. // timeout, send the body anyway (matching curl's behavior).
  14312. auto status_line_read = false;
  14313. if (expect_100_continue && write_request_success) {
  14314. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14315. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14316. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14317. strm.set_read_timeout(sec, usec);
  14318. status_line_read = read_response_line(strm, req, res, false);
  14319. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14320. }
  14321. if (!status_line_read) {
  14322. // No interim response within the timeout: send the body and handle the
  14323. // response as usual.
  14324. if (!write_request_body(strm, req, error)) { return false; }
  14325. expect_100_continue = false; // Switch to normal response handling
  14326. }
  14327. }
  14328. // Receive response and headers
  14329. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14330. if ((!status_line_read &&
  14331. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14332. !detail::read_headers(strm, res.headers)) {
  14333. if (write_request_success) { error = Error::Read; }
  14334. output_error_log(error, &req);
  14335. return false;
  14336. }
  14337. if (!write_request_success) { return false; }
  14338. // Handle Expect: 100-continue response
  14339. if (expect_100_continue) {
  14340. if (res.status == StatusCode::Continue_100) {
  14341. // Server accepted, send the body
  14342. if (!write_request_body(strm, req, error)) { return false; }
  14343. // Read the actual response
  14344. res.headers.clear();
  14345. res.body.clear();
  14346. if (!read_response_line(strm, req, res) ||
  14347. !detail::read_headers(strm, res.headers)) {
  14348. error = Error::Read;
  14349. output_error_log(error, &req);
  14350. return false;
  14351. }
  14352. } else {
  14353. // A final response came first, so the body this request declared was
  14354. // never sent, and the server may still be waiting for it. The
  14355. // connection cannot carry another request.
  14356. std::lock_guard<std::mutex> guard(socket_mutex_);
  14357. socket_should_be_closed_when_request_is_done_ = true;
  14358. }
  14359. }
  14360. // Body
  14361. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14362. req.method != "CONNECT") {
  14363. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14364. // whose final transfer coding is not chunked is not ambiguous: its body
  14365. // runs until the server closes the connection, so it is not rejected.
  14366. // HEAD/204 are excluded above and a 304 carries no body.
  14367. if (res.status != StatusCode::NotModified_304) {
  14368. if (detail::has_conflicting_content_length(res.headers)) {
  14369. error = Error::Read;
  14370. output_error_log(error, &req);
  14371. return false;
  14372. }
  14373. if (detail::has_faulty_transfer_encoding(res)) {
  14374. std::lock_guard<std::mutex> guard(socket_mutex_);
  14375. socket_should_be_closed_when_request_is_done_ = true;
  14376. }
  14377. }
  14378. auto redirect = 300 < res.status && res.status < 400 &&
  14379. res.status != StatusCode::NotModified_304 &&
  14380. follow_location_;
  14381. if (req.response_handler && !redirect) {
  14382. if (!req.response_handler(res)) {
  14383. error = Error::Canceled;
  14384. output_error_log(error, &req);
  14385. return false;
  14386. }
  14387. }
  14388. auto out =
  14389. req.content_receiver
  14390. ? static_cast<ContentReceiverWithProgress>(
  14391. [&](const char *buf, size_t n, size_t off, size_t len) {
  14392. if (redirect) { return true; }
  14393. auto ret = req.content_receiver(buf, n, off, len);
  14394. if (!ret) {
  14395. error = Error::Canceled;
  14396. output_error_log(error, &req);
  14397. }
  14398. return ret;
  14399. })
  14400. : static_cast<ContentReceiverWithProgress>(
  14401. [&](const char *buf, size_t n, size_t /*off*/,
  14402. size_t /*len*/) {
  14403. assert(res.body.size() + n <= res.body.max_size());
  14404. if (payload_max_length_ > 0 &&
  14405. (res.body.size() >= payload_max_length_ ||
  14406. n > payload_max_length_ - res.body.size())) {
  14407. return false;
  14408. }
  14409. res.body.append(buf, n);
  14410. return true;
  14411. });
  14412. auto progress = [&](size_t current, size_t total) {
  14413. if (!req.download_progress || redirect) { return true; }
  14414. auto ret = req.download_progress(current, total);
  14415. if (!ret) {
  14416. error = Error::Canceled;
  14417. output_error_log(error, &req);
  14418. }
  14419. return ret;
  14420. };
  14421. if (res.has_header("Content-Length")) {
  14422. if (!req.content_receiver) {
  14423. auto len = res.get_header_value_u64("Content-Length");
  14424. if (len > res.body.max_size()) {
  14425. error = Error::Read;
  14426. output_error_log(error, &req);
  14427. return false;
  14428. }
  14429. // Content-Length is only the server's claim, so reserve no more than
  14430. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14431. // body has arrived. A longer body grows as it is read.
  14432. auto reserve_len =
  14433. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14434. if (payload_max_length_ > 0) {
  14435. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14436. }
  14437. res.body.reserve(reserve_len);
  14438. }
  14439. }
  14440. if (res.status != StatusCode::NotModified_304) {
  14441. auto content_status = 0;
  14442. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14443. ? (std::numeric_limits<size_t>::max)()
  14444. : payload_max_length_;
  14445. if (!detail::read_content(strm, res, max_length, content_status,
  14446. std::move(progress), std::move(out),
  14447. decompress_)) {
  14448. if (error != Error::Canceled) {
  14449. // Tell the caller apart from a plain read failure when the body could
  14450. // not be decoded because of its Content-Encoding.
  14451. switch (content_status) {
  14452. case StatusCode::UnsupportedMediaType_415:
  14453. error = Error::UnsupportedContentEncoding;
  14454. break;
  14455. case StatusCode::InternalServerError_500:
  14456. error = Error::Compression;
  14457. break;
  14458. default: error = Error::Read; break;
  14459. }
  14460. }
  14461. output_error_log(error, &req);
  14462. return false;
  14463. }
  14464. }
  14465. }
  14466. // Log
  14467. output_log(req, res);
  14468. return true;
  14469. }
  14470. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14471. const std::string &boundary, const UploadFormDataItems &items,
  14472. const FormDataProviderItems &provider_items) const {
  14473. size_t cur_item = 0;
  14474. size_t cur_start = 0;
  14475. // cur_item and cur_start are copied to within the std::function and
  14476. // maintain state between successive calls
  14477. return [&, cur_item, cur_start](size_t offset,
  14478. DataSink &sink) mutable -> bool {
  14479. if (!offset && !items.empty()) {
  14480. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14481. return true;
  14482. } else if (cur_item < provider_items.size()) {
  14483. if (!cur_start) {
  14484. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14485. provider_items[cur_item], boundary);
  14486. offset += begin.size();
  14487. cur_start = offset;
  14488. sink.os << begin;
  14489. }
  14490. DataSink cur_sink;
  14491. auto has_data = true;
  14492. cur_sink.write = sink.write;
  14493. // Forward is_writable so a provider item asking whether it may keep
  14494. // going gets the outer sink's answer rather than the default `true`.
  14495. cur_sink.is_writable = sink.is_writable;
  14496. cur_sink.done = [&]() { has_data = false; };
  14497. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14498. return false;
  14499. }
  14500. if (!has_data) {
  14501. sink.os << detail::serialize_multipart_formdata_item_end();
  14502. cur_item++;
  14503. cur_start = 0;
  14504. }
  14505. return true;
  14506. } else {
  14507. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14508. sink.done();
  14509. return true;
  14510. }
  14511. };
  14512. }
  14513. inline bool ClientImpl::process_socket(
  14514. const Socket &socket,
  14515. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14516. std::function<bool(Stream &strm)> callback) {
  14517. return detail::process_client_socket(
  14518. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14519. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14520. }
  14521. inline bool ClientImpl::is_ssl() const { return false; }
  14522. inline Result ClientImpl::Get(const std::string &path,
  14523. DownloadProgress progress) {
  14524. return Get(path, Headers(), std::move(progress));
  14525. }
  14526. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14527. DownloadProgress progress) {
  14528. return Get(path, params, Headers(), std::move(progress));
  14529. }
  14530. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14531. const Headers &headers,
  14532. DownloadProgress progress) {
  14533. if (params.empty()) { return Get(path, headers); }
  14534. std::string path_with_query = append_query_params(path, params);
  14535. return Get(path_with_query, headers, std::move(progress));
  14536. }
  14537. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14538. DownloadProgress progress) {
  14539. Request req;
  14540. req.method = "GET";
  14541. req.path = path;
  14542. req.headers = headers;
  14543. req.download_progress = std::move(progress);
  14544. if (max_timeout_msec_ > 0) {
  14545. req.start_time_ = std::chrono::steady_clock::now();
  14546. }
  14547. return send_(std::move(req));
  14548. }
  14549. inline Result ClientImpl::Get(const std::string &path,
  14550. ContentReceiver content_receiver,
  14551. DownloadProgress progress) {
  14552. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14553. std::move(progress));
  14554. }
  14555. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14556. ContentReceiver content_receiver,
  14557. DownloadProgress progress) {
  14558. return Get(path, headers, nullptr, std::move(content_receiver),
  14559. std::move(progress));
  14560. }
  14561. inline Result ClientImpl::Get(const std::string &path,
  14562. ResponseHandler response_handler,
  14563. ContentReceiver content_receiver,
  14564. DownloadProgress progress) {
  14565. return Get(path, Headers(), std::move(response_handler),
  14566. std::move(content_receiver), std::move(progress));
  14567. }
  14568. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14569. ResponseHandler response_handler,
  14570. ContentReceiver content_receiver,
  14571. DownloadProgress progress) {
  14572. Request req;
  14573. req.method = "GET";
  14574. req.path = path;
  14575. req.headers = headers;
  14576. req.response_handler = std::move(response_handler);
  14577. req.content_receiver =
  14578. [content_receiver](const char *data, size_t data_length,
  14579. size_t /*offset*/, size_t /*total_length*/) {
  14580. return content_receiver(data, data_length);
  14581. };
  14582. req.download_progress = std::move(progress);
  14583. if (max_timeout_msec_ > 0) {
  14584. req.start_time_ = std::chrono::steady_clock::now();
  14585. }
  14586. return send_(std::move(req));
  14587. }
  14588. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14589. const Headers &headers,
  14590. ContentReceiver content_receiver,
  14591. DownloadProgress progress) {
  14592. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14593. std::move(progress));
  14594. }
  14595. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14596. const Headers &headers,
  14597. ResponseHandler response_handler,
  14598. ContentReceiver content_receiver,
  14599. DownloadProgress progress) {
  14600. if (params.empty()) {
  14601. return Get(path, headers, std::move(response_handler),
  14602. std::move(content_receiver), std::move(progress));
  14603. }
  14604. std::string path_with_query = append_query_params(path, params);
  14605. return Get(path_with_query, headers, std::move(response_handler),
  14606. std::move(content_receiver), std::move(progress));
  14607. }
  14608. inline Result ClientImpl::Head(const std::string &path) {
  14609. return Head(path, Headers());
  14610. }
  14611. inline Result ClientImpl::Head(const std::string &path,
  14612. const Headers &headers) {
  14613. Request req;
  14614. req.method = "HEAD";
  14615. req.headers = headers;
  14616. req.path = path;
  14617. if (max_timeout_msec_ > 0) {
  14618. req.start_time_ = std::chrono::steady_clock::now();
  14619. }
  14620. return send_(std::move(req));
  14621. }
  14622. inline Result ClientImpl::Post(const std::string &path) {
  14623. return Post(path, std::string(), std::string());
  14624. }
  14625. inline Result ClientImpl::Post(const std::string &path,
  14626. const Headers &headers) {
  14627. return Post(path, headers, nullptr, 0, std::string());
  14628. }
  14629. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14630. size_t content_length,
  14631. const std::string &content_type,
  14632. UploadProgress progress) {
  14633. return Post(path, Headers(), body, content_length, content_type, progress);
  14634. }
  14635. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14636. const std::string &content_type,
  14637. UploadProgress progress) {
  14638. return Post(path, Headers(), body, content_type, progress);
  14639. }
  14640. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14641. return Post(path, Headers(), params);
  14642. }
  14643. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14644. ContentProvider content_provider,
  14645. const std::string &content_type,
  14646. UploadProgress progress) {
  14647. return Post(path, Headers(), content_length, std::move(content_provider),
  14648. content_type, progress);
  14649. }
  14650. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14651. ContentProvider content_provider,
  14652. const std::string &content_type,
  14653. ContentReceiver content_receiver,
  14654. UploadProgress progress) {
  14655. return Post(path, Headers(), content_length, std::move(content_provider),
  14656. content_type, std::move(content_receiver), progress);
  14657. }
  14658. inline Result ClientImpl::Post(const std::string &path,
  14659. ContentProviderWithoutLength content_provider,
  14660. const std::string &content_type,
  14661. UploadProgress progress) {
  14662. return Post(path, Headers(), std::move(content_provider), content_type,
  14663. progress);
  14664. }
  14665. inline Result ClientImpl::Post(const std::string &path,
  14666. ContentProviderWithoutLength content_provider,
  14667. const std::string &content_type,
  14668. ContentReceiver content_receiver,
  14669. UploadProgress progress) {
  14670. return Post(path, Headers(), std::move(content_provider), content_type,
  14671. std::move(content_receiver), progress);
  14672. }
  14673. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14674. const Params &params) {
  14675. auto query = detail::params_to_query_str(params);
  14676. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14677. }
  14678. inline Result ClientImpl::Post(const std::string &path,
  14679. const UploadFormDataItems &items,
  14680. UploadProgress progress) {
  14681. return Post(path, Headers(), items, progress);
  14682. }
  14683. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14684. const UploadFormDataItems &items,
  14685. UploadProgress progress) {
  14686. const auto &boundary = detail::make_multipart_data_boundary();
  14687. const auto &content_type =
  14688. detail::serialize_multipart_formdata_get_content_type(boundary);
  14689. auto content_length = detail::get_multipart_content_length(items, boundary);
  14690. return Post(path, headers, content_length,
  14691. detail::make_multipart_content_provider(items, boundary),
  14692. content_type, progress);
  14693. }
  14694. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14695. const UploadFormDataItems &items,
  14696. const std::string &boundary,
  14697. UploadProgress progress) {
  14698. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14699. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14700. }
  14701. const auto &content_type =
  14702. detail::serialize_multipart_formdata_get_content_type(boundary);
  14703. auto content_length = detail::get_multipart_content_length(items, boundary);
  14704. return Post(path, headers, content_length,
  14705. detail::make_multipart_content_provider(items, boundary),
  14706. content_type, progress);
  14707. }
  14708. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14709. const char *body, size_t content_length,
  14710. const std::string &content_type,
  14711. UploadProgress progress) {
  14712. return send_with_content_provider_and_receiver(
  14713. "POST", path, headers, body, content_length, nullptr, nullptr,
  14714. content_type, nullptr, progress);
  14715. }
  14716. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14717. const std::string &body,
  14718. const std::string &content_type,
  14719. UploadProgress progress) {
  14720. return send_with_content_provider_and_receiver(
  14721. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14722. content_type, nullptr, progress);
  14723. }
  14724. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14725. size_t content_length,
  14726. ContentProvider content_provider,
  14727. const std::string &content_type,
  14728. UploadProgress progress) {
  14729. return send_with_content_provider_and_receiver(
  14730. "POST", path, headers, nullptr, content_length,
  14731. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14732. }
  14733. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14734. size_t content_length,
  14735. ContentProvider content_provider,
  14736. const std::string &content_type,
  14737. ContentReceiver content_receiver,
  14738. DownloadProgress progress) {
  14739. return send_with_content_provider_and_receiver(
  14740. "POST", path, headers, nullptr, content_length,
  14741. std::move(content_provider), nullptr, content_type,
  14742. std::move(content_receiver), std::move(progress));
  14743. }
  14744. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14745. ContentProviderWithoutLength content_provider,
  14746. const std::string &content_type,
  14747. UploadProgress progress) {
  14748. return send_with_content_provider_and_receiver(
  14749. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14750. content_type, nullptr, progress);
  14751. }
  14752. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14753. ContentProviderWithoutLength content_provider,
  14754. const std::string &content_type,
  14755. ContentReceiver content_receiver,
  14756. DownloadProgress progress) {
  14757. return send_with_content_provider_and_receiver(
  14758. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14759. content_type, std::move(content_receiver), std::move(progress));
  14760. }
  14761. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14762. const UploadFormDataItems &items,
  14763. const FormDataProviderItems &provider_items,
  14764. UploadProgress progress) {
  14765. const auto &boundary = detail::make_multipart_data_boundary();
  14766. const auto &content_type =
  14767. detail::serialize_multipart_formdata_get_content_type(boundary);
  14768. return send_with_content_provider_and_receiver(
  14769. "POST", path, headers, nullptr, 0, nullptr,
  14770. get_multipart_content_provider(boundary, items, provider_items),
  14771. content_type, nullptr, progress);
  14772. }
  14773. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14774. const std::string &body,
  14775. const std::string &content_type,
  14776. ContentReceiver content_receiver,
  14777. DownloadProgress progress) {
  14778. Request req;
  14779. req.method = "POST";
  14780. req.path = path;
  14781. req.headers = headers;
  14782. req.body = body;
  14783. req.content_receiver =
  14784. [content_receiver](const char *data, size_t data_length,
  14785. size_t /*offset*/, size_t /*total_length*/) {
  14786. return content_receiver(data, data_length);
  14787. };
  14788. req.download_progress = std::move(progress);
  14789. if (max_timeout_msec_ > 0) {
  14790. req.start_time_ = std::chrono::steady_clock::now();
  14791. }
  14792. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14793. return send_(std::move(req));
  14794. }
  14795. inline Result ClientImpl::Put(const std::string &path) {
  14796. return Put(path, std::string(), std::string());
  14797. }
  14798. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14799. return Put(path, headers, nullptr, 0, std::string());
  14800. }
  14801. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14802. size_t content_length,
  14803. const std::string &content_type,
  14804. UploadProgress progress) {
  14805. return Put(path, Headers(), body, content_length, content_type, progress);
  14806. }
  14807. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14808. const std::string &content_type,
  14809. UploadProgress progress) {
  14810. return Put(path, Headers(), body, content_type, progress);
  14811. }
  14812. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14813. return Put(path, Headers(), params);
  14814. }
  14815. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14816. ContentProvider content_provider,
  14817. const std::string &content_type,
  14818. UploadProgress progress) {
  14819. return Put(path, Headers(), content_length, std::move(content_provider),
  14820. content_type, progress);
  14821. }
  14822. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14823. ContentProvider content_provider,
  14824. const std::string &content_type,
  14825. ContentReceiver content_receiver,
  14826. UploadProgress progress) {
  14827. return Put(path, Headers(), content_length, std::move(content_provider),
  14828. content_type, std::move(content_receiver), progress);
  14829. }
  14830. inline Result ClientImpl::Put(const std::string &path,
  14831. ContentProviderWithoutLength content_provider,
  14832. const std::string &content_type,
  14833. UploadProgress progress) {
  14834. return Put(path, Headers(), std::move(content_provider), content_type,
  14835. progress);
  14836. }
  14837. inline Result ClientImpl::Put(const std::string &path,
  14838. ContentProviderWithoutLength content_provider,
  14839. const std::string &content_type,
  14840. ContentReceiver content_receiver,
  14841. UploadProgress progress) {
  14842. return Put(path, Headers(), std::move(content_provider), content_type,
  14843. std::move(content_receiver), progress);
  14844. }
  14845. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14846. const Params &params) {
  14847. auto query = detail::params_to_query_str(params);
  14848. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14849. }
  14850. inline Result ClientImpl::Put(const std::string &path,
  14851. const UploadFormDataItems &items,
  14852. UploadProgress progress) {
  14853. return Put(path, Headers(), items, progress);
  14854. }
  14855. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14856. const UploadFormDataItems &items,
  14857. UploadProgress progress) {
  14858. const auto &boundary = detail::make_multipart_data_boundary();
  14859. const auto &content_type =
  14860. detail::serialize_multipart_formdata_get_content_type(boundary);
  14861. auto content_length = detail::get_multipart_content_length(items, boundary);
  14862. return Put(path, headers, content_length,
  14863. detail::make_multipart_content_provider(items, boundary),
  14864. content_type, progress);
  14865. }
  14866. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14867. const UploadFormDataItems &items,
  14868. const std::string &boundary,
  14869. UploadProgress progress) {
  14870. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14871. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14872. }
  14873. const auto &content_type =
  14874. detail::serialize_multipart_formdata_get_content_type(boundary);
  14875. auto content_length = detail::get_multipart_content_length(items, boundary);
  14876. return Put(path, headers, content_length,
  14877. detail::make_multipart_content_provider(items, boundary),
  14878. content_type, progress);
  14879. }
  14880. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14881. const char *body, size_t content_length,
  14882. const std::string &content_type,
  14883. UploadProgress progress) {
  14884. return send_with_content_provider_and_receiver(
  14885. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14886. content_type, nullptr, progress);
  14887. }
  14888. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14889. const std::string &body,
  14890. const std::string &content_type,
  14891. UploadProgress progress) {
  14892. return send_with_content_provider_and_receiver(
  14893. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14894. content_type, nullptr, progress);
  14895. }
  14896. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14897. size_t content_length,
  14898. ContentProvider content_provider,
  14899. const std::string &content_type,
  14900. UploadProgress progress) {
  14901. return send_with_content_provider_and_receiver(
  14902. "PUT", path, headers, nullptr, content_length,
  14903. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14904. }
  14905. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14906. size_t content_length,
  14907. ContentProvider content_provider,
  14908. const std::string &content_type,
  14909. ContentReceiver content_receiver,
  14910. UploadProgress progress) {
  14911. return send_with_content_provider_and_receiver(
  14912. "PUT", path, headers, nullptr, content_length,
  14913. std::move(content_provider), nullptr, content_type,
  14914. std::move(content_receiver), progress);
  14915. }
  14916. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14917. ContentProviderWithoutLength content_provider,
  14918. const std::string &content_type,
  14919. UploadProgress progress) {
  14920. return send_with_content_provider_and_receiver(
  14921. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14922. content_type, nullptr, progress);
  14923. }
  14924. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14925. ContentProviderWithoutLength content_provider,
  14926. const std::string &content_type,
  14927. ContentReceiver content_receiver,
  14928. UploadProgress progress) {
  14929. return send_with_content_provider_and_receiver(
  14930. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14931. content_type, std::move(content_receiver), progress);
  14932. }
  14933. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14934. const UploadFormDataItems &items,
  14935. const FormDataProviderItems &provider_items,
  14936. UploadProgress progress) {
  14937. const auto &boundary = detail::make_multipart_data_boundary();
  14938. const auto &content_type =
  14939. detail::serialize_multipart_formdata_get_content_type(boundary);
  14940. return send_with_content_provider_and_receiver(
  14941. "PUT", path, headers, nullptr, 0, nullptr,
  14942. get_multipart_content_provider(boundary, items, provider_items),
  14943. content_type, nullptr, progress);
  14944. }
  14945. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14946. const std::string &body,
  14947. const std::string &content_type,
  14948. ContentReceiver content_receiver,
  14949. DownloadProgress progress) {
  14950. Request req;
  14951. req.method = "PUT";
  14952. req.path = path;
  14953. req.headers = headers;
  14954. req.body = body;
  14955. req.content_receiver =
  14956. [content_receiver](const char *data, size_t data_length,
  14957. size_t /*offset*/, size_t /*total_length*/) {
  14958. return content_receiver(data, data_length);
  14959. };
  14960. req.download_progress = std::move(progress);
  14961. if (max_timeout_msec_ > 0) {
  14962. req.start_time_ = std::chrono::steady_clock::now();
  14963. }
  14964. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14965. return send_(std::move(req));
  14966. }
  14967. inline Result ClientImpl::Patch(const std::string &path) {
  14968. return Patch(path, std::string(), std::string());
  14969. }
  14970. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14971. UploadProgress progress) {
  14972. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14973. }
  14974. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14975. size_t content_length,
  14976. const std::string &content_type,
  14977. UploadProgress progress) {
  14978. return Patch(path, Headers(), body, content_length, content_type, progress);
  14979. }
  14980. inline Result ClientImpl::Patch(const std::string &path,
  14981. const std::string &body,
  14982. const std::string &content_type,
  14983. UploadProgress progress) {
  14984. return Patch(path, Headers(), body, content_type, progress);
  14985. }
  14986. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14987. return Patch(path, Headers(), params);
  14988. }
  14989. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14990. ContentProvider content_provider,
  14991. const std::string &content_type,
  14992. UploadProgress progress) {
  14993. return Patch(path, Headers(), content_length, std::move(content_provider),
  14994. content_type, progress);
  14995. }
  14996. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14997. ContentProvider content_provider,
  14998. const std::string &content_type,
  14999. ContentReceiver content_receiver,
  15000. UploadProgress progress) {
  15001. return Patch(path, Headers(), content_length, std::move(content_provider),
  15002. content_type, std::move(content_receiver), progress);
  15003. }
  15004. inline Result ClientImpl::Patch(const std::string &path,
  15005. ContentProviderWithoutLength content_provider,
  15006. const std::string &content_type,
  15007. UploadProgress progress) {
  15008. return Patch(path, Headers(), std::move(content_provider), content_type,
  15009. progress);
  15010. }
  15011. inline Result ClientImpl::Patch(const std::string &path,
  15012. ContentProviderWithoutLength content_provider,
  15013. const std::string &content_type,
  15014. ContentReceiver content_receiver,
  15015. UploadProgress progress) {
  15016. return Patch(path, Headers(), std::move(content_provider), content_type,
  15017. std::move(content_receiver), progress);
  15018. }
  15019. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15020. const Params &params) {
  15021. auto query = detail::params_to_query_str(params);
  15022. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15023. }
  15024. inline Result ClientImpl::Patch(const std::string &path,
  15025. const UploadFormDataItems &items,
  15026. UploadProgress progress) {
  15027. return Patch(path, Headers(), items, progress);
  15028. }
  15029. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15030. const UploadFormDataItems &items,
  15031. UploadProgress progress) {
  15032. const auto &boundary = detail::make_multipart_data_boundary();
  15033. const auto &content_type =
  15034. detail::serialize_multipart_formdata_get_content_type(boundary);
  15035. auto content_length = detail::get_multipart_content_length(items, boundary);
  15036. return Patch(path, headers, content_length,
  15037. detail::make_multipart_content_provider(items, boundary),
  15038. content_type, progress);
  15039. }
  15040. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15041. const UploadFormDataItems &items,
  15042. const std::string &boundary,
  15043. UploadProgress progress) {
  15044. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15045. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15046. }
  15047. const auto &content_type =
  15048. detail::serialize_multipart_formdata_get_content_type(boundary);
  15049. auto content_length = detail::get_multipart_content_length(items, boundary);
  15050. return Patch(path, headers, content_length,
  15051. detail::make_multipart_content_provider(items, boundary),
  15052. content_type, progress);
  15053. }
  15054. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15055. const char *body, size_t content_length,
  15056. const std::string &content_type,
  15057. UploadProgress progress) {
  15058. return send_with_content_provider_and_receiver(
  15059. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15060. content_type, nullptr, progress);
  15061. }
  15062. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15063. const std::string &body,
  15064. const std::string &content_type,
  15065. UploadProgress progress) {
  15066. return send_with_content_provider_and_receiver(
  15067. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15068. content_type, nullptr, progress);
  15069. }
  15070. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15071. size_t content_length,
  15072. ContentProvider content_provider,
  15073. const std::string &content_type,
  15074. UploadProgress progress) {
  15075. return send_with_content_provider_and_receiver(
  15076. "PATCH", path, headers, nullptr, content_length,
  15077. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15078. }
  15079. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15080. size_t content_length,
  15081. ContentProvider content_provider,
  15082. const std::string &content_type,
  15083. ContentReceiver content_receiver,
  15084. UploadProgress progress) {
  15085. return send_with_content_provider_and_receiver(
  15086. "PATCH", path, headers, nullptr, content_length,
  15087. std::move(content_provider), nullptr, content_type,
  15088. std::move(content_receiver), progress);
  15089. }
  15090. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15091. ContentProviderWithoutLength content_provider,
  15092. const std::string &content_type,
  15093. UploadProgress progress) {
  15094. return send_with_content_provider_and_receiver(
  15095. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15096. content_type, nullptr, progress);
  15097. }
  15098. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15099. ContentProviderWithoutLength content_provider,
  15100. const std::string &content_type,
  15101. ContentReceiver content_receiver,
  15102. UploadProgress progress) {
  15103. return send_with_content_provider_and_receiver(
  15104. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15105. content_type, std::move(content_receiver), progress);
  15106. }
  15107. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15108. const UploadFormDataItems &items,
  15109. const FormDataProviderItems &provider_items,
  15110. UploadProgress progress) {
  15111. const auto &boundary = detail::make_multipart_data_boundary();
  15112. const auto &content_type =
  15113. detail::serialize_multipart_formdata_get_content_type(boundary);
  15114. return send_with_content_provider_and_receiver(
  15115. "PATCH", path, headers, nullptr, 0, nullptr,
  15116. get_multipart_content_provider(boundary, items, provider_items),
  15117. content_type, nullptr, progress);
  15118. }
  15119. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15120. const std::string &body,
  15121. const std::string &content_type,
  15122. ContentReceiver content_receiver,
  15123. DownloadProgress progress) {
  15124. Request req;
  15125. req.method = "PATCH";
  15126. req.path = path;
  15127. req.headers = headers;
  15128. req.body = body;
  15129. req.content_receiver =
  15130. [content_receiver](const char *data, size_t data_length,
  15131. size_t /*offset*/, size_t /*total_length*/) {
  15132. return content_receiver(data, data_length);
  15133. };
  15134. req.download_progress = std::move(progress);
  15135. if (max_timeout_msec_ > 0) {
  15136. req.start_time_ = std::chrono::steady_clock::now();
  15137. }
  15138. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15139. return send_(std::move(req));
  15140. }
  15141. inline Result ClientImpl::Delete(const std::string &path,
  15142. DownloadProgress progress) {
  15143. return Delete(path, Headers(), std::string(), std::string(), progress);
  15144. }
  15145. inline Result ClientImpl::Delete(const std::string &path,
  15146. const Headers &headers,
  15147. DownloadProgress progress) {
  15148. return Delete(path, headers, std::string(), std::string(), progress);
  15149. }
  15150. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15151. size_t content_length,
  15152. const std::string &content_type,
  15153. DownloadProgress progress) {
  15154. return Delete(path, Headers(), body, content_length, content_type, progress);
  15155. }
  15156. inline Result ClientImpl::Delete(const std::string &path,
  15157. const std::string &body,
  15158. const std::string &content_type,
  15159. DownloadProgress progress) {
  15160. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15161. progress);
  15162. }
  15163. inline Result ClientImpl::Delete(const std::string &path,
  15164. const Headers &headers,
  15165. const std::string &body,
  15166. const std::string &content_type,
  15167. DownloadProgress progress) {
  15168. return Delete(path, headers, body.data(), body.size(), content_type,
  15169. progress);
  15170. }
  15171. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15172. DownloadProgress progress) {
  15173. return Delete(path, Headers(), params, progress);
  15174. }
  15175. inline Result ClientImpl::Delete(const std::string &path,
  15176. const Headers &headers, const Params &params,
  15177. DownloadProgress progress) {
  15178. auto query = detail::params_to_query_str(params);
  15179. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15180. progress);
  15181. }
  15182. inline Result ClientImpl::Delete(const std::string &path,
  15183. const Headers &headers, const char *body,
  15184. size_t content_length,
  15185. const std::string &content_type,
  15186. DownloadProgress progress) {
  15187. Request req;
  15188. req.method = "DELETE";
  15189. req.headers = headers;
  15190. req.path = path;
  15191. req.download_progress = std::move(progress);
  15192. if (max_timeout_msec_ > 0) {
  15193. req.start_time_ = std::chrono::steady_clock::now();
  15194. }
  15195. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15196. req.body.assign(body, content_length);
  15197. return send_(std::move(req));
  15198. }
  15199. inline Result ClientImpl::Options(const std::string &path) {
  15200. return Options(path, Headers());
  15201. }
  15202. inline Result ClientImpl::Options(const std::string &path,
  15203. const Headers &headers) {
  15204. Request req;
  15205. req.method = "OPTIONS";
  15206. req.headers = headers;
  15207. req.path = path;
  15208. if (max_timeout_msec_ > 0) {
  15209. req.start_time_ = std::chrono::steady_clock::now();
  15210. }
  15211. return send_(std::move(req));
  15212. }
  15213. inline void ClientImpl::stop() {
  15214. std::lock_guard<std::mutex> guard(socket_mutex_);
  15215. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15216. // do is to shutdown_socket, so that threads using this socket suddenly
  15217. // discover they can't read/write any more and error out. Everything else
  15218. // (closing the socket, shutting ssl down) is unsafe because these actions
  15219. // are not thread-safe.
  15220. if (socket_requests_in_flight_ > 0) {
  15221. shutdown_socket(socket_);
  15222. // Aside from that, we set a flag for the socket to be closed when we're
  15223. // done.
  15224. socket_should_be_closed_when_request_is_done_ = true;
  15225. return;
  15226. }
  15227. disconnect(/*gracefully=*/true);
  15228. }
  15229. inline std::string ClientImpl::host() const { return host_; }
  15230. inline int ClientImpl::port() const { return port_; }
  15231. inline size_t ClientImpl::is_socket_open() const {
  15232. std::lock_guard<std::mutex> guard(socket_mutex_);
  15233. return socket_.is_open();
  15234. }
  15235. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15236. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15237. connection_timeout_sec_ = sec;
  15238. connection_timeout_usec_ = usec;
  15239. }
  15240. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15241. read_timeout_sec_ = sec;
  15242. read_timeout_usec_ = usec;
  15243. }
  15244. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15245. write_timeout_sec_ = sec;
  15246. write_timeout_usec_ = usec;
  15247. }
  15248. inline void ClientImpl::set_max_timeout(time_t msec) {
  15249. max_timeout_msec_ = msec;
  15250. }
  15251. inline void ClientImpl::set_basic_auth(const std::string &username,
  15252. const std::string &password) {
  15253. basic_auth_username_ = username;
  15254. basic_auth_password_ = password;
  15255. }
  15256. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15257. bearer_token_auth_token_ = token;
  15258. }
  15259. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15260. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15261. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15262. inline void
  15263. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15264. addr_map_ = std::move(addr_map);
  15265. }
  15266. inline void ClientImpl::set_default_headers(Headers headers) {
  15267. default_headers_ = std::move(headers);
  15268. }
  15269. inline void ClientImpl::set_header_writer(
  15270. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15271. header_writer_ = writer;
  15272. }
  15273. inline void ClientImpl::set_address_family(int family) {
  15274. address_family_ = family;
  15275. }
  15276. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15277. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15278. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15279. socket_options_ = std::move(socket_options);
  15280. }
  15281. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15282. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15283. inline void ClientImpl::set_payload_max_length(size_t length) {
  15284. payload_max_length_ = length;
  15285. has_payload_max_length_ = true;
  15286. }
  15287. inline void ClientImpl::set_interface(const std::string &intf) {
  15288. interface_ = intf;
  15289. }
  15290. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15291. proxy_host_ = host;
  15292. proxy_port_ = port;
  15293. std::lock_guard<std::mutex> guard(socket_mutex_);
  15294. disconnect(/*gracefully=*/true);
  15295. }
  15296. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15297. const std::string &password) {
  15298. proxy_basic_auth_username_ = username;
  15299. proxy_basic_auth_password_ = password;
  15300. }
  15301. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15302. proxy_bearer_token_auth_token_ = token;
  15303. }
  15304. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15305. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15306. std::lock_guard<std::mutex> guard(socket_mutex_);
  15307. disconnect(/*gracefully=*/true);
  15308. }
  15309. #ifdef CPPHTTPLIB_SSL_ENABLED
  15310. inline void ClientImpl::set_digest_auth(const std::string &username,
  15311. const std::string &password) {
  15312. digest_auth_username_ = username;
  15313. digest_auth_password_ = password;
  15314. }
  15315. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15316. const std::string &ca_cert_dir_path) {
  15317. ca_cert_file_path_ = ca_cert_file_path;
  15318. ca_cert_dir_path_ = ca_cert_dir_path;
  15319. }
  15320. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15321. const std::string &password) {
  15322. proxy_digest_auth_username_ = username;
  15323. proxy_digest_auth_password_ = password;
  15324. }
  15325. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15326. server_certificate_verification_ = enabled;
  15327. }
  15328. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15329. server_hostname_verification_ = enabled;
  15330. }
  15331. inline void ClientImpl::enable_system_ca(bool enabled) {
  15332. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15333. }
  15334. #endif
  15335. inline void ClientImpl::set_logger(Logger logger) {
  15336. logger_ = std::move(logger);
  15337. }
  15338. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15339. error_logger_ = std::move(error_logger);
  15340. }
  15341. /*
  15342. * SSL/TLS Common Implementation
  15343. */
  15344. inline ClientConnection::~ClientConnection() {
  15345. #ifdef CPPHTTPLIB_SSL_ENABLED
  15346. if (session) {
  15347. tls::shutdown(session, true);
  15348. tls::free_session(session);
  15349. session = nullptr;
  15350. }
  15351. #endif
  15352. if (sock != INVALID_SOCKET) {
  15353. detail::close_socket(sock);
  15354. sock = INVALID_SOCKET;
  15355. }
  15356. }
  15357. // Universal client implementation
  15358. inline Client::Client(const std::string &scheme_host_port)
  15359. : Client(scheme_host_port, std::string(), std::string()) {}
  15360. inline Client::Client(const std::string &scheme_host_port,
  15361. const std::string &client_cert_path,
  15362. const std::string &client_key_path) {
  15363. detail::UrlComponents uc;
  15364. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15365. auto &scheme = uc.scheme;
  15366. #ifdef CPPHTTPLIB_SSL_ENABLED
  15367. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15368. #else
  15369. if (!scheme.empty() && scheme != "http") {
  15370. #endif
  15371. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15372. std::string msg = "'" + scheme + "' scheme is not supported.";
  15373. throw std::invalid_argument(msg);
  15374. #endif
  15375. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15376. return;
  15377. }
  15378. auto is_ssl = scheme == "https";
  15379. auto host = std::move(uc.host);
  15380. auto port = is_ssl ? 443 : 80;
  15381. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15382. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15383. return;
  15384. }
  15385. if (is_ssl) {
  15386. #ifdef CPPHTTPLIB_SSL_ENABLED
  15387. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15388. client_key_path);
  15389. is_ssl_ = is_ssl;
  15390. #endif
  15391. } else {
  15392. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15393. client_key_path);
  15394. }
  15395. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15396. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15397. // A URL, but not one this client can use, such as one with userinfo. A
  15398. // Unix socket path may have "//" further on.
  15399. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15400. } else {
  15401. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15402. // if port param below changes.
  15403. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15404. client_cert_path, client_key_path);
  15405. }
  15406. }
  15407. inline Client::Client(const std::string &host, int port)
  15408. : Client(host, port, std::string(), std::string()) {}
  15409. inline Client::Client(const std::string &host, int port,
  15410. const std::string &client_cert_path,
  15411. const std::string &client_key_path)
  15412. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15413. client_key_path)) {}
  15414. inline Client::~Client() = default;
  15415. inline bool Client::is_valid() const {
  15416. return cli_ != nullptr && cli_->is_valid();
  15417. }
  15418. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15419. return cli_->Get(path, std::move(progress));
  15420. }
  15421. inline Result Client::Get(const std::string &path, const Headers &headers,
  15422. DownloadProgress progress) {
  15423. return cli_->Get(path, headers, std::move(progress));
  15424. }
  15425. inline Result Client::Get(const std::string &path,
  15426. ContentReceiver content_receiver,
  15427. DownloadProgress progress) {
  15428. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15429. }
  15430. inline Result Client::Get(const std::string &path, const Headers &headers,
  15431. ContentReceiver content_receiver,
  15432. DownloadProgress progress) {
  15433. return cli_->Get(path, headers, std::move(content_receiver),
  15434. std::move(progress));
  15435. }
  15436. inline Result Client::Get(const std::string &path,
  15437. ResponseHandler response_handler,
  15438. ContentReceiver content_receiver,
  15439. DownloadProgress progress) {
  15440. return cli_->Get(path, std::move(response_handler),
  15441. std::move(content_receiver), std::move(progress));
  15442. }
  15443. inline Result Client::Get(const std::string &path, const Headers &headers,
  15444. ResponseHandler response_handler,
  15445. ContentReceiver content_receiver,
  15446. DownloadProgress progress) {
  15447. return cli_->Get(path, headers, std::move(response_handler),
  15448. std::move(content_receiver), std::move(progress));
  15449. }
  15450. inline Result Client::Get(const std::string &path, const Params &params,
  15451. DownloadProgress progress) {
  15452. return cli_->Get(path, params, std::move(progress));
  15453. }
  15454. inline Result Client::Get(const std::string &path, const Params &params,
  15455. const Headers &headers, DownloadProgress progress) {
  15456. return cli_->Get(path, params, headers, std::move(progress));
  15457. }
  15458. inline Result Client::Get(const std::string &path, const Params &params,
  15459. const Headers &headers,
  15460. ContentReceiver content_receiver,
  15461. DownloadProgress progress) {
  15462. return cli_->Get(path, params, headers, std::move(content_receiver),
  15463. std::move(progress));
  15464. }
  15465. inline Result Client::Get(const std::string &path, const Params &params,
  15466. const Headers &headers,
  15467. ResponseHandler response_handler,
  15468. ContentReceiver content_receiver,
  15469. DownloadProgress progress) {
  15470. return cli_->Get(path, params, headers, std::move(response_handler),
  15471. std::move(content_receiver), std::move(progress));
  15472. }
  15473. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15474. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15475. return cli_->Head(path, headers);
  15476. }
  15477. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15478. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15479. return cli_->Post(path, headers);
  15480. }
  15481. inline Result Client::Post(const std::string &path, const char *body,
  15482. size_t content_length,
  15483. const std::string &content_type,
  15484. UploadProgress progress) {
  15485. return cli_->Post(path, body, content_length, content_type, progress);
  15486. }
  15487. inline Result Client::Post(const std::string &path, const Headers &headers,
  15488. const char *body, size_t content_length,
  15489. const std::string &content_type,
  15490. UploadProgress progress) {
  15491. return cli_->Post(path, headers, body, content_length, content_type,
  15492. progress);
  15493. }
  15494. inline Result Client::Post(const std::string &path, const std::string &body,
  15495. const std::string &content_type,
  15496. UploadProgress progress) {
  15497. return cli_->Post(path, body, content_type, progress);
  15498. }
  15499. inline Result Client::Post(const std::string &path, const Headers &headers,
  15500. const std::string &body,
  15501. const std::string &content_type,
  15502. UploadProgress progress) {
  15503. return cli_->Post(path, headers, body, content_type, progress);
  15504. }
  15505. inline Result Client::Post(const std::string &path, size_t content_length,
  15506. ContentProvider content_provider,
  15507. const std::string &content_type,
  15508. UploadProgress progress) {
  15509. return cli_->Post(path, content_length, std::move(content_provider),
  15510. content_type, progress);
  15511. }
  15512. inline Result Client::Post(const std::string &path, size_t content_length,
  15513. ContentProvider content_provider,
  15514. const std::string &content_type,
  15515. ContentReceiver content_receiver,
  15516. UploadProgress progress) {
  15517. return cli_->Post(path, content_length, std::move(content_provider),
  15518. content_type, std::move(content_receiver), progress);
  15519. }
  15520. inline Result Client::Post(const std::string &path,
  15521. ContentProviderWithoutLength content_provider,
  15522. const std::string &content_type,
  15523. UploadProgress progress) {
  15524. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15525. }
  15526. inline Result Client::Post(const std::string &path,
  15527. ContentProviderWithoutLength content_provider,
  15528. const std::string &content_type,
  15529. ContentReceiver content_receiver,
  15530. UploadProgress progress) {
  15531. return cli_->Post(path, std::move(content_provider), content_type,
  15532. std::move(content_receiver), progress);
  15533. }
  15534. inline Result Client::Post(const std::string &path, const Headers &headers,
  15535. size_t content_length,
  15536. ContentProvider content_provider,
  15537. const std::string &content_type,
  15538. UploadProgress progress) {
  15539. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15540. content_type, progress);
  15541. }
  15542. inline Result Client::Post(const std::string &path, const Headers &headers,
  15543. size_t content_length,
  15544. ContentProvider content_provider,
  15545. const std::string &content_type,
  15546. ContentReceiver content_receiver,
  15547. DownloadProgress progress) {
  15548. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15549. content_type, std::move(content_receiver), progress);
  15550. }
  15551. inline Result Client::Post(const std::string &path, const Headers &headers,
  15552. ContentProviderWithoutLength content_provider,
  15553. const std::string &content_type,
  15554. UploadProgress progress) {
  15555. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15556. progress);
  15557. }
  15558. inline Result Client::Post(const std::string &path, const Headers &headers,
  15559. ContentProviderWithoutLength content_provider,
  15560. const std::string &content_type,
  15561. ContentReceiver content_receiver,
  15562. DownloadProgress progress) {
  15563. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15564. std::move(content_receiver), progress);
  15565. }
  15566. inline Result Client::Post(const std::string &path, const Params &params) {
  15567. return cli_->Post(path, params);
  15568. }
  15569. inline Result Client::Post(const std::string &path, const Headers &headers,
  15570. const Params &params) {
  15571. return cli_->Post(path, headers, params);
  15572. }
  15573. inline Result Client::Post(const std::string &path,
  15574. const UploadFormDataItems &items,
  15575. UploadProgress progress) {
  15576. return cli_->Post(path, items, progress);
  15577. }
  15578. inline Result Client::Post(const std::string &path, const Headers &headers,
  15579. const UploadFormDataItems &items,
  15580. UploadProgress progress) {
  15581. return cli_->Post(path, headers, items, progress);
  15582. }
  15583. inline Result Client::Post(const std::string &path, const Headers &headers,
  15584. const UploadFormDataItems &items,
  15585. const std::string &boundary,
  15586. UploadProgress progress) {
  15587. return cli_->Post(path, headers, items, boundary, progress);
  15588. }
  15589. inline Result Client::Post(const std::string &path, const Headers &headers,
  15590. const UploadFormDataItems &items,
  15591. const FormDataProviderItems &provider_items,
  15592. UploadProgress progress) {
  15593. return cli_->Post(path, headers, items, provider_items, progress);
  15594. }
  15595. inline Result Client::Post(const std::string &path, const Headers &headers,
  15596. const std::string &body,
  15597. const std::string &content_type,
  15598. ContentReceiver content_receiver,
  15599. DownloadProgress progress) {
  15600. return cli_->Post(path, headers, body, content_type,
  15601. std::move(content_receiver), progress);
  15602. }
  15603. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15604. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15605. return cli_->Put(path, headers);
  15606. }
  15607. inline Result Client::Put(const std::string &path, const char *body,
  15608. size_t content_length,
  15609. const std::string &content_type,
  15610. UploadProgress progress) {
  15611. return cli_->Put(path, body, content_length, content_type, progress);
  15612. }
  15613. inline Result Client::Put(const std::string &path, const Headers &headers,
  15614. const char *body, size_t content_length,
  15615. const std::string &content_type,
  15616. UploadProgress progress) {
  15617. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15618. }
  15619. inline Result Client::Put(const std::string &path, const std::string &body,
  15620. const std::string &content_type,
  15621. UploadProgress progress) {
  15622. return cli_->Put(path, body, content_type, progress);
  15623. }
  15624. inline Result Client::Put(const std::string &path, const Headers &headers,
  15625. const std::string &body,
  15626. const std::string &content_type,
  15627. UploadProgress progress) {
  15628. return cli_->Put(path, headers, body, content_type, progress);
  15629. }
  15630. inline Result Client::Put(const std::string &path, size_t content_length,
  15631. ContentProvider content_provider,
  15632. const std::string &content_type,
  15633. UploadProgress progress) {
  15634. return cli_->Put(path, content_length, std::move(content_provider),
  15635. content_type, progress);
  15636. }
  15637. inline Result Client::Put(const std::string &path, size_t content_length,
  15638. ContentProvider content_provider,
  15639. const std::string &content_type,
  15640. ContentReceiver content_receiver,
  15641. UploadProgress progress) {
  15642. return cli_->Put(path, content_length, std::move(content_provider),
  15643. content_type, std::move(content_receiver), progress);
  15644. }
  15645. inline Result Client::Put(const std::string &path,
  15646. ContentProviderWithoutLength content_provider,
  15647. const std::string &content_type,
  15648. UploadProgress progress) {
  15649. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15650. }
  15651. inline Result Client::Put(const std::string &path,
  15652. ContentProviderWithoutLength content_provider,
  15653. const std::string &content_type,
  15654. ContentReceiver content_receiver,
  15655. UploadProgress progress) {
  15656. return cli_->Put(path, std::move(content_provider), content_type,
  15657. std::move(content_receiver), progress);
  15658. }
  15659. inline Result Client::Put(const std::string &path, const Headers &headers,
  15660. size_t content_length,
  15661. ContentProvider content_provider,
  15662. const std::string &content_type,
  15663. UploadProgress progress) {
  15664. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15665. content_type, progress);
  15666. }
  15667. inline Result Client::Put(const std::string &path, const Headers &headers,
  15668. size_t content_length,
  15669. ContentProvider content_provider,
  15670. const std::string &content_type,
  15671. ContentReceiver content_receiver,
  15672. UploadProgress progress) {
  15673. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15674. content_type, std::move(content_receiver), progress);
  15675. }
  15676. inline Result Client::Put(const std::string &path, const Headers &headers,
  15677. ContentProviderWithoutLength content_provider,
  15678. const std::string &content_type,
  15679. UploadProgress progress) {
  15680. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15681. progress);
  15682. }
  15683. inline Result Client::Put(const std::string &path, const Headers &headers,
  15684. ContentProviderWithoutLength content_provider,
  15685. const std::string &content_type,
  15686. ContentReceiver content_receiver,
  15687. UploadProgress progress) {
  15688. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15689. std::move(content_receiver), progress);
  15690. }
  15691. inline Result Client::Put(const std::string &path, const Params &params) {
  15692. return cli_->Put(path, params);
  15693. }
  15694. inline Result Client::Put(const std::string &path, const Headers &headers,
  15695. const Params &params) {
  15696. return cli_->Put(path, headers, params);
  15697. }
  15698. inline Result Client::Put(const std::string &path,
  15699. const UploadFormDataItems &items,
  15700. UploadProgress progress) {
  15701. return cli_->Put(path, items, progress);
  15702. }
  15703. inline Result Client::Put(const std::string &path, const Headers &headers,
  15704. const UploadFormDataItems &items,
  15705. UploadProgress progress) {
  15706. return cli_->Put(path, headers, items, progress);
  15707. }
  15708. inline Result Client::Put(const std::string &path, const Headers &headers,
  15709. const UploadFormDataItems &items,
  15710. const std::string &boundary,
  15711. UploadProgress progress) {
  15712. return cli_->Put(path, headers, items, boundary, progress);
  15713. }
  15714. inline Result Client::Put(const std::string &path, const Headers &headers,
  15715. const UploadFormDataItems &items,
  15716. const FormDataProviderItems &provider_items,
  15717. UploadProgress progress) {
  15718. return cli_->Put(path, headers, items, provider_items, progress);
  15719. }
  15720. inline Result Client::Put(const std::string &path, const Headers &headers,
  15721. const std::string &body,
  15722. const std::string &content_type,
  15723. ContentReceiver content_receiver,
  15724. DownloadProgress progress) {
  15725. return cli_->Put(path, headers, body, content_type, content_receiver,
  15726. progress);
  15727. }
  15728. inline Result Client::Patch(const std::string &path) {
  15729. return cli_->Patch(path);
  15730. }
  15731. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15732. return cli_->Patch(path, headers);
  15733. }
  15734. inline Result Client::Patch(const std::string &path, const char *body,
  15735. size_t content_length,
  15736. const std::string &content_type,
  15737. UploadProgress progress) {
  15738. return cli_->Patch(path, body, content_length, content_type, progress);
  15739. }
  15740. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15741. const char *body, size_t content_length,
  15742. const std::string &content_type,
  15743. UploadProgress progress) {
  15744. return cli_->Patch(path, headers, body, content_length, content_type,
  15745. progress);
  15746. }
  15747. inline Result Client::Patch(const std::string &path, const std::string &body,
  15748. const std::string &content_type,
  15749. UploadProgress progress) {
  15750. return cli_->Patch(path, body, content_type, progress);
  15751. }
  15752. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15753. const std::string &body,
  15754. const std::string &content_type,
  15755. UploadProgress progress) {
  15756. return cli_->Patch(path, headers, body, content_type, progress);
  15757. }
  15758. inline Result Client::Patch(const std::string &path, size_t content_length,
  15759. ContentProvider content_provider,
  15760. const std::string &content_type,
  15761. UploadProgress progress) {
  15762. return cli_->Patch(path, content_length, std::move(content_provider),
  15763. content_type, progress);
  15764. }
  15765. inline Result Client::Patch(const std::string &path, size_t content_length,
  15766. ContentProvider content_provider,
  15767. const std::string &content_type,
  15768. ContentReceiver content_receiver,
  15769. UploadProgress progress) {
  15770. return cli_->Patch(path, content_length, std::move(content_provider),
  15771. content_type, std::move(content_receiver), progress);
  15772. }
  15773. inline Result Client::Patch(const std::string &path,
  15774. ContentProviderWithoutLength content_provider,
  15775. const std::string &content_type,
  15776. UploadProgress progress) {
  15777. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15778. }
  15779. inline Result Client::Patch(const std::string &path,
  15780. ContentProviderWithoutLength content_provider,
  15781. const std::string &content_type,
  15782. ContentReceiver content_receiver,
  15783. UploadProgress progress) {
  15784. return cli_->Patch(path, std::move(content_provider), content_type,
  15785. std::move(content_receiver), progress);
  15786. }
  15787. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15788. size_t content_length,
  15789. ContentProvider content_provider,
  15790. const std::string &content_type,
  15791. UploadProgress progress) {
  15792. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15793. content_type, progress);
  15794. }
  15795. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15796. size_t content_length,
  15797. ContentProvider content_provider,
  15798. const std::string &content_type,
  15799. ContentReceiver content_receiver,
  15800. UploadProgress progress) {
  15801. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15802. content_type, std::move(content_receiver), progress);
  15803. }
  15804. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15805. ContentProviderWithoutLength content_provider,
  15806. const std::string &content_type,
  15807. UploadProgress progress) {
  15808. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15809. progress);
  15810. }
  15811. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15812. ContentProviderWithoutLength content_provider,
  15813. const std::string &content_type,
  15814. ContentReceiver content_receiver,
  15815. UploadProgress progress) {
  15816. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15817. std::move(content_receiver), progress);
  15818. }
  15819. inline Result Client::Patch(const std::string &path, const Params &params) {
  15820. return cli_->Patch(path, params);
  15821. }
  15822. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15823. const Params &params) {
  15824. return cli_->Patch(path, headers, params);
  15825. }
  15826. inline Result Client::Patch(const std::string &path,
  15827. const UploadFormDataItems &items,
  15828. UploadProgress progress) {
  15829. return cli_->Patch(path, items, progress);
  15830. }
  15831. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15832. const UploadFormDataItems &items,
  15833. UploadProgress progress) {
  15834. return cli_->Patch(path, headers, items, progress);
  15835. }
  15836. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15837. const UploadFormDataItems &items,
  15838. const std::string &boundary,
  15839. UploadProgress progress) {
  15840. return cli_->Patch(path, headers, items, boundary, progress);
  15841. }
  15842. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15843. const UploadFormDataItems &items,
  15844. const FormDataProviderItems &provider_items,
  15845. UploadProgress progress) {
  15846. return cli_->Patch(path, headers, items, provider_items, progress);
  15847. }
  15848. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15849. const std::string &body,
  15850. const std::string &content_type,
  15851. ContentReceiver content_receiver,
  15852. DownloadProgress progress) {
  15853. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15854. progress);
  15855. }
  15856. inline Result Client::Delete(const std::string &path,
  15857. DownloadProgress progress) {
  15858. return cli_->Delete(path, progress);
  15859. }
  15860. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15861. DownloadProgress progress) {
  15862. return cli_->Delete(path, headers, progress);
  15863. }
  15864. inline Result Client::Delete(const std::string &path, const char *body,
  15865. size_t content_length,
  15866. const std::string &content_type,
  15867. DownloadProgress progress) {
  15868. return cli_->Delete(path, body, content_length, content_type, progress);
  15869. }
  15870. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15871. const char *body, size_t content_length,
  15872. const std::string &content_type,
  15873. DownloadProgress progress) {
  15874. return cli_->Delete(path, headers, body, content_length, content_type,
  15875. progress);
  15876. }
  15877. inline Result Client::Delete(const std::string &path, const std::string &body,
  15878. const std::string &content_type,
  15879. DownloadProgress progress) {
  15880. return cli_->Delete(path, body, content_type, progress);
  15881. }
  15882. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15883. const std::string &body,
  15884. const std::string &content_type,
  15885. DownloadProgress progress) {
  15886. return cli_->Delete(path, headers, body, content_type, progress);
  15887. }
  15888. inline Result Client::Delete(const std::string &path, const Params &params,
  15889. DownloadProgress progress) {
  15890. return cli_->Delete(path, params, progress);
  15891. }
  15892. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15893. const Params &params, DownloadProgress progress) {
  15894. return cli_->Delete(path, headers, params, progress);
  15895. }
  15896. inline Result Client::Options(const std::string &path) {
  15897. return cli_->Options(path);
  15898. }
  15899. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15900. return cli_->Options(path, headers);
  15901. }
  15902. inline ClientImpl::StreamHandle
  15903. Client::open_stream(const std::string &method, const std::string &path,
  15904. const Params &params, const Headers &headers,
  15905. const std::string &body, const std::string &content_type) {
  15906. return cli_->open_stream(method, path, params, headers, body, content_type);
  15907. }
  15908. inline bool Client::send(Request &req, Response &res, Error &error) {
  15909. return cli_->send(req, res, error);
  15910. }
  15911. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15912. inline void Client::stop() { cli_->stop(); }
  15913. inline std::string Client::host() const { return cli_->host(); }
  15914. inline int Client::port() const { return cli_->port(); }
  15915. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15916. inline socket_t Client::socket() const { return cli_->socket(); }
  15917. inline void
  15918. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15919. cli_->set_hostname_addr_map(std::move(addr_map));
  15920. }
  15921. inline void Client::set_default_headers(Headers headers) {
  15922. cli_->set_default_headers(std::move(headers));
  15923. }
  15924. inline void Client::set_header_writer(
  15925. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15926. cli_->set_header_writer(writer);
  15927. }
  15928. inline void Client::set_address_family(int family) {
  15929. cli_->set_address_family(family);
  15930. }
  15931. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15932. inline void Client::set_socket_options(SocketOptions socket_options) {
  15933. cli_->set_socket_options(std::move(socket_options));
  15934. }
  15935. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15936. cli_->set_connection_timeout(sec, usec);
  15937. }
  15938. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15939. cli_->set_read_timeout(sec, usec);
  15940. }
  15941. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15942. cli_->set_write_timeout(sec, usec);
  15943. }
  15944. inline void Client::set_basic_auth(const std::string &username,
  15945. const std::string &password) {
  15946. cli_->set_basic_auth(username, password);
  15947. }
  15948. inline void Client::set_bearer_token_auth(const std::string &token) {
  15949. cli_->set_bearer_token_auth(token);
  15950. }
  15951. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15952. inline void Client::set_follow_location(bool on) {
  15953. cli_->set_follow_location(on);
  15954. }
  15955. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15956. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15957. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15958. inline void Client::set_payload_max_length(size_t length) {
  15959. cli_->set_payload_max_length(length);
  15960. }
  15961. inline void Client::set_interface(const std::string &intf) {
  15962. cli_->set_interface(intf);
  15963. }
  15964. inline void Client::set_proxy(const std::string &host, int port) {
  15965. cli_->set_proxy(host, port);
  15966. }
  15967. inline void Client::set_proxy_basic_auth(const std::string &username,
  15968. const std::string &password) {
  15969. cli_->set_proxy_basic_auth(username, password);
  15970. }
  15971. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15972. cli_->set_proxy_bearer_token_auth(token);
  15973. }
  15974. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15975. cli_->set_no_proxy(patterns);
  15976. }
  15977. inline void Client::set_logger(Logger logger) {
  15978. cli_->set_logger(std::move(logger));
  15979. }
  15980. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15981. cli_->set_error_logger(std::move(error_logger));
  15982. }
  15983. /*
  15984. * Group 6: SSL Server and Client implementation
  15985. */
  15986. #ifdef CPPHTTPLIB_SSL_ENABLED
  15987. // SSL HTTP server implementation
  15988. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15989. const char *client_ca_cert_file_path,
  15990. const char *client_ca_cert_dir_path,
  15991. const char *private_key_password) {
  15992. using namespace tls;
  15993. ctx_ = create_server_context();
  15994. if (!ctx_) { return; }
  15995. // Load server certificate and private key
  15996. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15997. private_key_password)) {
  15998. last_ssl_error_ = static_cast<int>(get_error());
  15999. free_context(ctx_);
  16000. ctx_ = nullptr;
  16001. return;
  16002. }
  16003. // Load client CA certificates for client authentication
  16004. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16005. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16006. client_ca_cert_dir_path)) {
  16007. last_ssl_error_ = static_cast<int>(get_error());
  16008. free_context(ctx_);
  16009. ctx_ = nullptr;
  16010. return;
  16011. }
  16012. // Enable client certificate verification
  16013. set_verify_client(ctx_, true);
  16014. }
  16015. }
  16016. inline SSLServer::SSLServer(const PemMemory &pem) {
  16017. using namespace tls;
  16018. ctx_ = create_server_context();
  16019. if (ctx_) {
  16020. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  16021. pem.private_key_password)) {
  16022. last_ssl_error_ = static_cast<int>(get_error());
  16023. free_context(ctx_);
  16024. ctx_ = nullptr;
  16025. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  16026. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  16027. last_ssl_error_ = static_cast<int>(get_error());
  16028. free_context(ctx_);
  16029. ctx_ = nullptr;
  16030. } else {
  16031. set_verify_client(ctx_, true);
  16032. }
  16033. }
  16034. }
  16035. }
  16036. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16037. using namespace tls;
  16038. ctx_ = create_server_context();
  16039. if (ctx_) {
  16040. if (!setup_callback(ctx_)) {
  16041. free_context(ctx_);
  16042. ctx_ = nullptr;
  16043. }
  16044. }
  16045. }
  16046. inline SSLServer::~SSLServer() {
  16047. if (ctx_) { tls::free_context(ctx_); }
  16048. }
  16049. inline bool SSLServer::is_valid() const {
  16050. return ctx_ != nullptr && Server::is_valid();
  16051. }
  16052. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16053. using namespace tls;
  16054. session_t session = nullptr;
  16055. {
  16056. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16057. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16058. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16059. if (session) { handshakes_in_progress_++; }
  16060. }
  16061. if (!session) {
  16062. last_ssl_error_ = static_cast<int>(get_error());
  16063. detail::shutdown_socket(sock);
  16064. detail::close_socket(sock);
  16065. return false;
  16066. }
  16067. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16068. bool handshake_done = false;
  16069. bool ret = false;
  16070. bool websocket_upgraded = false;
  16071. auto cleanup = detail::scope_exit([&] {
  16072. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16073. free_session(session);
  16074. detail::shutdown_socket(sock);
  16075. detail::close_socket(sock);
  16076. });
  16077. // Perform TLS accept handshake with timeout
  16078. TlsError tls_err;
  16079. auto accepted = false;
  16080. {
  16081. auto handshake_left = detail::scope_exit([&] {
  16082. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16083. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16084. });
  16085. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16086. read_timeout_usec_, &tls_err);
  16087. }
  16088. if (!accepted) {
  16089. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16090. // Map TlsError to legacy ssl_error for backward compatibility
  16091. if (tls_err.code == ErrorCode::WantRead) {
  16092. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16093. } else if (tls_err.code == ErrorCode::WantWrite) {
  16094. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16095. } else {
  16096. last_ssl_error_ = SSL_ERROR_SSL;
  16097. }
  16098. #else
  16099. last_ssl_error_ = static_cast<int>(get_error());
  16100. #endif
  16101. return false;
  16102. }
  16103. handshake_done = true;
  16104. std::string remote_addr;
  16105. int remote_port = 0;
  16106. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16107. std::string local_addr;
  16108. int local_port = 0;
  16109. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16110. ret = serve_guarded([&]() {
  16111. return detail::process_server_socket_ssl(
  16112. svr_sock_, session, sock, keep_alive_max_count_,
  16113. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16114. write_timeout_sec_, write_timeout_usec_,
  16115. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16116. return process_request(
  16117. strm, remote_addr, remote_port, local_addr, local_port,
  16118. close_connection, connection_closed,
  16119. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16120. });
  16121. });
  16122. return ret;
  16123. }
  16124. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16125. const char *key_pem,
  16126. const char *client_ca_pem,
  16127. const char *password) {
  16128. if (!ctx_) { return false; }
  16129. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16130. updates_pending_++;
  16131. auto se = detail::scope_exit([&] {
  16132. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16133. });
  16134. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16135. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16136. return false;
  16137. }
  16138. if (client_ca_pem) {
  16139. return tls::update_server_client_ca(ctx_, client_ca_pem);
  16140. }
  16141. return true;
  16142. }
  16143. // SSL HTTP client implementation
  16144. inline SSLClient::~SSLClient() {
  16145. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16146. // base function rather than the derived function once we get to the
  16147. // base class destructor, and won't free the SSL (causing a leak).
  16148. // This must happen before the context is freed below: some backends
  16149. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16150. // context, so freeing the context first leaves close_notify reading
  16151. // freed memory.
  16152. shutdown_ssl_impl(socket_, true);
  16153. if (ctx_) {
  16154. tls::free_context(ctx_);
  16155. ctx_ = nullptr;
  16156. }
  16157. }
  16158. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16159. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16160. shutdown_ssl_impl(socket, shutdown_gracefully);
  16161. }
  16162. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16163. bool shutdown_gracefully) {
  16164. if (socket.sock == INVALID_SOCKET) {
  16165. assert(socket.ssl == nullptr);
  16166. return;
  16167. }
  16168. if (socket.ssl) {
  16169. tls::shutdown(socket.ssl, shutdown_gracefully);
  16170. {
  16171. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16172. tls::free_session(socket.ssl);
  16173. }
  16174. socket.ssl = nullptr;
  16175. }
  16176. assert(socket.ssl == nullptr);
  16177. }
  16178. inline bool SSLClient::process_socket(
  16179. const Socket &socket,
  16180. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16181. std::function<bool(Stream &strm)> callback) {
  16182. assert(socket.ssl);
  16183. return detail::process_client_socket_ssl(
  16184. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16185. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16186. [&](detail::SSLSocketStream &strm) {
  16187. auto ret = callback(strm);
  16188. // A request that failed after the handshake reports Error::Read or
  16189. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16190. // from the server, for Result::ssl_error() and ssl_backend_error()
  16191. const auto &tls_error = strm.tls_error();
  16192. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16193. last_ssl_error_ = static_cast<int>(tls_error.code);
  16194. last_backend_error_ = tls_error.backend_code;
  16195. }
  16196. return ret;
  16197. });
  16198. }
  16199. inline bool SSLClient::is_ssl() const { return true; }
  16200. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16201. if (!is_valid()) {
  16202. error = Error::SSLConnection;
  16203. return false;
  16204. }
  16205. return ClientImpl::create_and_connect_socket(socket, error);
  16206. }
  16207. inline bool SSLClient::setup_proxy_connection(
  16208. Socket &socket,
  16209. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16210. Response &res, bool &success, Error &error) {
  16211. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16212. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16213. return false;
  16214. }
  16215. if (!initialize_ssl(socket, error)) {
  16216. success = false;
  16217. return false;
  16218. }
  16219. return true;
  16220. }
  16221. // Assumes that socket_mutex_ is locked and that there are no requests in
  16222. // flight
  16223. inline bool SSLClient::connect_with_proxy(
  16224. Socket &socket,
  16225. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16226. Response &res, bool &success, Error &error) {
  16227. success = true;
  16228. Response proxy_res;
  16229. if (!detail::process_client_socket(
  16230. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16231. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16232. start_time, [&](Stream &strm) {
  16233. Request req2;
  16234. req2.method = "CONNECT";
  16235. req2.path =
  16236. detail::make_host_and_port_string_always_port(host_, port_);
  16237. if (max_timeout_msec_ > 0) {
  16238. req2.start_time_ = std::chrono::steady_clock::now();
  16239. }
  16240. return process_request(strm, req2, proxy_res, false, error);
  16241. })) {
  16242. // Thread-safe to close everything because we are assuming there are no
  16243. // requests in flight
  16244. shutdown_ssl(socket, true);
  16245. shutdown_socket(socket);
  16246. close_socket(socket);
  16247. success = false;
  16248. return false;
  16249. }
  16250. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16251. if (!proxy_digest_auth_username_.empty() &&
  16252. !proxy_digest_auth_password_.empty()) {
  16253. std::map<std::string, std::string> auth;
  16254. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16255. // Close the current socket and create a new one for the authenticated
  16256. // request
  16257. shutdown_ssl(socket, true);
  16258. shutdown_socket(socket);
  16259. close_socket(socket);
  16260. // Create a new socket for the authenticated CONNECT request
  16261. if (!ensure_socket_connection(socket, error)) {
  16262. success = false;
  16263. output_error_log(error, nullptr);
  16264. return false;
  16265. }
  16266. proxy_res = Response();
  16267. if (!detail::process_client_socket(
  16268. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16269. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16270. start_time, [&](Stream &strm) {
  16271. Request req3;
  16272. req3.method = "CONNECT";
  16273. req3.path = detail::make_host_and_port_string_always_port(
  16274. host_, port_);
  16275. req3.headers.insert(detail::make_digest_authentication_header(
  16276. req3, make_request_target(req3), auth, 1,
  16277. detail::random_string(10), proxy_digest_auth_username_,
  16278. proxy_digest_auth_password_, true));
  16279. if (max_timeout_msec_ > 0) {
  16280. req3.start_time_ = std::chrono::steady_clock::now();
  16281. }
  16282. return process_request(strm, req3, proxy_res, false, error);
  16283. })) {
  16284. // Thread-safe to close everything because we are assuming there are
  16285. // no requests in flight
  16286. shutdown_ssl(socket, true);
  16287. shutdown_socket(socket);
  16288. close_socket(socket);
  16289. success = false;
  16290. return false;
  16291. }
  16292. }
  16293. }
  16294. }
  16295. // If status code is not 200, proxy request is failed.
  16296. // Set error to ProxyConnection. A 407 is returned as the response of the
  16297. // request, so the caller sees the proxy asks for credentials; any other
  16298. // status would read as the answer of the origin, which it never reached.
  16299. if (proxy_res.status != StatusCode::OK_200) {
  16300. error = Error::ProxyConnection;
  16301. output_error_log(error, nullptr);
  16302. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16303. res = std::move(proxy_res);
  16304. } else {
  16305. success = false;
  16306. }
  16307. // Thread-safe to close everything because we are assuming there are
  16308. // no requests in flight
  16309. shutdown_ssl(socket, true);
  16310. shutdown_socket(socket);
  16311. close_socket(socket);
  16312. return false;
  16313. }
  16314. return true;
  16315. }
  16316. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16317. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16318. if (is_proxy_enabled_for_host(host_)) { return true; }
  16319. if (!initialize_ssl(socket, error)) {
  16320. shutdown_socket(socket);
  16321. close_socket(socket);
  16322. return false;
  16323. }
  16324. return true;
  16325. }
  16326. // SSL HTTP client implementation
  16327. inline SSLClient::SSLClient(const std::string &host)
  16328. : SSLClient(host, 443, std::string(), std::string()) {}
  16329. inline SSLClient::SSLClient(const std::string &host, int port)
  16330. : SSLClient(host, port, std::string(), std::string()) {}
  16331. inline void SSLClient::init_ctx() {
  16332. ctx_ = tls::create_client_context();
  16333. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16334. }
  16335. inline void SSLClient::reset_ctx_on_error() {
  16336. last_backend_error_ = tls::get_error();
  16337. tls::free_context(ctx_);
  16338. ctx_ = nullptr;
  16339. }
  16340. inline SSLClient::SSLClient(const std::string &host, int port,
  16341. const std::string &client_cert_path,
  16342. const std::string &client_key_path,
  16343. const std::string &private_key_password)
  16344. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16345. init_ctx();
  16346. if (!ctx_) { return; }
  16347. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16348. const char *password =
  16349. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16350. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16351. client_key_path.c_str(), password)) {
  16352. reset_ctx_on_error();
  16353. }
  16354. }
  16355. }
  16356. inline SSLClient::SSLClient(const std::string &host, int port,
  16357. const PemMemory &pem)
  16358. : ClientImpl(host, port) {
  16359. init_ctx();
  16360. if (!ctx_) { return; }
  16361. if (pem.cert_pem && pem.key_pem) {
  16362. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  16363. pem.private_key_password)) {
  16364. reset_ctx_on_error();
  16365. }
  16366. }
  16367. }
  16368. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16369. if (ca_cert_store && ctx_) {
  16370. // set_ca_store takes ownership of ca_cert_store
  16371. tls::set_ca_store(ctx_, ca_cert_store);
  16372. ca_cert_store_set_ = true;
  16373. } else if (ca_cert_store) {
  16374. tls::free_ca_store(ca_cert_store);
  16375. }
  16376. }
  16377. inline void
  16378. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16379. if (!ctx_) { return; }
  16380. server_certificate_verifier_ = verifier;
  16381. // Under the lock that creating a session from ctx_ takes
  16382. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16383. tls::set_verify_callback(ctx_, std::move(verifier));
  16384. }
  16385. inline void SSLClient::set_session_verifier(
  16386. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16387. session_verifier_ = std::move(verifier);
  16388. }
  16389. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16390. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16391. enable_windows_cert_verification_ = enabled;
  16392. }
  16393. #endif
  16394. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16395. std::size_t size) {
  16396. if (ctx_ && ca_cert && size > 0) {
  16397. // Every PEM loaded, for redirect transfer
  16398. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16399. ca_cert_pem_ += '\n';
  16400. }
  16401. ca_cert_pem_.append(ca_cert, size);
  16402. tls::load_ca_pem(ctx_, ca_cert, size);
  16403. }
  16404. }
  16405. inline bool SSLClient::load_certs() {
  16406. auto ret = true;
  16407. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16408. // one client is shared across concurrent requests here.
  16409. std::call_once(initialize_cert_, [&]() {
  16410. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16411. ret = detail::load_client_ca_config(
  16412. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  16413. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  16414. last_backend_error_);
  16415. });
  16416. return ret;
  16417. }
  16418. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16419. // Load CA certificates if server verification is enabled
  16420. if (server_certificate_verification_) {
  16421. if (!load_certs()) {
  16422. error = Error::SSLLoadingCerts;
  16423. output_error_log(error, nullptr);
  16424. return false;
  16425. }
  16426. }
  16427. detail::ClientTlsSessionOptions options;
  16428. options.server_hostname_verification = server_hostname_verification_;
  16429. options.session_verifier = session_verifier_;
  16430. options.ctx_mutex = &ctx_mutex_;
  16431. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16432. // Skip Schannel when a custom CA cert is specified, as the Windows
  16433. // certificate store would not know about user-provided CA certificates.
  16434. // Also skip when system CA trust is explicitly disabled.
  16435. options.windows_cert_verification =
  16436. enable_windows_cert_verification_ &&
  16437. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16438. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16439. // Only a verifier set through set_server_certificate_verifier() is seen
  16440. // here, not one installed with tls::set_verify_callback() directly.
  16441. options.server_certificate_verifier_set =
  16442. static_cast<bool>(server_certificate_verifier_);
  16443. #endif
  16444. tls::session_t session = nullptr;
  16445. // Use scope_exit to ensure session is freed on error paths
  16446. bool success = false;
  16447. auto session_guard = detail::scope_exit([&] {
  16448. if (!success) { tls::free_session(session); }
  16449. });
  16450. detail::ClientTlsSessionError tls_error;
  16451. if (!detail::setup_client_tls_session(
  16452. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16453. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16454. options)) {
  16455. error = tls_error.error;
  16456. last_ssl_error_ = tls_error.ssl_error;
  16457. last_backend_error_ = tls_error.backend_error;
  16458. output_error_log(error, nullptr);
  16459. return false;
  16460. }
  16461. success = true;
  16462. socket.ssl = session;
  16463. return true;
  16464. }
  16465. inline void Client::set_digest_auth(const std::string &username,
  16466. const std::string &password) {
  16467. cli_->set_digest_auth(username, password);
  16468. }
  16469. inline void Client::set_proxy_digest_auth(const std::string &username,
  16470. const std::string &password) {
  16471. cli_->set_proxy_digest_auth(username, password);
  16472. }
  16473. inline void Client::enable_server_certificate_verification(bool enabled) {
  16474. cli_->enable_server_certificate_verification(enabled);
  16475. }
  16476. inline void Client::enable_server_hostname_verification(bool enabled) {
  16477. cli_->enable_server_hostname_verification(enabled);
  16478. }
  16479. inline void Client::enable_system_ca(bool enabled) {
  16480. cli_->enable_system_ca(enabled);
  16481. }
  16482. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16483. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16484. if (is_ssl_) {
  16485. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16486. enabled);
  16487. }
  16488. }
  16489. #endif
  16490. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16491. const std::string &ca_cert_dir_path) {
  16492. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16493. }
  16494. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16495. if (is_ssl_) {
  16496. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16497. } else if (ca_cert_store) {
  16498. tls::free_ca_store(ca_cert_store);
  16499. }
  16500. }
  16501. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16502. if (is_ssl_) {
  16503. // Use the PEM-based path so the CA data is retained for redirect transfer
  16504. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16505. }
  16506. }
  16507. inline void
  16508. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16509. if (is_ssl_) {
  16510. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16511. std::move(verifier));
  16512. }
  16513. }
  16514. inline void Client::set_session_verifier(
  16515. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16516. if (is_ssl_) {
  16517. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16518. }
  16519. }
  16520. inline tls::ctx_t Client::tls_context() const {
  16521. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16522. return nullptr;
  16523. }
  16524. #endif // CPPHTTPLIB_SSL_ENABLED
  16525. /*
  16526. * Group 7: TLS abstraction layer - Common API
  16527. */
  16528. #ifdef CPPHTTPLIB_SSL_ENABLED
  16529. namespace tls {
  16530. // Helper for PeerCert construction
  16531. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16532. return PeerCert(get_peer_cert(session));
  16533. }
  16534. namespace impl {
  16535. // set_verify_callback() can replace a callback while handshakes on other
  16536. // threads run it, so they share it, and take their reference under this lock.
  16537. inline std::mutex &verify_callback_mutex() {
  16538. static std::mutex mutex;
  16539. return mutex;
  16540. }
  16541. // The TLS libraries are C, so an exception from a verify callback must not
  16542. // unwind through them. It rejects the certificate instead.
  16543. inline bool run_verify_callback(const VerifyCallback &callback,
  16544. const VerifyContext &ctx) {
  16545. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16546. return callback(ctx);
  16547. #else
  16548. try {
  16549. return callback(ctx);
  16550. } catch (...) { return false; }
  16551. #endif
  16552. }
  16553. // Check if a string is an IPv4 address
  16554. inline bool is_ipv4_address(const std::string &str) {
  16555. int dots = 0;
  16556. for (char c : str) {
  16557. if (c == '.') {
  16558. dots++;
  16559. } else if (!detail::is_ascii_digit(c)) {
  16560. return false;
  16561. }
  16562. }
  16563. return dots == 3;
  16564. }
  16565. // Parse IPv4 address string to bytes
  16566. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16567. const char *p = str.c_str();
  16568. for (int i = 0; i < 4; i++) {
  16569. if (i > 0) {
  16570. if (*p != '.') { return false; }
  16571. p++;
  16572. }
  16573. int val = 0;
  16574. int digits = 0;
  16575. while (detail::is_ascii_digit(*p)) {
  16576. val = val * 10 + (*p - '0');
  16577. if (val > 255) { return false; }
  16578. p++;
  16579. digits++;
  16580. }
  16581. if (digits == 0) { return false; }
  16582. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16583. if (digits > 1 && *(p - digits) == '0') { return false; }
  16584. out[i] = static_cast<unsigned char>(val);
  16585. }
  16586. return *p == '\0';
  16587. }
  16588. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16589. // `out` must have room for at least 16 bytes. Returns the address length
  16590. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16591. // literal. Used to match a host against iPAddress SANs the same way the
  16592. // OpenSSL backend does via X509_check_ip.
  16593. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16594. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16595. struct in6_addr addr6 = {};
  16596. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16597. memcpy(out, &addr6, 16);
  16598. return 16;
  16599. }
  16600. return 0;
  16601. }
  16602. #ifdef _WIN32
  16603. // Enumerate Windows system certificates and call callback with DER data
  16604. template <typename Callback>
  16605. inline bool enumerate_windows_system_certs(Callback cb) {
  16606. bool loaded = false;
  16607. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16608. for (auto store_name : store_names) {
  16609. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16610. if (hStore) {
  16611. PCCERT_CONTEXT pContext = nullptr;
  16612. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16613. nullptr) {
  16614. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16615. loaded = true;
  16616. }
  16617. }
  16618. CertCloseStore(hStore, 0);
  16619. }
  16620. }
  16621. return loaded;
  16622. }
  16623. #endif
  16624. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16625. // Enumerate macOS Keychain certificates and call callback with DER data
  16626. template <typename Callback>
  16627. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16628. bool loaded = false;
  16629. const SecTrustSettingsDomain domains[] = {
  16630. kSecTrustSettingsDomainSystem,
  16631. kSecTrustSettingsDomainAdmin,
  16632. kSecTrustSettingsDomainUser,
  16633. };
  16634. for (auto domain : domains) {
  16635. CFArrayRef certs = nullptr;
  16636. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16637. if (status != errSecSuccess || !certs) {
  16638. if (certs) CFRelease(certs);
  16639. continue;
  16640. }
  16641. CFIndex count = CFArrayGetCount(certs);
  16642. for (CFIndex i = 0; i < count; i++) {
  16643. SecCertificateRef cert =
  16644. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16645. CFDataRef data = SecCertificateCopyData(cert);
  16646. if (data) {
  16647. if (cb(CFDataGetBytePtr(data),
  16648. static_cast<size_t>(CFDataGetLength(data)))) {
  16649. loaded = true;
  16650. }
  16651. CFRelease(data);
  16652. }
  16653. }
  16654. CFRelease(certs);
  16655. }
  16656. return loaded;
  16657. }
  16658. #endif
  16659. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16660. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16661. // Common CA certificate file paths on Linux/Unix
  16662. inline const char **system_ca_paths() {
  16663. static const char *paths[] = {
  16664. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16665. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16666. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16667. "/etc/pki/tls/cacert.pem", // OpenELEC
  16668. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16669. nullptr};
  16670. return paths;
  16671. }
  16672. // Common CA certificate directory paths on Linux/Unix
  16673. inline const char **system_ca_dirs() {
  16674. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16675. "/etc/pki/tls/certs", // RHEL/CentOS
  16676. "/usr/share/ca-certificates", // Other
  16677. nullptr};
  16678. return dirs;
  16679. }
  16680. #endif
  16681. } // namespace impl
  16682. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16683. const char *ca_dir) {
  16684. if (!ctx) { return false; }
  16685. bool success = true;
  16686. if (ca_file && *ca_file) {
  16687. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16688. }
  16689. if (ca_dir && *ca_dir) {
  16690. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16691. }
  16692. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16693. // Set CA list for client certificate request (CertificateRequest message)
  16694. if (ca_file && *ca_file) {
  16695. auto list = SSL_load_client_CA_file(ca_file);
  16696. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16697. }
  16698. #endif
  16699. return success;
  16700. }
  16701. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16702. const char *password) {
  16703. return set_client_cert_pem(ctx, cert, key, password);
  16704. }
  16705. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16706. const char *key_path, const char *password) {
  16707. return set_client_cert_file(ctx, cert_path, key_path, password);
  16708. }
  16709. // PeerCert implementation
  16710. inline PeerCert::PeerCert() = default;
  16711. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16712. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16713. other.cert_ = nullptr;
  16714. }
  16715. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16716. if (this != &other) {
  16717. if (cert_) { free_cert(cert_); }
  16718. cert_ = other.cert_;
  16719. other.cert_ = nullptr;
  16720. }
  16721. return *this;
  16722. }
  16723. inline PeerCert::~PeerCert() {
  16724. if (cert_) { free_cert(cert_); }
  16725. }
  16726. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16727. inline std::string PeerCert::subject_cn() const {
  16728. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16729. }
  16730. inline std::string PeerCert::issuer_name() const {
  16731. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16732. }
  16733. inline bool PeerCert::check_hostname(const char *hostname) const {
  16734. return cert_ ? verify_hostname(cert_, hostname) : false;
  16735. }
  16736. inline std::vector<SanEntry> PeerCert::sans() const {
  16737. std::vector<SanEntry> result;
  16738. if (cert_) { get_cert_sans(cert_, result); }
  16739. return result;
  16740. }
  16741. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16742. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16743. }
  16744. inline std::string PeerCert::serial() const {
  16745. return cert_ ? get_cert_serial(cert_) : std::string();
  16746. }
  16747. // VerifyContext method implementations
  16748. inline std::string VerifyContext::subject_cn() const {
  16749. return cert ? get_cert_subject_cn(cert) : std::string();
  16750. }
  16751. inline std::string VerifyContext::issuer_name() const {
  16752. return cert ? get_cert_issuer_name(cert) : std::string();
  16753. }
  16754. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16755. return cert ? verify_hostname(cert, hostname) : false;
  16756. }
  16757. inline std::vector<SanEntry> VerifyContext::sans() const {
  16758. std::vector<SanEntry> result;
  16759. if (cert) { get_cert_sans(cert, result); }
  16760. return result;
  16761. }
  16762. inline bool VerifyContext::validity(time_t &not_before,
  16763. time_t &not_after) const {
  16764. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16765. }
  16766. inline std::string VerifyContext::serial() const {
  16767. return cert ? get_cert_serial(cert) : std::string();
  16768. }
  16769. // TlsError static method implementation
  16770. inline std::string TlsError::verify_error_to_string(long error_code) {
  16771. return verify_error_string(error_code);
  16772. }
  16773. } // namespace tls
  16774. // Request::peer_cert() implementation
  16775. inline tls::PeerCert Request::peer_cert() const {
  16776. return tls::get_peer_cert_from_session(ssl);
  16777. }
  16778. // Request::sni() implementation
  16779. inline std::string Request::sni() const {
  16780. if (!ssl) { return std::string(); }
  16781. const char *s = tls::get_sni(ssl);
  16782. return s ? std::string(s) : std::string();
  16783. }
  16784. #endif // CPPHTTPLIB_SSL_ENABLED
  16785. /*
  16786. * Group 8: TLS abstraction layer - OpenSSL backend
  16787. */
  16788. /*
  16789. * OpenSSL Backend Implementation
  16790. */
  16791. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16792. namespace tls {
  16793. namespace impl {
  16794. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16795. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16796. switch (ssl_error) {
  16797. case SSL_ERROR_NONE: return ErrorCode::Success;
  16798. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16799. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16800. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16801. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16802. case SSL_ERROR_SSL:
  16803. default: return ErrorCode::Fatal;
  16804. }
  16805. }
  16806. // Helper: Create client CA list from PEM string
  16807. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16808. // Caller takes ownership of returned list
  16809. inline STACK_OF(X509_NAME) *
  16810. create_client_ca_list_from_pem(const char *ca_pem) {
  16811. if (!ca_pem) { return nullptr; }
  16812. auto ca_list = sk_X509_NAME_new_null();
  16813. if (!ca_list) { return nullptr; }
  16814. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16815. if (!bio) {
  16816. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16817. return nullptr;
  16818. }
  16819. X509 *cert = nullptr;
  16820. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16821. nullptr) {
  16822. const X509_NAME *name = X509_get_subject_name(cert);
  16823. if (name) {
  16824. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16825. }
  16826. X509_free(cert);
  16827. }
  16828. BIO_free(bio);
  16829. return ca_list;
  16830. }
  16831. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16832. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16833. long /*argl*/, void * /*argp*/) {
  16834. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  16835. }
  16836. // The SSL_CTX owns its verify callback, so each client or server sees only
  16837. // its own, on whichever thread runs the handshake.
  16838. inline int verify_callback_index() {
  16839. static const auto index = SSL_CTX_get_ex_new_index(
  16840. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16841. return index;
  16842. }
  16843. // OpenSSL verify callback wrapper
  16844. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16845. // Get SSL object from X509_STORE_CTX
  16846. auto ssl = static_cast<SSL *>(
  16847. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16848. if (!ssl) { return preverify_ok; }
  16849. std::shared_ptr<VerifyCallback> callback;
  16850. {
  16851. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  16852. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  16853. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16854. if (stored) { callback = *stored; }
  16855. }
  16856. if (!callback) { return preverify_ok; }
  16857. // Get current certificate and depth
  16858. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16859. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16860. int error = X509_STORE_CTX_get_error(ctx);
  16861. // Build context
  16862. VerifyContext verify_ctx;
  16863. verify_ctx.session = static_cast<session_t>(ssl);
  16864. verify_ctx.cert = static_cast<cert_t>(cert);
  16865. verify_ctx.depth = depth;
  16866. verify_ctx.preverify_ok = (preverify_ok != 0);
  16867. verify_ctx.error_code = error;
  16868. verify_ctx.error_string =
  16869. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16870. return run_verify_callback(*callback, verify_ctx) ? 1 : 0;
  16871. }
  16872. // Sets the verify mode from whether the peer's certificate is required and
  16873. // whether a verify callback is set.
  16874. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  16875. auto has_callback =
  16876. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  16877. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16878. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  16879. SSL_CTX_set_verify(ssl_ctx, mode,
  16880. has_callback ? openssl_verify_callback : nullptr);
  16881. }
  16882. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16883. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16884. // that must be released with release_store_objects
  16885. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16886. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16887. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16888. #endif
  16889. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16890. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16891. return X509_STORE_get1_objects(store);
  16892. #else
  16893. return X509_STORE_get0_objects(store);
  16894. #endif
  16895. }
  16896. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16897. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16898. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16899. #else
  16900. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16901. #endif
  16902. }
  16903. } // namespace impl
  16904. inline ctx_t create_client_context() {
  16905. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16906. if (ctx) {
  16907. // Disable auto-retry to properly handle non-blocking I/O
  16908. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16909. // Set minimum TLS version
  16910. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16911. }
  16912. return static_cast<ctx_t>(ctx);
  16913. }
  16914. inline void free_context(ctx_t ctx) {
  16915. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16916. }
  16917. inline bool set_min_version(ctx_t ctx, Version version) {
  16918. if (!ctx) return false;
  16919. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16920. static_cast<uint16_t>(version)) == 1;
  16921. }
  16922. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16923. if (!ctx || !pem || len == 0) return false;
  16924. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16925. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16926. if (!store) return false;
  16927. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16928. if (!bio) return false;
  16929. bool ok = true;
  16930. X509 *cert = nullptr;
  16931. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16932. nullptr) {
  16933. if (X509_STORE_add_cert(store, cert) != 1) {
  16934. // Ignore duplicate errors
  16935. auto err = ERR_peek_last_error();
  16936. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16937. ok = false;
  16938. }
  16939. }
  16940. X509_free(cert);
  16941. if (!ok) break;
  16942. }
  16943. BIO_free(bio);
  16944. // Clear any "no more certificates" errors
  16945. ERR_clear_error();
  16946. return ok;
  16947. }
  16948. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16949. if (!ctx || !file_path) return false;
  16950. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16951. nullptr) == 1;
  16952. }
  16953. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16954. if (!ctx || !dir_path) return false;
  16955. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16956. dir_path) == 1;
  16957. }
  16958. inline bool load_system_certs(ctx_t ctx) {
  16959. if (!ctx) return false;
  16960. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16961. #ifdef _WIN32
  16962. // Windows: Load from system certificate store (ROOT and CA)
  16963. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16964. if (!store) return false;
  16965. bool loaded_any = false;
  16966. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16967. for (auto store_name : store_names) {
  16968. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16969. if (!hStore) continue;
  16970. PCCERT_CONTEXT pContext = nullptr;
  16971. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16972. nullptr) {
  16973. const unsigned char *data = pContext->pbCertEncoded;
  16974. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16975. if (x509) {
  16976. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16977. X509_free(x509);
  16978. }
  16979. }
  16980. CertCloseStore(hStore, 0);
  16981. }
  16982. return loaded_any;
  16983. #elif defined(__APPLE__)
  16984. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16985. // macOS: Load from Keychain
  16986. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16987. if (!store) return false;
  16988. bool loaded_any = false;
  16989. const SecTrustSettingsDomain domains[] = {
  16990. kSecTrustSettingsDomainSystem,
  16991. kSecTrustSettingsDomainAdmin,
  16992. kSecTrustSettingsDomainUser,
  16993. };
  16994. for (auto domain : domains) {
  16995. CFArrayRef certs = nullptr;
  16996. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16997. !certs) {
  16998. if (certs) CFRelease(certs);
  16999. continue;
  17000. }
  17001. auto count = CFArrayGetCount(certs);
  17002. for (CFIndex i = 0; i < count; i++) {
  17003. auto cert = reinterpret_cast<SecCertificateRef>(
  17004. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  17005. CFDataRef der = SecCertificateCopyData(cert);
  17006. if (der) {
  17007. const unsigned char *data = CFDataGetBytePtr(der);
  17008. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  17009. if (x509) {
  17010. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17011. X509_free(x509);
  17012. }
  17013. CFRelease(der);
  17014. }
  17015. }
  17016. CFRelease(certs);
  17017. }
  17018. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17019. #else
  17020. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17021. #endif
  17022. #else
  17023. // Other Unix: use default verify paths
  17024. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17025. #endif
  17026. }
  17027. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17028. const char *password) {
  17029. if (!ctx || !cert || !key) return false;
  17030. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17031. // Load certificate
  17032. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17033. if (!cert_bio) return false;
  17034. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17035. BIO_free(cert_bio);
  17036. if (!x509) return false;
  17037. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17038. X509_free(x509);
  17039. if (!cert_ok) return false;
  17040. // Load private key
  17041. auto key_bio = BIO_new_mem_buf(key, -1);
  17042. if (!key_bio) return false;
  17043. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17044. password ? const_cast<char *>(password)
  17045. : nullptr);
  17046. BIO_free(key_bio);
  17047. if (!pkey) return false;
  17048. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17049. EVP_PKEY_free(pkey);
  17050. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17051. }
  17052. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17053. const char *key_path, const char *password) {
  17054. if (!ctx || !cert_path || !key_path) return false;
  17055. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17056. if (password && password[0] != '\0') {
  17057. SSL_CTX_set_default_passwd_cb_userdata(
  17058. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17059. }
  17060. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17061. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17062. }
  17063. inline ctx_t create_server_context() {
  17064. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17065. if (ctx) {
  17066. // No renegotiation, as on the other backends: it would run a handshake
  17067. // that SSLServer::update_certs_pem() does not wait for
  17068. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17069. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17070. SSL_OP_NO_RENEGOTIATION);
  17071. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17072. // Without one, a client resuming its session is sent a fatal alert once
  17073. // client certificates are verified.
  17074. static const unsigned char sid_ctx[] = "cpp-httplib";
  17075. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17076. }
  17077. return static_cast<ctx_t>(ctx);
  17078. }
  17079. inline void set_verify_client(ctx_t ctx, bool require) {
  17080. if (!ctx) return;
  17081. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17082. }
  17083. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17084. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17085. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17086. SSL *ssl = SSL_new(ssl_ctx);
  17087. if (!ssl) return nullptr;
  17088. // Disable auto-retry for proper non-blocking I/O handling
  17089. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17090. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17091. if (!bio) {
  17092. SSL_free(ssl);
  17093. return nullptr;
  17094. }
  17095. SSL_set_bio(ssl, bio, bio);
  17096. return static_cast<session_t>(ssl);
  17097. }
  17098. inline void free_session(session_t session) {
  17099. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17100. }
  17101. inline bool set_sni(session_t session, const char *hostname,
  17102. bool /*verify_hostname*/) {
  17103. if (!session || !hostname) return false;
  17104. auto ssl = static_cast<SSL *>(session);
  17105. // Set SNI (Server Name Indication) only - does not enable verification.
  17106. // OpenSSL never binds identity checking to SNI (that happens post-
  17107. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  17108. #if defined(OPENSSL_IS_BORINGSSL)
  17109. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17110. #else
  17111. // Direct call instead of macro to suppress -Wold-style-cast warning
  17112. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17113. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17114. #endif
  17115. }
  17116. inline TlsError connect(session_t session) {
  17117. if (!session) { return TlsError(); }
  17118. auto ssl = static_cast<SSL *>(session);
  17119. auto ret = SSL_connect(ssl);
  17120. TlsError err;
  17121. if (ret == 1) {
  17122. err.code = ErrorCode::Success;
  17123. } else {
  17124. auto ssl_err = SSL_get_error(ssl, ret);
  17125. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17126. err.backend_code = ERR_get_error();
  17127. }
  17128. return err;
  17129. }
  17130. inline TlsError accept(session_t session) {
  17131. if (!session) { return TlsError(); }
  17132. auto ssl = static_cast<SSL *>(session);
  17133. auto ret = SSL_accept(ssl);
  17134. TlsError err;
  17135. if (ret == 1) {
  17136. err.code = ErrorCode::Success;
  17137. } else {
  17138. auto ssl_err = SSL_get_error(ssl, ret);
  17139. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17140. err.backend_code = ERR_get_error();
  17141. }
  17142. return err;
  17143. }
  17144. inline bool connect_nonblocking(session_t session, socket_t sock,
  17145. time_t timeout_sec, time_t timeout_usec,
  17146. TlsError *err) {
  17147. if (!session) {
  17148. if (err) { err->code = ErrorCode::Fatal; }
  17149. return false;
  17150. }
  17151. auto ssl = static_cast<SSL *>(session);
  17152. auto bio = SSL_get_rbio(ssl);
  17153. // Set non-blocking mode for handshake
  17154. detail::set_nonblocking(sock, true);
  17155. if (bio) { BIO_set_nbio(bio, 1); }
  17156. auto cleanup = detail::scope_exit([&]() {
  17157. // Restore blocking mode after handshake
  17158. if (bio) { BIO_set_nbio(bio, 0); }
  17159. detail::set_nonblocking(sock, false);
  17160. });
  17161. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17162. auto res = 0;
  17163. while ((res = SSL_connect(ssl)) != 1) {
  17164. auto ssl_err = SSL_get_error(ssl, res);
  17165. switch (ssl_err) {
  17166. case SSL_ERROR_WANT_READ:
  17167. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17168. break;
  17169. case SSL_ERROR_WANT_WRITE:
  17170. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17171. break;
  17172. default: break;
  17173. }
  17174. if (err) {
  17175. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17176. err->backend_code = ERR_get_error();
  17177. }
  17178. return false;
  17179. }
  17180. if (err) { err->code = ErrorCode::Success; }
  17181. return true;
  17182. }
  17183. inline bool accept_nonblocking(session_t session, socket_t sock,
  17184. time_t timeout_sec, time_t timeout_usec,
  17185. TlsError *err) {
  17186. if (!session) {
  17187. if (err) { err->code = ErrorCode::Fatal; }
  17188. return false;
  17189. }
  17190. auto ssl = static_cast<SSL *>(session);
  17191. auto bio = SSL_get_rbio(ssl);
  17192. // Set non-blocking mode for handshake
  17193. detail::set_nonblocking(sock, true);
  17194. if (bio) { BIO_set_nbio(bio, 1); }
  17195. auto cleanup = detail::scope_exit([&]() {
  17196. // Restore blocking mode after handshake
  17197. if (bio) { BIO_set_nbio(bio, 0); }
  17198. detail::set_nonblocking(sock, false);
  17199. });
  17200. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17201. auto res = 0;
  17202. while ((res = SSL_accept(ssl)) != 1) {
  17203. auto ssl_err = SSL_get_error(ssl, res);
  17204. switch (ssl_err) {
  17205. case SSL_ERROR_WANT_READ:
  17206. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17207. break;
  17208. case SSL_ERROR_WANT_WRITE:
  17209. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17210. break;
  17211. default: break;
  17212. }
  17213. if (err) {
  17214. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17215. err->backend_code = ERR_get_error();
  17216. }
  17217. return false;
  17218. }
  17219. if (err) { err->code = ErrorCode::Success; }
  17220. return true;
  17221. }
  17222. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17223. if (!session || !buf) {
  17224. err.code = ErrorCode::Fatal;
  17225. return -1;
  17226. }
  17227. auto ssl = static_cast<SSL *>(session);
  17228. constexpr auto max_len =
  17229. static_cast<size_t>((std::numeric_limits<int>::max)());
  17230. if (len > max_len) { len = max_len; }
  17231. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17232. if (ret > 0) {
  17233. err.code = ErrorCode::Success;
  17234. return ret;
  17235. }
  17236. auto ssl_err = SSL_get_error(ssl, ret);
  17237. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17238. if (err.code == ErrorCode::PeerClosed) {
  17239. return 0;
  17240. } // Gracefully handle the peer closed state.
  17241. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17242. return -1;
  17243. }
  17244. inline ssize_t write(session_t session, const void *buf, size_t len,
  17245. TlsError &err) {
  17246. if (!session || !buf) {
  17247. err.code = ErrorCode::Fatal;
  17248. return -1;
  17249. }
  17250. auto ssl = static_cast<SSL *>(session);
  17251. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17252. if (ret > 0) {
  17253. err.code = ErrorCode::Success;
  17254. return ret;
  17255. }
  17256. auto ssl_err = SSL_get_error(ssl, ret);
  17257. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17258. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17259. return -1;
  17260. }
  17261. inline int pending(const_session_t session) {
  17262. if (!session) return 0;
  17263. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17264. }
  17265. inline void shutdown(session_t session, bool graceful) {
  17266. if (!session) return;
  17267. auto ssl = static_cast<SSL *>(session);
  17268. if (graceful) {
  17269. // Send close_notify without waiting for the peer's. The connection is
  17270. // closed right after this, so a unidirectional shutdown is enough, and an
  17271. // idle peer that never answers would otherwise hold this thread until the
  17272. // read timeout. The other backends do not wait either.
  17273. SSL_shutdown(ssl);
  17274. }
  17275. }
  17276. inline bool is_peer_closed(session_t session, socket_t sock) {
  17277. if (!session) return true;
  17278. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17279. detail::set_nonblocking(sock, true);
  17280. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17281. auto ssl = static_cast<SSL *>(session);
  17282. char buf;
  17283. auto ret = SSL_peek(ssl, &buf, 1);
  17284. if (ret > 0) return false;
  17285. auto err = SSL_get_error(ssl, ret);
  17286. return err == SSL_ERROR_ZERO_RETURN;
  17287. }
  17288. inline cert_t get_peer_cert(const_session_t session) {
  17289. if (!session) return nullptr;
  17290. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17291. static_cast<SSL *>(const_cast<void *>(session))));
  17292. }
  17293. inline size_t get_peer_certs(const_session_t session,
  17294. std::vector<cert_t> &certs) {
  17295. certs.clear();
  17296. if (!session) { return 0; }
  17297. auto ssl = static_cast<const SSL *>(session);
  17298. // On the server side, the chain leaves out the peer's own certificate
  17299. if (SSL_is_server(ssl)) {
  17300. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17301. }
  17302. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17303. auto count = sk_X509_num(sk);
  17304. for (decltype(count) i = 0; i < count; i++) {
  17305. auto x509 = sk_X509_value(sk, i);
  17306. X509_up_ref(x509);
  17307. certs.push_back(static_cast<cert_t>(x509));
  17308. }
  17309. }
  17310. return certs.size();
  17311. }
  17312. inline void free_cert(cert_t cert) {
  17313. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17314. }
  17315. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17316. if (!cert || !hostname) return false;
  17317. auto x509 = static_cast<X509 *>(cert);
  17318. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17319. if (detail::is_ip_address(hostname)) {
  17320. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17321. }
  17322. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  17323. }
  17324. inline uint64_t hostname_mismatch_code() {
  17325. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17326. }
  17327. inline long get_verify_result(const_session_t session) {
  17328. if (!session) return X509_V_ERR_UNSPECIFIED;
  17329. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17330. }
  17331. inline std::string get_cert_subject_cn(cert_t cert) {
  17332. if (!cert) return "";
  17333. auto x509 = static_cast<X509 *>(cert);
  17334. auto subject_name = X509_get_subject_name(x509);
  17335. if (!subject_name) return "";
  17336. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17337. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17338. if (idx < 0) return "";
  17339. auto entry = X509_NAME_get_entry(subject_name, idx);
  17340. if (!entry) return "";
  17341. auto data = X509_NAME_ENTRY_get_data(entry);
  17342. if (!data) return "";
  17343. return std::string(
  17344. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17345. static_cast<size_t>(ASN1_STRING_length(data)));
  17346. }
  17347. inline std::string get_cert_issuer_name(cert_t cert) {
  17348. if (!cert) return "";
  17349. auto x509 = static_cast<X509 *>(cert);
  17350. auto issuer_name = X509_get_issuer_name(x509);
  17351. if (!issuer_name) return "";
  17352. char buf[256];
  17353. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17354. return std::string(buf);
  17355. }
  17356. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17357. sans.clear();
  17358. if (!cert) return false;
  17359. auto x509 = static_cast<X509 *>(cert);
  17360. auto names = static_cast<GENERAL_NAMES *>(
  17361. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17362. if (!names) return true; // No SANs is valid
  17363. auto count = sk_GENERAL_NAME_num(names);
  17364. for (decltype(count) i = 0; i < count; i++) {
  17365. auto gen = sk_GENERAL_NAME_value(names, i);
  17366. if (!gen) continue;
  17367. SanEntry entry;
  17368. switch (gen->type) {
  17369. case GEN_DNS:
  17370. entry.type = SanType::DNS;
  17371. if (gen->d.dNSName) {
  17372. entry.value = std::string(
  17373. reinterpret_cast<const char *>(
  17374. ASN1_STRING_get0_data(gen->d.dNSName)),
  17375. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17376. }
  17377. break;
  17378. case GEN_IPADD:
  17379. entry.type = SanType::IP;
  17380. if (gen->d.iPAddress) {
  17381. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17382. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17383. if (len == 4) {
  17384. // IPv4
  17385. char buf[INET_ADDRSTRLEN];
  17386. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17387. entry.value = buf;
  17388. } else if (len == 16) {
  17389. // IPv6
  17390. char buf[INET6_ADDRSTRLEN];
  17391. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17392. entry.value = buf;
  17393. }
  17394. }
  17395. break;
  17396. case GEN_EMAIL:
  17397. entry.type = SanType::EMAIL;
  17398. if (gen->d.rfc822Name) {
  17399. entry.value = std::string(
  17400. reinterpret_cast<const char *>(
  17401. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17402. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17403. }
  17404. break;
  17405. case GEN_URI:
  17406. entry.type = SanType::URI;
  17407. if (gen->d.uniformResourceIdentifier) {
  17408. entry.value = std::string(
  17409. reinterpret_cast<const char *>(
  17410. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17411. static_cast<size_t>(
  17412. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17413. }
  17414. break;
  17415. default: entry.type = SanType::OTHER; break;
  17416. }
  17417. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17418. }
  17419. GENERAL_NAMES_free(names);
  17420. return true;
  17421. }
  17422. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17423. time_t &not_after) {
  17424. if (!cert) return false;
  17425. auto x509 = static_cast<X509 *>(cert);
  17426. auto nb = X509_get0_notBefore(x509);
  17427. auto na = X509_get0_notAfter(x509);
  17428. if (!nb || !na) return false;
  17429. ASN1_TIME *epoch = ASN1_TIME_new();
  17430. if (!epoch) return false;
  17431. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17432. if (!ASN1_TIME_set(epoch, 0)) return false;
  17433. int pday, psec;
  17434. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17435. not_before = 86400 * (time_t)pday + psec;
  17436. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17437. not_after = 86400 * (time_t)pday + psec;
  17438. return true;
  17439. }
  17440. inline std::string get_cert_serial(cert_t cert) {
  17441. if (!cert) return "";
  17442. auto x509 = static_cast<X509 *>(cert);
  17443. auto serial = X509_get_serialNumber(x509);
  17444. if (!serial) return "";
  17445. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17446. if (!bn) return "";
  17447. auto hex = BN_bn2hex(bn);
  17448. BN_free(bn);
  17449. if (!hex) return "";
  17450. std::string result(hex);
  17451. OPENSSL_free(hex);
  17452. return result;
  17453. }
  17454. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17455. if (!cert) return false;
  17456. auto x509 = static_cast<X509 *>(cert);
  17457. auto len = i2d_X509(x509, nullptr);
  17458. if (len < 0) return false;
  17459. der.resize(static_cast<size_t>(len));
  17460. auto p = der.data();
  17461. i2d_X509(x509, &p);
  17462. return true;
  17463. }
  17464. inline const char *get_sni(const_session_t session) {
  17465. if (!session) return nullptr;
  17466. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17467. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17468. }
  17469. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17470. inline uint64_t get_error() { return ERR_get_error(); }
  17471. inline std::string error_string(uint64_t code) {
  17472. char buf[256];
  17473. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17474. sizeof(buf));
  17475. return std::string(buf);
  17476. }
  17477. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17478. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17479. if (!mem) { return nullptr; }
  17480. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17481. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17482. if (!inf) { return nullptr; }
  17483. auto store = X509_STORE_new();
  17484. if (store) {
  17485. auto count = sk_X509_INFO_num(inf);
  17486. for (decltype(count) i = 0; i < count; i++) {
  17487. auto itmp = sk_X509_INFO_value(inf, i);
  17488. if (!itmp) { continue; }
  17489. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17490. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17491. }
  17492. }
  17493. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17494. return static_cast<ca_store_t>(store);
  17495. }
  17496. inline void free_ca_store(ca_store_t store) {
  17497. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17498. }
  17499. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17500. if (!ctx || !store) { return false; }
  17501. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17502. auto x509_store = static_cast<X509_STORE *>(store);
  17503. // Check if same store is already set
  17504. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17505. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17506. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17507. return true;
  17508. }
  17509. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17510. certs.clear();
  17511. if (!ctx) { return 0; }
  17512. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17513. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17514. if (!store) { return 0; }
  17515. auto objs = impl::get_store_objects(store);
  17516. if (!objs) { return 0; }
  17517. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17518. auto count = sk_X509_OBJECT_num(objs);
  17519. for (decltype(count) i = 0; i < count; i++) {
  17520. auto obj = sk_X509_OBJECT_value(objs, i);
  17521. if (!obj) { continue; }
  17522. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17523. auto x509 = X509_OBJECT_get0_X509(obj);
  17524. if (x509) {
  17525. // Increment reference count so caller can free it
  17526. X509_up_ref(x509);
  17527. certs.push_back(static_cast<cert_t>(x509));
  17528. }
  17529. }
  17530. }
  17531. return certs.size();
  17532. }
  17533. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17534. std::vector<std::string> names;
  17535. if (!ctx) { return names; }
  17536. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17537. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17538. if (!store) { return names; }
  17539. auto objs = impl::get_store_objects(store);
  17540. if (!objs) { return names; }
  17541. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17542. auto count = sk_X509_OBJECT_num(objs);
  17543. for (decltype(count) i = 0; i < count; i++) {
  17544. auto obj = sk_X509_OBJECT_value(objs, i);
  17545. if (!obj) { continue; }
  17546. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17547. auto x509 = X509_OBJECT_get0_X509(obj);
  17548. if (x509) {
  17549. auto subject = X509_get_subject_name(x509);
  17550. if (subject) {
  17551. char buf[512];
  17552. X509_NAME_oneline(subject, buf, sizeof(buf));
  17553. names.push_back(buf);
  17554. }
  17555. }
  17556. }
  17557. }
  17558. return names;
  17559. }
  17560. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17561. const char *key_pem, const char *password) {
  17562. if (!ctx || !cert_pem || !key_pem) { return false; }
  17563. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17564. // Load certificate from PEM
  17565. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17566. if (!cert_bio) { return false; }
  17567. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17568. BIO_free(cert_bio);
  17569. if (!cert) { return false; }
  17570. // Load private key from PEM
  17571. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17572. if (!key_bio) {
  17573. X509_free(cert);
  17574. return false;
  17575. }
  17576. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17577. password ? const_cast<char *>(password)
  17578. : nullptr);
  17579. BIO_free(key_bio);
  17580. if (!key) {
  17581. X509_free(cert);
  17582. return false;
  17583. }
  17584. // Update certificate and key
  17585. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17586. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17587. X509_free(cert);
  17588. EVP_PKEY_free(key);
  17589. return ret;
  17590. }
  17591. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17592. if (!ctx || !ca_pem) { return false; }
  17593. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17594. // Create new X509_STORE from PEM
  17595. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17596. if (!store) { return false; }
  17597. // A resumed session is not verified again, so the ticket keys from before
  17598. // go, or a client verified under the old CAs could go on resuming.
  17599. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  17600. unsigned char ticket_keys[48];
  17601. #else
  17602. unsigned char ticket_keys[80];
  17603. #endif
  17604. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  17605. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  17606. sizeof(ticket_keys)) != 1) {
  17607. free_ca_store(store);
  17608. return false;
  17609. }
  17610. // SSL_CTX_set_cert_store takes ownership
  17611. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17612. // Set client CA list for client certificate request
  17613. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17614. if (ca_list) {
  17615. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17616. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17617. }
  17618. // The cached sessions go for the same reason.
  17619. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17620. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17621. #else
  17622. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17623. #endif
  17624. return true;
  17625. }
  17626. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17627. if (!ctx) { return false; }
  17628. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17629. auto index = impl::verify_callback_index();
  17630. if (index < 0) { return false; }
  17631. std::shared_ptr<VerifyCallback> *stored = nullptr;
  17632. if (callback) {
  17633. stored = new std::shared_ptr<VerifyCallback>(
  17634. std::make_shared<VerifyCallback>(std::move(callback)));
  17635. }
  17636. std::shared_ptr<VerifyCallback> *previous = nullptr;
  17637. {
  17638. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  17639. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  17640. SSL_CTX_get_ex_data(ssl_ctx, index));
  17641. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  17642. delete stored;
  17643. return false;
  17644. }
  17645. }
  17646. // A handshake running the previous callback keeps it until it returns.
  17647. delete previous;
  17648. // A resumed handshake shows no certificate to run the callback on.
  17649. if (stored) {
  17650. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  17651. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  17652. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  17653. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  17654. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  17655. #endif
  17656. }
  17657. // Keep requiring the peer's certificate if set_verify_client() asked for it
  17658. auto require =
  17659. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  17660. impl::apply_verify_mode(ssl_ctx, require);
  17661. return true;
  17662. }
  17663. inline long get_verify_error(const_session_t session) {
  17664. if (!session) { return -1; }
  17665. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17666. return SSL_get_verify_result(ssl);
  17667. }
  17668. inline std::string verify_error_string(long error_code) {
  17669. if (error_code == X509_V_OK) { return ""; }
  17670. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17671. return str ? str : "unknown error";
  17672. }
  17673. } // namespace tls
  17674. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17675. /*
  17676. * Group 9: TLS abstraction layer - Mbed TLS backend
  17677. */
  17678. /*
  17679. * Mbed TLS Backend Implementation
  17680. */
  17681. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17682. namespace tls {
  17683. namespace impl {
  17684. // Mbed TLS session wrapper
  17685. struct MbedTlsSession {
  17686. mbedtls_ssl_context ssl;
  17687. socket_t sock = INVALID_SOCKET;
  17688. std::string hostname; // For client: set via set_sni
  17689. std::string sni_hostname; // For server: received from client via SNI callback
  17690. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17691. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17692. // (e.g. a response that arrived while this side was still in its post-write
  17693. // check), the byte is pushed back here and served by the next read().
  17694. unsigned char peeked_byte = 0;
  17695. bool has_peeked_byte = false;
  17696. // Set by set_sni() when the caller disabled hostname verification, so the
  17697. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17698. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17699. // OpenSSL and wolfSSL keep them independent).
  17700. bool suppress_hostname_mismatch = false;
  17701. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17702. // ever runs the callback of its own context.
  17703. VerifyCallback verify_callback;
  17704. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17705. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17706. MbedTlsSession(const MbedTlsSession &) = delete;
  17707. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17708. };
  17709. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17710. // queue)
  17711. inline int &mbedtls_last_error() {
  17712. static thread_local int err = 0;
  17713. return err;
  17714. }
  17715. // Helper to map Mbed TLS error to ErrorCode
  17716. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17717. uint32_t verify_flags) {
  17718. if (ret == 0) { return ErrorCode::Success; }
  17719. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17720. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17721. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17722. return ErrorCode::PeerClosed;
  17723. }
  17724. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17725. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17726. out_errno = errno;
  17727. return ErrorCode::SyscallError;
  17728. }
  17729. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17730. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17731. // the handshake's chain verification (see set_sni()); a mismatch there
  17732. // is reported the same way as any other verify_flags bit. Report it as
  17733. // HostnameMismatch, matching the other backends and the post-handshake
  17734. // identity check below, but only when naming is the sole problem -
  17735. // if the chain itself is also untrusted/expired/etc., that takes
  17736. // priority over the naming detail.
  17737. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17738. return ErrorCode::HostnameMismatch;
  17739. }
  17740. return ErrorCode::CertVerifyFailed;
  17741. }
  17742. return ErrorCode::Fatal;
  17743. }
  17744. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17745. // return value, including the verify-flags-dependent HostnameMismatch
  17746. // mapping; shared by connect() and connect_nonblocking() so the
  17747. // backend_code policy for that mapping only lives in one place.
  17748. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17749. int ret) {
  17750. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17751. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17752. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17753. ? static_cast<uint64_t>(verify_flags)
  17754. : static_cast<uint64_t>(-ret);
  17755. }
  17756. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17757. // non-fatal notification delivered between records, not an error and not
  17758. // application data, so I/O calls that see it should just be retried. Kept in
  17759. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17760. // splitting the closing brace across an #if.
  17761. inline bool mbedtls_is_session_ticket(int ret) {
  17762. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17763. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17764. #else
  17765. (void)ret;
  17766. return false;
  17767. #endif
  17768. }
  17769. // BIO-like send callback for Mbed TLS
  17770. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17771. size_t len) {
  17772. auto sock = *static_cast<socket_t *>(ctx);
  17773. #ifdef _WIN32
  17774. auto ret =
  17775. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17776. if (ret == SOCKET_ERROR) {
  17777. int err = WSAGetLastError();
  17778. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17779. return MBEDTLS_ERR_NET_SEND_FAILED;
  17780. }
  17781. #else
  17782. auto ret = send(sock, buf, len, 0);
  17783. if (ret < 0) {
  17784. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17785. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17786. }
  17787. return MBEDTLS_ERR_NET_SEND_FAILED;
  17788. }
  17789. #endif
  17790. return static_cast<int>(ret);
  17791. }
  17792. // BIO-like recv callback for Mbed TLS
  17793. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17794. auto sock = *static_cast<socket_t *>(ctx);
  17795. #ifdef _WIN32
  17796. auto ret =
  17797. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17798. if (ret == SOCKET_ERROR) {
  17799. int err = WSAGetLastError();
  17800. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17801. return MBEDTLS_ERR_NET_RECV_FAILED;
  17802. }
  17803. #else
  17804. auto ret = recv(sock, buf, len, 0);
  17805. if (ret < 0) {
  17806. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17807. return MBEDTLS_ERR_SSL_WANT_READ;
  17808. }
  17809. return MBEDTLS_ERR_NET_RECV_FAILED;
  17810. }
  17811. #endif
  17812. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17813. return static_cast<int>(ret);
  17814. }
  17815. // MbedTlsContext constructor/destructor implementations
  17816. inline MbedTlsContext::MbedTlsContext() {
  17817. mbedtls_ssl_config_init(&conf);
  17818. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17819. mbedtls_entropy_init(&entropy);
  17820. mbedtls_ctr_drbg_init(&ctr_drbg);
  17821. #endif
  17822. mbedtls_x509_crt_init(&ca_chain);
  17823. mbedtls_x509_crt_init(&own_cert);
  17824. mbedtls_pk_init(&own_key);
  17825. }
  17826. inline MbedTlsContext::~MbedTlsContext() {
  17827. mbedtls_pk_free(&own_key);
  17828. mbedtls_x509_crt_free(&own_cert);
  17829. mbedtls_x509_crt_free(&ca_chain);
  17830. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17831. mbedtls_ctr_drbg_free(&ctr_drbg);
  17832. mbedtls_entropy_free(&entropy);
  17833. #endif
  17834. mbedtls_ssl_config_free(&conf);
  17835. }
  17836. // Thread-local storage for SNI captured during handshake
  17837. // This is needed because the SNI callback doesn't have a way to pass
  17838. // session-specific data before the session is fully set up
  17839. inline std::string &mbedpending_sni() {
  17840. static thread_local std::string sni;
  17841. return sni;
  17842. }
  17843. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17844. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17845. const unsigned char *name, size_t name_len) {
  17846. (void)p_ctx;
  17847. (void)ssl;
  17848. // Store SNI name in thread-local storage
  17849. // It will be retrieved and stored in the session after handshake
  17850. if (name && name_len > 0) {
  17851. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17852. } else {
  17853. mbedpending_sni().clear();
  17854. }
  17855. return 0; // Accept any SNI
  17856. }
  17857. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17858. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17859. }
  17860. // MbedTLS verify callback wrapper
  17861. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17862. int cert_depth, uint32_t *flags) {
  17863. // data points to the MbedTlsSession
  17864. auto *session = static_cast<MbedTlsSession *>(data);
  17865. // set_sni() disabled hostname verification for this session: ignore the
  17866. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  17867. // pass/fail decision still comes from the remaining flags (or, below, from
  17868. // the user's own verify callback).
  17869. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17870. const auto &callback = session->verify_callback;
  17871. if (!callback) { return 0; } // Continue with default verification
  17872. // Build context
  17873. VerifyContext verify_ctx;
  17874. verify_ctx.session = static_cast<session_t>(session);
  17875. verify_ctx.cert = static_cast<cert_t>(crt);
  17876. verify_ctx.depth = cert_depth;
  17877. verify_ctx.preverify_ok = (*flags == 0);
  17878. verify_ctx.error_code = static_cast<long>(*flags);
  17879. // Convert Mbed TLS flags to error string
  17880. static thread_local char error_buf[256];
  17881. if (*flags != 0) {
  17882. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17883. verify_ctx.error_string = error_buf;
  17884. } else {
  17885. verify_ctx.error_string = nullptr;
  17886. }
  17887. bool accepted = run_verify_callback(callback, verify_ctx);
  17888. if (accepted) {
  17889. *flags = 0; // Clear all error flags
  17890. return 0;
  17891. }
  17892. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17893. }
  17894. // Sets the authentication mode from whether the peer's certificate is required
  17895. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  17896. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  17897. inline void apply_verify_mode(MbedTlsContext &mctx) {
  17898. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  17899. if (mctx.verify_client) {
  17900. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  17901. } else if (mctx.verify_callback) {
  17902. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  17903. }
  17904. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  17905. }
  17906. } // namespace impl
  17907. inline ctx_t create_client_context() {
  17908. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17909. if (!ctx) { return nullptr; }
  17910. ctx->is_server = false;
  17911. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17912. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17913. if (!detail::ensure_mbedtls_psa_crypto()) {
  17914. delete ctx;
  17915. return nullptr;
  17916. }
  17917. int ret;
  17918. #else
  17919. // Seed the random number generator
  17920. const char *pers = "httplib_client";
  17921. int ret = mbedtls_ctr_drbg_seed(
  17922. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17923. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17924. if (ret != 0) {
  17925. impl::mbedtls_last_error() = ret;
  17926. delete ctx;
  17927. return nullptr;
  17928. }
  17929. #endif
  17930. // Set up SSL config for client
  17931. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17932. MBEDTLS_SSL_TRANSPORT_STREAM,
  17933. MBEDTLS_SSL_PRESET_DEFAULT);
  17934. if (ret != 0) {
  17935. impl::mbedtls_last_error() = ret;
  17936. delete ctx;
  17937. return nullptr;
  17938. }
  17939. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17940. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17941. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17942. #endif
  17943. // Default: verify peer certificate
  17944. ctx->verify_client = true;
  17945. impl::apply_verify_mode(*ctx);
  17946. // Set minimum TLS version to 1.2
  17947. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17948. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17949. #else
  17950. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17951. MBEDTLS_SSL_MINOR_VERSION_3);
  17952. #endif
  17953. return static_cast<ctx_t>(ctx);
  17954. }
  17955. inline ctx_t create_server_context() {
  17956. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17957. if (!ctx) { return nullptr; }
  17958. ctx->is_server = true;
  17959. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17960. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17961. if (!detail::ensure_mbedtls_psa_crypto()) {
  17962. delete ctx;
  17963. return nullptr;
  17964. }
  17965. int ret;
  17966. #else
  17967. // Seed the random number generator
  17968. const char *pers = "httplib_server";
  17969. int ret = mbedtls_ctr_drbg_seed(
  17970. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17971. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17972. if (ret != 0) {
  17973. impl::mbedtls_last_error() = ret;
  17974. delete ctx;
  17975. return nullptr;
  17976. }
  17977. #endif
  17978. // Set up SSL config for server
  17979. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17980. MBEDTLS_SSL_TRANSPORT_STREAM,
  17981. MBEDTLS_SSL_PRESET_DEFAULT);
  17982. if (ret != 0) {
  17983. impl::mbedtls_last_error() = ret;
  17984. delete ctx;
  17985. return nullptr;
  17986. }
  17987. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17988. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17989. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17990. #endif
  17991. // Default: don't verify client
  17992. impl::apply_verify_mode(*ctx);
  17993. // Set minimum TLS version to 1.2
  17994. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17995. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17996. #else
  17997. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17998. MBEDTLS_SSL_MINOR_VERSION_3);
  17999. #endif
  18000. // Set SNI callback to capture client's SNI hostname
  18001. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18002. return static_cast<ctx_t>(ctx);
  18003. }
  18004. inline void free_context(ctx_t ctx) {
  18005. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18006. }
  18007. inline bool set_min_version(ctx_t ctx, Version version) {
  18008. if (!ctx) { return false; }
  18009. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18010. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18011. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18012. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18013. if (version >= Version::TLS1_3) {
  18014. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18015. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18016. #endif
  18017. }
  18018. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18019. #else
  18020. // Mbed TLS 2.x uses major/minor version numbers
  18021. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18022. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18023. if (version >= Version::TLS1_3) {
  18024. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18025. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18026. #else
  18027. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18028. #endif
  18029. }
  18030. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18031. #endif
  18032. return true;
  18033. }
  18034. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18035. if (!ctx || !pem) { return false; }
  18036. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18037. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18038. // Add null terminator if not present
  18039. std::string pem_str(pem, len);
  18040. int ret = mbedtls_x509_crt_parse(
  18041. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18042. pem_str.size() + 1);
  18043. if (ret != 0) {
  18044. impl::mbedtls_last_error() = ret;
  18045. return false;
  18046. }
  18047. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18048. return true;
  18049. }
  18050. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18051. if (!ctx || !file_path) { return false; }
  18052. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18053. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18054. if (ret != 0) {
  18055. impl::mbedtls_last_error() = ret;
  18056. return false;
  18057. }
  18058. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18059. return true;
  18060. }
  18061. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18062. if (!ctx || !dir_path) { return false; }
  18063. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18064. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18065. if (ret < 0) { // Returns number of certs on success, negative on error
  18066. impl::mbedtls_last_error() = ret;
  18067. return false;
  18068. }
  18069. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18070. return true;
  18071. }
  18072. inline bool load_system_certs(ctx_t ctx) {
  18073. if (!ctx) { return false; }
  18074. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18075. bool loaded = false;
  18076. #ifdef _WIN32
  18077. loaded = impl::enumerate_windows_system_certs(
  18078. [&](const unsigned char *data, size_t len) {
  18079. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18080. });
  18081. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18082. loaded = impl::enumerate_macos_keychain_certs(
  18083. [&](const unsigned char *data, size_t len) {
  18084. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18085. });
  18086. #else
  18087. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18088. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18089. loaded = true;
  18090. break;
  18091. }
  18092. }
  18093. if (!loaded) {
  18094. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18095. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18096. loaded = true;
  18097. break;
  18098. }
  18099. }
  18100. }
  18101. #endif
  18102. if (loaded) {
  18103. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18104. }
  18105. return loaded;
  18106. }
  18107. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18108. const char *password) {
  18109. if (!ctx || !cert || !key) { return false; }
  18110. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18111. // Parse certificate
  18112. std::string cert_str(cert);
  18113. int ret = mbedtls_x509_crt_parse(
  18114. &mctx->own_cert,
  18115. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18116. cert_str.size() + 1);
  18117. if (ret != 0) {
  18118. impl::mbedtls_last_error() = ret;
  18119. return false;
  18120. }
  18121. // Parse private key
  18122. std::string key_str(key);
  18123. const unsigned char *pwd =
  18124. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18125. size_t pwd_len = password ? strlen(password) : 0;
  18126. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18127. ret = mbedtls_pk_parse_key(
  18128. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18129. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18130. &mctx->ctr_drbg);
  18131. #else
  18132. ret = mbedtls_pk_parse_key(
  18133. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18134. key_str.size() + 1, pwd, pwd_len);
  18135. #endif
  18136. if (ret != 0) {
  18137. impl::mbedtls_last_error() = ret;
  18138. return false;
  18139. }
  18140. // Verify that the certificate and private key match.
  18141. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18142. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18143. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18144. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18145. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18146. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18147. #else
  18148. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18149. #endif
  18150. if (ret != 0) {
  18151. impl::mbedtls_last_error() = ret;
  18152. return false;
  18153. }
  18154. #endif
  18155. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18156. if (ret != 0) {
  18157. impl::mbedtls_last_error() = ret;
  18158. return false;
  18159. }
  18160. return true;
  18161. }
  18162. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18163. const char *key_path, const char *password) {
  18164. if (!ctx || !cert_path || !key_path) { return false; }
  18165. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18166. // Parse certificate file
  18167. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18168. if (ret != 0) {
  18169. impl::mbedtls_last_error() = ret;
  18170. return false;
  18171. }
  18172. // Parse private key file
  18173. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18174. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18175. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18176. #else
  18177. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18178. #endif
  18179. if (ret != 0) {
  18180. impl::mbedtls_last_error() = ret;
  18181. return false;
  18182. }
  18183. // Verify that the certificate and private key match.
  18184. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18185. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18186. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18187. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18188. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18189. #else
  18190. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18191. #endif
  18192. if (ret != 0) {
  18193. impl::mbedtls_last_error() = ret;
  18194. return false;
  18195. }
  18196. #endif
  18197. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18198. if (ret != 0) {
  18199. impl::mbedtls_last_error() = ret;
  18200. return false;
  18201. }
  18202. return true;
  18203. }
  18204. inline void set_verify_client(ctx_t ctx, bool require) {
  18205. if (!ctx) { return; }
  18206. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18207. mctx->verify_client = require;
  18208. impl::apply_verify_mode(*mctx);
  18209. }
  18210. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18211. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18212. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18213. auto session = new (std::nothrow) impl::MbedTlsSession();
  18214. if (!session) { return nullptr; }
  18215. session->sock = sock;
  18216. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18217. if (ret != 0) {
  18218. impl::mbedtls_last_error() = ret;
  18219. delete session;
  18220. return nullptr;
  18221. }
  18222. // Explicitly opt out of in-handshake hostname verification by default;
  18223. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18224. // fails outright when no hostname was set. set_sni() installs the real
  18225. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18226. // caller verifies the certificate identity post-handshake via
  18227. // verify_hostname().
  18228. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18229. // Set BIO callbacks
  18230. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18231. impl::mbedtls_net_recv_cb, nullptr);
  18232. // Installed always, as it also masks the hostname mismatch that set_sni()
  18233. // may ask for. The session runs its own copy of the user's callback, which
  18234. // set_verify_callback() cannot replace under a handshake.
  18235. session->verify_callback = mctx->verify_callback;
  18236. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18237. return static_cast<session_t>(session);
  18238. }
  18239. inline void free_session(session_t session) {
  18240. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18241. }
  18242. inline bool set_sni(session_t session, const char *hostname,
  18243. bool verify_hostname) {
  18244. if (!session || !hostname) { return false; }
  18245. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18246. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18247. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18248. // independently, so a disabled hostname check is handled below by masking
  18249. // the resulting mismatch flag instead of skipping this call.
  18250. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18251. if (ret != 0) {
  18252. impl::mbedtls_last_error() = ret;
  18253. return false;
  18254. }
  18255. msession->hostname = hostname;
  18256. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18257. return true;
  18258. }
  18259. inline TlsError connect(session_t session) {
  18260. TlsError err;
  18261. if (!session) {
  18262. err.code = ErrorCode::Fatal;
  18263. return err;
  18264. }
  18265. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18266. int ret;
  18267. do {
  18268. ret = mbedtls_ssl_handshake(&msession->ssl);
  18269. } while (impl::mbedtls_is_session_ticket(ret));
  18270. if (ret == 0) {
  18271. err.code = ErrorCode::Success;
  18272. } else {
  18273. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18274. impl::mbedtls_last_error() = ret;
  18275. }
  18276. return err;
  18277. }
  18278. inline TlsError accept(session_t session) {
  18279. // Same as connect for Mbed TLS - handshake works for both client and server
  18280. auto result = connect(session);
  18281. // After successful handshake, capture SNI from thread-local storage
  18282. if (result.code == ErrorCode::Success && session) {
  18283. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18284. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18285. impl::mbedpending_sni().clear();
  18286. }
  18287. return result;
  18288. }
  18289. inline bool connect_nonblocking(session_t session, socket_t sock,
  18290. time_t timeout_sec, time_t timeout_usec,
  18291. TlsError *err) {
  18292. if (!session) {
  18293. if (err) { err->code = ErrorCode::Fatal; }
  18294. return false;
  18295. }
  18296. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18297. // Set socket to non-blocking mode
  18298. detail::set_nonblocking(sock, true);
  18299. auto cleanup =
  18300. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18301. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18302. int ret;
  18303. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18304. // Non-fatal TLS 1.3 ticket; retry immediately.
  18305. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18306. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18307. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18308. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18309. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18310. }
  18311. // TlsError or timeout
  18312. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18313. impl::mbedtls_last_error() = ret;
  18314. return false;
  18315. }
  18316. if (err) { err->code = ErrorCode::Success; }
  18317. return true;
  18318. }
  18319. inline bool accept_nonblocking(session_t session, socket_t sock,
  18320. time_t timeout_sec, time_t timeout_usec,
  18321. TlsError *err) {
  18322. // Same implementation as connect for Mbed TLS
  18323. bool result =
  18324. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18325. // After successful handshake, capture SNI from thread-local storage
  18326. if (result && session) {
  18327. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18328. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18329. impl::mbedpending_sni().clear();
  18330. }
  18331. return result;
  18332. }
  18333. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18334. if (!session || !buf) {
  18335. err.code = ErrorCode::Fatal;
  18336. return -1;
  18337. }
  18338. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18339. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18340. if (msession->has_peeked_byte) {
  18341. if (len == 0) { return 0; }
  18342. auto p = static_cast<unsigned char *>(buf);
  18343. p[0] = msession->peeked_byte;
  18344. msession->has_peeked_byte = false;
  18345. size_t n = 1;
  18346. // Top up with any already-decrypted bytes without risking a block.
  18347. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18348. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18349. if (extra > 0) { n += static_cast<size_t>(extra); }
  18350. }
  18351. err.code = ErrorCode::Success;
  18352. return static_cast<ssize_t>(n);
  18353. }
  18354. int ret;
  18355. do {
  18356. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18357. len);
  18358. } while (impl::mbedtls_is_session_ticket(ret));
  18359. if (ret > 0) {
  18360. err.code = ErrorCode::Success;
  18361. return static_cast<ssize_t>(ret);
  18362. }
  18363. if (ret == 0) {
  18364. err.code = ErrorCode::PeerClosed;
  18365. return 0;
  18366. }
  18367. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18368. err.backend_code = static_cast<uint64_t>(-ret);
  18369. impl::mbedtls_last_error() = ret;
  18370. // mbedTLS signals a clean close_notify via a negative error code rather
  18371. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18372. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18373. return -1;
  18374. }
  18375. inline ssize_t write(session_t session, const void *buf, size_t len,
  18376. TlsError &err) {
  18377. if (!session || !buf) {
  18378. err.code = ErrorCode::Fatal;
  18379. return -1;
  18380. }
  18381. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18382. int ret;
  18383. do {
  18384. ret = mbedtls_ssl_write(&msession->ssl,
  18385. static_cast<const unsigned char *>(buf), len);
  18386. } while (impl::mbedtls_is_session_ticket(ret));
  18387. if (ret > 0) {
  18388. err.code = ErrorCode::Success;
  18389. return static_cast<ssize_t>(ret);
  18390. }
  18391. if (ret == 0) {
  18392. err.code = ErrorCode::PeerClosed;
  18393. return 0;
  18394. }
  18395. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18396. err.backend_code = static_cast<uint64_t>(-ret);
  18397. impl::mbedtls_last_error() = ret;
  18398. return -1;
  18399. }
  18400. inline int pending(const_session_t session) {
  18401. if (!session) { return 0; }
  18402. auto msession =
  18403. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18404. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18405. (msession->has_peeked_byte ? 1 : 0);
  18406. }
  18407. inline void shutdown(session_t session, bool graceful) {
  18408. if (!session) { return; }
  18409. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18410. if (graceful) {
  18411. // Try to send close_notify, but don't block forever
  18412. int ret;
  18413. int attempts = 0;
  18414. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18415. attempts < 3) {
  18416. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18417. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18418. break;
  18419. }
  18420. attempts++;
  18421. }
  18422. }
  18423. }
  18424. inline bool is_peer_closed(session_t session, socket_t sock) {
  18425. if (!session || sock == INVALID_SOCKET) { return true; }
  18426. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18427. // Check if there's already decrypted or pushed-back data available.
  18428. // If so, the connection is definitely alive.
  18429. if (msession->has_peeked_byte ||
  18430. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18431. return false;
  18432. }
  18433. // Set socket to non-blocking to avoid blocking on read
  18434. detail::set_nonblocking(sock, true);
  18435. auto cleanup =
  18436. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18437. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18438. // on application data — e.g. a response that already arrived — push the
  18439. // byte back so the next read() delivers it instead of losing it.
  18440. unsigned char buf;
  18441. int ret;
  18442. do {
  18443. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18444. } while (impl::mbedtls_is_session_ticket(ret));
  18445. // If we got data or WANT_READ (would block), connection is alive
  18446. if (ret > 0) {
  18447. msession->peeked_byte = buf;
  18448. msession->has_peeked_byte = true;
  18449. return false;
  18450. }
  18451. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18452. // If we get a peer close notify or a connection reset, the peer is closed
  18453. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18454. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18455. }
  18456. inline cert_t get_peer_cert(const_session_t session) {
  18457. if (!session) { return nullptr; }
  18458. auto msession =
  18459. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18460. // Mbed TLS returns a pointer to the internal peer cert chain.
  18461. // WARNING: This pointer is only valid while the session is active.
  18462. // Do not use the certificate after calling free_session().
  18463. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18464. return const_cast<mbedtls_x509_crt *>(cert);
  18465. }
  18466. inline size_t get_peer_certs(const_session_t session,
  18467. std::vector<cert_t> &certs) {
  18468. certs.clear();
  18469. // Mbed TLS parses the whole received chain into a list headed by the peer
  18470. // certificate, owned by the session like get_peer_cert()'s result
  18471. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18472. crt && crt->raw.len > 0; crt = crt->next) {
  18473. certs.push_back(static_cast<cert_t>(crt));
  18474. }
  18475. return certs.size();
  18476. }
  18477. inline void free_cert(cert_t cert) {
  18478. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18479. // chain, so there is nothing to free. Callers still call this for the other
  18480. // backends.
  18481. (void)cert;
  18482. }
  18483. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18484. if (!cert || !hostname) { return false; }
  18485. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18486. std::string host_str(hostname);
  18487. // Check if hostname is an IP address (IPv4 or IPv6)
  18488. unsigned char ip_bytes[16];
  18489. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18490. auto is_ip = ip_len > 0;
  18491. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18492. // in buf.tag and the raw value in buf.p / buf.len.
  18493. auto has_dns_san = false;
  18494. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  18495. if (!san->buf.p || san->buf.len == 0) { continue; }
  18496. const unsigned char *p = san->buf.p;
  18497. size_t len = san->buf.len;
  18498. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18499. if (is_ip) {
  18500. // For an IP host, only a matching iPAddress SAN of the same family
  18501. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18502. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18503. memcmp(p, ip_bytes, ip_len) == 0) {
  18504. return true;
  18505. }
  18506. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18507. has_dns_san = true;
  18508. std::string san_name(reinterpret_cast<const char *>(p), len);
  18509. if (detail::match_hostname(san_name, host_str)) { return true; }
  18510. }
  18511. }
  18512. // Fallback: the Common Names (CN) in the subject, as X509_check_host does it:
  18513. // never for an IP host, which only an iPAddress SAN names, and never next to
  18514. // a DNS SAN (RFC 6125 6.4.4).
  18515. if (is_ip || has_dns_san) { return false; }
  18516. for (auto name = &mcert->subject; name; name = name->next) {
  18517. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18518. std::string cn(reinterpret_cast<const char *>(name->val.p),
  18519. name->val.len);
  18520. if (detail::match_hostname(cn, host_str)) { return true; }
  18521. }
  18522. }
  18523. return false;
  18524. }
  18525. inline uint64_t hostname_mismatch_code() {
  18526. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18527. }
  18528. inline long get_verify_result(const_session_t session) {
  18529. if (!session) { return -1; }
  18530. auto msession =
  18531. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18532. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18533. // Return 0 (X509_V_OK equivalent) if verification passed
  18534. return flags == 0 ? 0 : static_cast<long>(flags);
  18535. }
  18536. inline std::string get_cert_subject_cn(cert_t cert) {
  18537. if (!cert) return "";
  18538. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18539. // Find the CN in the subject
  18540. const mbedtls_x509_name *name = &x509->subject;
  18541. while (name != nullptr) {
  18542. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18543. return std::string(reinterpret_cast<const char *>(name->val.p),
  18544. name->val.len);
  18545. }
  18546. name = name->next;
  18547. }
  18548. return "";
  18549. }
  18550. inline std::string get_cert_issuer_name(cert_t cert) {
  18551. if (!cert) return "";
  18552. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18553. // Build a human-readable issuer name string
  18554. char buf[512];
  18555. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18556. if (ret < 0) return "";
  18557. return std::string(buf);
  18558. }
  18559. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18560. sans.clear();
  18561. if (!cert) return false;
  18562. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18563. // Parse the Subject Alternative Name extension
  18564. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18565. while (cur != nullptr) {
  18566. if (cur->buf.len > 0) {
  18567. const unsigned char *p = cur->buf.p;
  18568. size_t value_len = cur->buf.len;
  18569. SanEntry entry;
  18570. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18571. case MBEDTLS_X509_SAN_DNS_NAME:
  18572. entry.type = SanType::DNS;
  18573. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18574. break;
  18575. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18576. entry.type = SanType::IP;
  18577. if (value_len == 4) {
  18578. // IPv4
  18579. char buf[16];
  18580. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18581. entry.value = buf;
  18582. } else if (value_len == 16) {
  18583. // IPv6
  18584. char buf[64];
  18585. snprintf(buf, sizeof(buf),
  18586. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18587. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18588. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18589. p[10], p[11], p[12], p[13], p[14], p[15]);
  18590. entry.value = buf;
  18591. }
  18592. break;
  18593. case MBEDTLS_X509_SAN_RFC822_NAME:
  18594. entry.type = SanType::EMAIL;
  18595. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18596. break;
  18597. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18598. entry.type = SanType::URI;
  18599. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18600. break;
  18601. default: entry.type = SanType::OTHER; break;
  18602. }
  18603. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18604. }
  18605. cur = cur->next;
  18606. }
  18607. return true;
  18608. }
  18609. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18610. time_t &not_after) {
  18611. if (!cert) return false;
  18612. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18613. // Convert mbedtls_x509_time to time_t
  18614. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18615. struct tm tm_time = {};
  18616. tm_time.tm_year = t.year - 1900;
  18617. tm_time.tm_mon = t.mon - 1;
  18618. tm_time.tm_mday = t.day;
  18619. tm_time.tm_hour = t.hour;
  18620. tm_time.tm_min = t.min;
  18621. tm_time.tm_sec = t.sec;
  18622. #ifdef _WIN32
  18623. return _mkgmtime(&tm_time);
  18624. #else
  18625. return timegm(&tm_time);
  18626. #endif
  18627. };
  18628. not_before = to_time_t(x509->valid_from);
  18629. not_after = to_time_t(x509->valid_to);
  18630. return true;
  18631. }
  18632. inline std::string get_cert_serial(cert_t cert) {
  18633. if (!cert) return "";
  18634. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18635. // Convert serial number to hex string
  18636. std::string result;
  18637. result.reserve(x509->serial.len * 2);
  18638. for (size_t i = 0; i < x509->serial.len; i++) {
  18639. char hex[3];
  18640. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18641. result += hex;
  18642. }
  18643. return result;
  18644. }
  18645. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18646. if (!cert) return false;
  18647. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18648. if (!crt->raw.p || crt->raw.len == 0) return false;
  18649. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18650. return true;
  18651. }
  18652. inline const char *get_sni(const_session_t session) {
  18653. if (!session) return nullptr;
  18654. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18655. // For server: return SNI received from client during handshake
  18656. if (!msession->sni_hostname.empty()) {
  18657. return msession->sni_hostname.c_str();
  18658. }
  18659. // For client: return the hostname set via set_sni
  18660. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18661. return nullptr;
  18662. }
  18663. inline uint64_t peek_error() {
  18664. // Mbed TLS doesn't have an error queue, return the last error
  18665. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18666. }
  18667. inline uint64_t get_error() {
  18668. // Mbed TLS doesn't have an error queue, return and clear the last error
  18669. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18670. impl::mbedtls_last_error() = 0;
  18671. return err;
  18672. }
  18673. inline std::string error_string(uint64_t code) {
  18674. char buf[256];
  18675. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18676. return std::string(buf);
  18677. }
  18678. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18679. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18680. if (!ca_chain) { return nullptr; }
  18681. mbedtls_x509_crt_init(ca_chain);
  18682. // mbedtls_x509_crt_parse expects null-terminated PEM
  18683. int ret = mbedtls_x509_crt_parse(ca_chain,
  18684. reinterpret_cast<const unsigned char *>(pem),
  18685. len + 1); // +1 for null terminator
  18686. if (ret != 0) {
  18687. // Try without +1 in case PEM is already null-terminated
  18688. ret = mbedtls_x509_crt_parse(
  18689. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18690. if (ret != 0) {
  18691. mbedtls_x509_crt_free(ca_chain);
  18692. delete ca_chain;
  18693. return nullptr;
  18694. }
  18695. }
  18696. return static_cast<ca_store_t>(ca_chain);
  18697. }
  18698. inline void free_ca_store(ca_store_t store) {
  18699. if (store) {
  18700. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18701. mbedtls_x509_crt_free(ca_chain);
  18702. delete ca_chain;
  18703. }
  18704. }
  18705. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18706. if (!ctx || !store) { return false; }
  18707. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18708. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18709. // Free existing CA chain
  18710. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18711. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18712. // Copy the CA chain (deep copy)
  18713. // Parse from the raw data of the source cert
  18714. mbedtls_x509_crt *src = ca_chain;
  18715. while (src != nullptr) {
  18716. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18717. src->raw.len);
  18718. if (ret != 0) {
  18719. free_ca_store(store);
  18720. return false;
  18721. }
  18722. src = src->next;
  18723. }
  18724. // This function takes ownership of the store; the chain was deep-copied
  18725. // above, so release the source
  18726. free_ca_store(store);
  18727. // Update the SSL config to use the new CA chain
  18728. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18729. return true;
  18730. }
  18731. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18732. certs.clear();
  18733. if (!ctx) { return 0; }
  18734. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18735. // Owned by the context; see free_cert()
  18736. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  18737. cert = cert->next) {
  18738. certs.push_back(static_cast<cert_t>(cert));
  18739. }
  18740. return certs.size();
  18741. }
  18742. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18743. std::vector<std::string> names;
  18744. if (!ctx) { return names; }
  18745. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18746. // Iterate through the CA chain
  18747. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18748. while (cert != nullptr && cert->raw.len > 0) {
  18749. char buf[512];
  18750. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18751. if (ret > 0) { names.push_back(buf); }
  18752. cert = cert->next;
  18753. }
  18754. return names;
  18755. }
  18756. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18757. const char *key_pem, const char *password) {
  18758. if (!ctx || !cert_pem || !key_pem) { return false; }
  18759. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18760. // Parse into new objects first, so that a bad pair leaves the old one in
  18761. // place, and swap them in after; the old ones are freed on the way out.
  18762. mbedtls_x509_crt cert;
  18763. mbedtls_pk_context key;
  18764. mbedtls_x509_crt_init(&cert);
  18765. mbedtls_pk_init(&key);
  18766. auto se = detail::scope_exit([&] {
  18767. mbedtls_x509_crt_free(&cert);
  18768. mbedtls_pk_free(&key);
  18769. });
  18770. // Parse certificate PEM
  18771. int ret = mbedtls_x509_crt_parse(
  18772. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18773. strlen(cert_pem) + 1);
  18774. if (ret != 0) {
  18775. impl::mbedtls_last_error() = ret;
  18776. return false;
  18777. }
  18778. // Parse private key PEM
  18779. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18780. ret = mbedtls_pk_parse_key(
  18781. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18782. strlen(key_pem) + 1,
  18783. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18784. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18785. &mbed_ctx->ctr_drbg);
  18786. #else
  18787. ret = mbedtls_pk_parse_key(
  18788. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18789. strlen(key_pem) + 1,
  18790. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18791. password ? strlen(password) : 0);
  18792. #endif
  18793. if (ret != 0) {
  18794. impl::mbedtls_last_error() = ret;
  18795. return false;
  18796. }
  18797. std::swap(mbed_ctx->own_cert, cert);
  18798. std::swap(mbed_ctx->own_key, key);
  18799. // Configure SSL to use the new certificate and key
  18800. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18801. &mbed_ctx->own_key);
  18802. if (ret != 0) {
  18803. impl::mbedtls_last_error() = ret;
  18804. return false;
  18805. }
  18806. return true;
  18807. }
  18808. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18809. if (!ctx || !ca_pem) { return false; }
  18810. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18811. // Parse into a new chain first, so that a bad one leaves the old in place
  18812. mbedtls_x509_crt chain;
  18813. mbedtls_x509_crt_init(&chain);
  18814. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  18815. // Parse CA PEM
  18816. int ret = mbedtls_x509_crt_parse(
  18817. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18818. strlen(ca_pem) + 1);
  18819. if (ret != 0) {
  18820. impl::mbedtls_last_error() = ret;
  18821. return false;
  18822. }
  18823. std::swap(mbed_ctx->ca_chain, chain);
  18824. // Update SSL config to use new CA chain
  18825. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18826. return true;
  18827. }
  18828. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18829. if (!ctx) { return false; }
  18830. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18831. // create_session() hands each session its own copy to run.
  18832. mbed_ctx->verify_callback = std::move(callback);
  18833. impl::apply_verify_mode(*mbed_ctx);
  18834. return true;
  18835. }
  18836. inline long get_verify_error(const_session_t session) {
  18837. if (!session) { return -1; }
  18838. auto *msession =
  18839. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18840. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18841. }
  18842. inline std::string verify_error_string(long error_code) {
  18843. if (error_code == 0) { return ""; }
  18844. char buf[256];
  18845. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18846. static_cast<uint32_t>(error_code));
  18847. // Remove trailing newline if present
  18848. std::string result(buf);
  18849. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18850. result.pop_back();
  18851. }
  18852. return result;
  18853. }
  18854. } // namespace tls
  18855. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18856. /*
  18857. * Group 10: TLS abstraction layer - wolfSSL backend
  18858. */
  18859. /*
  18860. * wolfSSL Backend Implementation
  18861. */
  18862. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18863. namespace tls {
  18864. namespace impl {
  18865. // wolfSSL session wrapper
  18866. struct WolfSSLSession {
  18867. WOLFSSL *ssl = nullptr;
  18868. socket_t sock = INVALID_SOCKET;
  18869. std::string hostname; // For client: set via set_sni
  18870. std::string sni_hostname; // For server: received from client via SNI callback
  18871. WolfSSLSession() = default;
  18872. ~WolfSSLSession() {
  18873. if (ssl) { wolfSSL_free(ssl); }
  18874. }
  18875. WolfSSLSession(const WolfSSLSession &) = delete;
  18876. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18877. };
  18878. // Thread-local error code accessor for wolfSSL
  18879. inline uint64_t &wolfssl_last_error() {
  18880. static thread_local uint64_t err = 0;
  18881. return err;
  18882. }
  18883. // Helper to map wolfSSL error to ErrorCode.
  18884. // ssl_error is the value from wolfSSL_get_error().
  18885. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18886. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18887. int &out_errno) {
  18888. switch (ssl_error) {
  18889. case SSL_ERROR_NONE: return ErrorCode::Success;
  18890. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18891. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18892. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18893. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18894. default:
  18895. if (ssl) {
  18896. // wolfSSL stores the low-level error code as a negative value.
  18897. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18898. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18899. if (low_err == DOMAIN_NAME_MISMATCH) {
  18900. return ErrorCode::HostnameMismatch;
  18901. }
  18902. // Check verify result to distinguish cert verification from generic SSL
  18903. // errors.
  18904. long vr = wolfSSL_get_verify_result(ssl);
  18905. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18906. }
  18907. return ErrorCode::Fatal;
  18908. }
  18909. }
  18910. // WolfSSLContext constructor/destructor implementations
  18911. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18912. inline WolfSSLContext::~WolfSSLContext() {
  18913. if (ctx) { wolfSSL_CTX_free(ctx); }
  18914. }
  18915. // Thread-local storage for SNI captured during handshake
  18916. inline std::string &wolfssl_pending_sni() {
  18917. static thread_local std::string sni;
  18918. return sni;
  18919. }
  18920. // SNI callback for wolfSSL server to capture client's SNI hostname
  18921. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18922. (void)ret;
  18923. (void)exArg;
  18924. void *name_data = nullptr;
  18925. unsigned short name_len =
  18926. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18927. if (name_data && name_len > 0) {
  18928. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18929. name_len);
  18930. } else {
  18931. wolfssl_pending_sni().clear();
  18932. }
  18933. return 0; // Continue regardless
  18934. }
  18935. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18936. // runs the verify callback of its own context.
  18937. inline int context_ex_data_index() {
  18938. static const auto index =
  18939. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18940. return index;
  18941. }
  18942. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  18943. // other tls:: function takes.
  18944. inline int session_ex_data_index() {
  18945. static const auto index =
  18946. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18947. return index;
  18948. }
  18949. // A resumed session skips the client's certificate, so a server that checks
  18950. // one would let in a certificate checked against another server's CA, as
  18951. // wolfSSL shares its session cache between contexts, or against a CA since
  18952. // replaced by update_server_client_ca().
  18953. inline void disable_server_resumption(WolfSSLContext *wctx) {
  18954. if (!wctx->is_server) { return; }
  18955. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  18956. #ifdef HAVE_SESSION_TICKET
  18957. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  18958. #endif
  18959. }
  18960. // wolfSSL verify callback wrapper
  18961. inline int wolfssl_verify_callback(int preverify_ok,
  18962. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18963. // Get the WOLFSSL object from the X509_STORE_CTX
  18964. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18965. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18966. if (!ssl) { return preverify_ok; }
  18967. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  18968. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  18969. if (!wctx) { return preverify_ok; }
  18970. std::shared_ptr<VerifyCallback> callback;
  18971. {
  18972. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  18973. callback = wctx->verify_callback;
  18974. }
  18975. if (!callback) { return preverify_ok; }
  18976. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18977. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18978. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18979. VerifyContext verify_ctx;
  18980. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  18981. verify_ctx.cert = static_cast<cert_t>(cert);
  18982. verify_ctx.depth = depth;
  18983. verify_ctx.preverify_ok = (preverify_ok != 0);
  18984. verify_ctx.error_code = static_cast<long>(err);
  18985. if (err != 0) {
  18986. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18987. } else {
  18988. verify_ctx.error_string = nullptr;
  18989. }
  18990. bool accepted = run_verify_callback(*callback, verify_ctx);
  18991. return accepted ? 1 : 0;
  18992. }
  18993. // Sets the verify mode from whether the peer's certificate is required and
  18994. // whether a verify callback is set.
  18995. inline void apply_verify_mode(WolfSSLContext &wctx) {
  18996. auto has_callback = static_cast<bool>(wctx.verify_callback);
  18997. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  18998. auto mode = wctx.verify_client
  18999. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19000. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19001. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19002. has_callback ? wolfssl_verify_callback : nullptr);
  19003. }
  19004. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19005. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19006. wolfSSL_CTX_set_default_passwd_cb(
  19007. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19008. auto *pwd = static_cast<const char *>(userdata);
  19009. if (!pwd) return 0;
  19010. auto len = static_cast<int>(strlen(pwd));
  19011. if (len > size) len = size;
  19012. memcpy(buf, pwd, static_cast<size_t>(len));
  19013. return len;
  19014. });
  19015. }
  19016. } // namespace impl
  19017. inline ctx_t create_client_context() {
  19018. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19019. if (!ctx) { return nullptr; }
  19020. ctx->is_server = false;
  19021. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19022. if (!method) {
  19023. delete ctx;
  19024. return nullptr;
  19025. }
  19026. ctx->ctx = wolfSSL_CTX_new(method);
  19027. if (!ctx->ctx ||
  19028. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19029. WOLFSSL_SUCCESS) {
  19030. delete ctx;
  19031. return nullptr;
  19032. }
  19033. // Default: verify peer certificate
  19034. ctx->verify_client = true;
  19035. impl::apply_verify_mode(*ctx);
  19036. return static_cast<ctx_t>(ctx);
  19037. }
  19038. inline ctx_t create_server_context() {
  19039. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19040. if (!ctx) { return nullptr; }
  19041. ctx->is_server = true;
  19042. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19043. if (!method) {
  19044. delete ctx;
  19045. return nullptr;
  19046. }
  19047. ctx->ctx = wolfSSL_CTX_new(method);
  19048. if (!ctx->ctx ||
  19049. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19050. WOLFSSL_SUCCESS) {
  19051. delete ctx;
  19052. return nullptr;
  19053. }
  19054. // Default: don't verify client
  19055. impl::apply_verify_mode(*ctx);
  19056. // Enable SNI on server
  19057. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19058. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19059. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19060. return static_cast<ctx_t>(ctx);
  19061. }
  19062. inline void free_context(ctx_t ctx) {
  19063. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19064. }
  19065. inline bool set_min_version(ctx_t ctx, Version version) {
  19066. if (!ctx) { return false; }
  19067. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19068. int min_ver = WOLFSSL_TLSV1_2;
  19069. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19070. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19071. }
  19072. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19073. if (!ctx || !pem) { return false; }
  19074. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19075. int ret = wolfSSL_CTX_load_verify_buffer(
  19076. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19077. static_cast<long>(len), SSL_FILETYPE_PEM);
  19078. if (ret != SSL_SUCCESS) {
  19079. impl::wolfssl_last_error() =
  19080. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19081. return false;
  19082. }
  19083. wctx->ca_pem_data_.append(pem, len);
  19084. return true;
  19085. }
  19086. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19087. if (!ctx || !file_path) { return false; }
  19088. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19089. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19090. if (ret != SSL_SUCCESS) {
  19091. impl::wolfssl_last_error() =
  19092. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19093. return false;
  19094. }
  19095. return true;
  19096. }
  19097. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19098. if (!ctx || !dir_path) { return false; }
  19099. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19100. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19101. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19102. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19103. // immediately. Return true even on failure since the CA file may have
  19104. // already been loaded, matching OpenSSL's lenient behavior.
  19105. (void)ret;
  19106. return true;
  19107. }
  19108. inline bool load_system_certs(ctx_t ctx) {
  19109. if (!ctx) { return false; }
  19110. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19111. bool loaded = false;
  19112. #ifdef _WIN32
  19113. loaded = impl::enumerate_windows_system_certs(
  19114. [&](const unsigned char *data, size_t len) {
  19115. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19116. static_cast<long>(len),
  19117. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19118. });
  19119. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19120. loaded = impl::enumerate_macos_keychain_certs(
  19121. [&](const unsigned char *data, size_t len) {
  19122. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19123. static_cast<long>(len),
  19124. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19125. });
  19126. #else
  19127. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19128. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19129. SSL_SUCCESS) {
  19130. loaded = true;
  19131. break;
  19132. }
  19133. }
  19134. if (!loaded) {
  19135. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19136. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19137. SSL_SUCCESS) {
  19138. loaded = true;
  19139. break;
  19140. }
  19141. }
  19142. }
  19143. #endif
  19144. return loaded;
  19145. }
  19146. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19147. const char *password) {
  19148. if (!ctx || !cert || !key) { return false; }
  19149. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19150. // Load certificate
  19151. int ret = wolfSSL_CTX_use_certificate_buffer(
  19152. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19153. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19154. if (ret != SSL_SUCCESS) {
  19155. impl::wolfssl_last_error() =
  19156. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19157. return false;
  19158. }
  19159. // Set password callback if password is provided
  19160. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19161. // Load private key
  19162. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19163. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19164. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19165. if (ret != SSL_SUCCESS) {
  19166. impl::wolfssl_last_error() =
  19167. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19168. return false;
  19169. }
  19170. // Verify that the certificate and private key match
  19171. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19172. }
  19173. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19174. const char *key_path, const char *password) {
  19175. if (!ctx || !cert_path || !key_path) { return false; }
  19176. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19177. // Load certificate file
  19178. int ret =
  19179. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19180. if (ret != SSL_SUCCESS) {
  19181. impl::wolfssl_last_error() =
  19182. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19183. return false;
  19184. }
  19185. // Set password callback if password is provided
  19186. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19187. // Load private key file
  19188. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19189. if (ret != SSL_SUCCESS) {
  19190. impl::wolfssl_last_error() =
  19191. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19192. return false;
  19193. }
  19194. // Verify that the certificate and private key match
  19195. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19196. }
  19197. inline void set_verify_client(ctx_t ctx, bool require) {
  19198. if (!ctx) { return; }
  19199. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19200. wctx->verify_client = require;
  19201. impl::apply_verify_mode(*wctx);
  19202. }
  19203. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19204. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19205. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19206. auto session = new (std::nothrow) impl::WolfSSLSession();
  19207. if (!session) { return nullptr; }
  19208. session->sock = sock;
  19209. session->ssl = wolfSSL_new(wctx->ctx);
  19210. if (!session->ssl) {
  19211. impl::wolfssl_last_error() =
  19212. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19213. delete session;
  19214. return nullptr;
  19215. }
  19216. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19217. session) != WOLFSSL_SUCCESS) {
  19218. delete session;
  19219. return nullptr;
  19220. }
  19221. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19222. return static_cast<session_t>(session);
  19223. }
  19224. inline void free_session(session_t session) {
  19225. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19226. }
  19227. inline bool set_sni(session_t session, const char *hostname,
  19228. bool verify_hostname) {
  19229. if (!session || !hostname) { return false; }
  19230. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19231. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19232. static_cast<word16>(strlen(hostname)));
  19233. if (ret != WOLFSSL_SUCCESS) {
  19234. impl::wolfssl_last_error() =
  19235. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19236. return false;
  19237. }
  19238. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19239. // separately from the SNI extension sent above; skip it when hostname
  19240. // verification is disabled so only the chain is checked, matching OpenSSL.
  19241. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19242. wsession->hostname = hostname;
  19243. return true;
  19244. }
  19245. inline TlsError connect(session_t session) {
  19246. TlsError err;
  19247. if (!session) {
  19248. err.code = ErrorCode::Fatal;
  19249. return err;
  19250. }
  19251. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19252. int ret = wolfSSL_connect(wsession->ssl);
  19253. if (ret == SSL_SUCCESS) {
  19254. err.code = ErrorCode::Success;
  19255. } else {
  19256. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19257. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19258. err.backend_code = static_cast<uint64_t>(ssl_error);
  19259. impl::wolfssl_last_error() = err.backend_code;
  19260. }
  19261. return err;
  19262. }
  19263. inline TlsError accept(session_t session) {
  19264. TlsError err;
  19265. if (!session) {
  19266. err.code = ErrorCode::Fatal;
  19267. return err;
  19268. }
  19269. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19270. int ret = wolfSSL_accept(wsession->ssl);
  19271. if (ret == SSL_SUCCESS) {
  19272. err.code = ErrorCode::Success;
  19273. // Capture SNI from thread-local storage after successful handshake
  19274. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19275. impl::wolfssl_pending_sni().clear();
  19276. } else {
  19277. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19278. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19279. err.backend_code = static_cast<uint64_t>(ssl_error);
  19280. impl::wolfssl_last_error() = err.backend_code;
  19281. }
  19282. return err;
  19283. }
  19284. inline bool connect_nonblocking(session_t session, socket_t sock,
  19285. time_t timeout_sec, time_t timeout_usec,
  19286. TlsError *err) {
  19287. if (!session) {
  19288. if (err) { err->code = ErrorCode::Fatal; }
  19289. return false;
  19290. }
  19291. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19292. // Set socket to non-blocking mode
  19293. detail::set_nonblocking(sock, true);
  19294. auto cleanup =
  19295. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19296. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19297. int ret;
  19298. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19299. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19300. if (ssl_error == SSL_ERROR_WANT_READ) {
  19301. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19302. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19303. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19304. }
  19305. // Error or timeout
  19306. if (err) {
  19307. err->code =
  19308. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19309. err->backend_code = static_cast<uint64_t>(ssl_error);
  19310. }
  19311. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19312. return false;
  19313. }
  19314. if (err) { err->code = ErrorCode::Success; }
  19315. return true;
  19316. }
  19317. inline bool accept_nonblocking(session_t session, socket_t sock,
  19318. time_t timeout_sec, time_t timeout_usec,
  19319. TlsError *err) {
  19320. if (!session) {
  19321. if (err) { err->code = ErrorCode::Fatal; }
  19322. return false;
  19323. }
  19324. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19325. // Set socket to non-blocking mode
  19326. detail::set_nonblocking(sock, true);
  19327. auto cleanup =
  19328. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19329. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19330. int ret;
  19331. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19332. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19333. if (ssl_error == SSL_ERROR_WANT_READ) {
  19334. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19335. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19336. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19337. }
  19338. // Error or timeout
  19339. if (err) {
  19340. err->code =
  19341. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19342. err->backend_code = static_cast<uint64_t>(ssl_error);
  19343. }
  19344. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19345. return false;
  19346. }
  19347. if (err) { err->code = ErrorCode::Success; }
  19348. // Capture SNI from thread-local storage after successful handshake
  19349. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19350. impl::wolfssl_pending_sni().clear();
  19351. return true;
  19352. }
  19353. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19354. if (!session || !buf) {
  19355. err.code = ErrorCode::Fatal;
  19356. return -1;
  19357. }
  19358. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19359. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19360. if (ret > 0) {
  19361. err.code = ErrorCode::Success;
  19362. return static_cast<ssize_t>(ret);
  19363. }
  19364. if (ret == 0) {
  19365. err.code = ErrorCode::PeerClosed;
  19366. return 0;
  19367. }
  19368. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19369. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19370. err.backend_code = static_cast<uint64_t>(ssl_error);
  19371. impl::wolfssl_last_error() = err.backend_code;
  19372. return -1;
  19373. }
  19374. inline ssize_t write(session_t session, const void *buf, size_t len,
  19375. TlsError &err) {
  19376. if (!session || !buf) {
  19377. err.code = ErrorCode::Fatal;
  19378. return -1;
  19379. }
  19380. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19381. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19382. if (ret > 0) {
  19383. err.code = ErrorCode::Success;
  19384. return static_cast<ssize_t>(ret);
  19385. }
  19386. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19387. // Treat this as an error (return -1) so callers don't spin in a
  19388. // write loop adding zero to the offset.
  19389. if (ret == 0) {
  19390. err.code = ErrorCode::PeerClosed;
  19391. return -1;
  19392. }
  19393. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19394. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19395. err.backend_code = static_cast<uint64_t>(ssl_error);
  19396. impl::wolfssl_last_error() = err.backend_code;
  19397. return -1;
  19398. }
  19399. inline int pending(const_session_t session) {
  19400. if (!session) { return 0; }
  19401. auto wsession =
  19402. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19403. return wolfSSL_pending(wsession->ssl);
  19404. }
  19405. inline void shutdown(session_t session, bool graceful) {
  19406. if (!session) { return; }
  19407. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19408. if (graceful) {
  19409. int ret;
  19410. int attempts = 0;
  19411. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19412. attempts < 3) {
  19413. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19414. if (ssl_error != SSL_ERROR_WANT_READ &&
  19415. ssl_error != SSL_ERROR_WANT_WRITE) {
  19416. break;
  19417. }
  19418. attempts++;
  19419. }
  19420. } else {
  19421. wolfSSL_shutdown(wsession->ssl);
  19422. }
  19423. }
  19424. inline bool is_peer_closed(session_t session, socket_t sock) {
  19425. if (!session || sock == INVALID_SOCKET) { return true; }
  19426. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19427. // Check if there's already decrypted data available
  19428. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19429. // Set socket to non-blocking to avoid blocking on read
  19430. detail::set_nonblocking(sock, true);
  19431. auto cleanup =
  19432. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19433. // Peek 1 byte to check connection status without consuming data
  19434. unsigned char buf;
  19435. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19436. // If we got data or WANT_READ (would block), connection is alive
  19437. if (ret > 0) { return false; }
  19438. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19439. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19440. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19441. ret == 0;
  19442. }
  19443. inline cert_t get_peer_cert(const_session_t session) {
  19444. if (!session) { return nullptr; }
  19445. auto wsession =
  19446. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19447. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19448. return static_cast<cert_t>(cert);
  19449. }
  19450. inline size_t get_peer_certs(const_session_t session,
  19451. std::vector<cert_t> &certs) {
  19452. certs.clear();
  19453. if (!session) { return 0; }
  19454. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19455. #ifdef SESSION_CERTS
  19456. auto wsession =
  19457. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19458. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19459. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19460. for (int i = 0; i < count; i++) {
  19461. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19462. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19463. }
  19464. #endif
  19465. return certs.size();
  19466. }
  19467. inline void free_cert(cert_t cert) {
  19468. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19469. }
  19470. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19471. if (!cert || !hostname) { return false; }
  19472. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19473. std::string host_str(hostname);
  19474. // Check if hostname is an IP address (IPv4 or IPv6)
  19475. unsigned char ip_bytes[16];
  19476. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19477. auto is_ip = ip_len > 0;
  19478. // Check Subject Alternative Names
  19479. auto has_dns_san = false;
  19480. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19481. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19482. if (san_names) {
  19483. int san_count = wolfSSL_sk_num(san_names);
  19484. for (int i = 0; i < san_count; i++) {
  19485. auto *names =
  19486. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19487. if (!names) continue;
  19488. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19489. // DNS name
  19490. has_dns_san = true;
  19491. unsigned char *dns_name = nullptr;
  19492. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19493. if (dns_name && dns_len > 0) {
  19494. std::string san_name(reinterpret_cast<char *>(dns_name),
  19495. static_cast<size_t>(dns_len));
  19496. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19497. if (detail::match_hostname(san_name, host_str)) {
  19498. wolfSSL_sk_free(san_names);
  19499. return true;
  19500. }
  19501. }
  19502. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19503. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19504. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19505. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19506. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19507. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19508. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19509. wolfSSL_sk_free(san_names);
  19510. return true;
  19511. }
  19512. }
  19513. }
  19514. wolfSSL_sk_free(san_names);
  19515. }
  19516. // Fallback: the Common Name (CN) in the subject, as X509_check_host does it:
  19517. // never for an IP host, which only an iPAddress SAN names, and never next to
  19518. // a DNS SAN (RFC 6125 6.4.4).
  19519. if (is_ip || has_dns_san) { return false; }
  19520. auto cn = get_cert_subject_cn(cert);
  19521. return !cn.empty() && detail::match_hostname(cn, host_str);
  19522. }
  19523. inline uint64_t hostname_mismatch_code() {
  19524. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19525. }
  19526. inline long get_verify_result(const_session_t session) {
  19527. if (!session) { return -1; }
  19528. auto wsession =
  19529. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19530. long result = wolfSSL_get_verify_result(wsession->ssl);
  19531. return result;
  19532. }
  19533. inline std::string get_cert_subject_cn(cert_t cert) {
  19534. if (!cert) return "";
  19535. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19536. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19537. if (!subject) return "";
  19538. char cn[256] = {};
  19539. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19540. sizeof(cn));
  19541. if (cn_len <= 0) return "";
  19542. return std::string(cn, static_cast<size_t>(cn_len));
  19543. }
  19544. inline std::string get_cert_issuer_name(cert_t cert) {
  19545. if (!cert) return "";
  19546. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19547. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19548. if (!issuer) return "";
  19549. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19550. if (!name_str) return "";
  19551. std::string result(name_str);
  19552. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19553. return result;
  19554. }
  19555. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19556. sans.clear();
  19557. if (!cert) return false;
  19558. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19559. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19560. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19561. if (!san_names) return true; // No SANs is not an error
  19562. int count = wolfSSL_sk_num(san_names);
  19563. for (int i = 0; i < count; i++) {
  19564. auto *name =
  19565. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19566. if (!name) continue;
  19567. SanEntry entry;
  19568. switch (name->type) {
  19569. case WOLFSSL_GEN_DNS: {
  19570. entry.type = SanType::DNS;
  19571. unsigned char *dns_name = nullptr;
  19572. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19573. if (dns_name && dns_len > 0) {
  19574. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19575. static_cast<size_t>(dns_len));
  19576. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19577. }
  19578. break;
  19579. }
  19580. case WOLFSSL_GEN_IPADD: {
  19581. entry.type = SanType::IP;
  19582. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19583. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19584. if (ip_data && ip_len == 4) {
  19585. char buf[16];
  19586. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19587. ip_data[2], ip_data[3]);
  19588. entry.value = buf;
  19589. } else if (ip_data && ip_len == 16) {
  19590. char buf[64];
  19591. snprintf(buf, sizeof(buf),
  19592. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19593. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19594. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19595. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19596. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19597. ip_data[14], ip_data[15]);
  19598. entry.value = buf;
  19599. }
  19600. break;
  19601. }
  19602. case WOLFSSL_GEN_EMAIL:
  19603. entry.type = SanType::EMAIL;
  19604. {
  19605. unsigned char *email = nullptr;
  19606. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19607. if (email && email_len > 0) {
  19608. entry.value = std::string(reinterpret_cast<char *>(email),
  19609. static_cast<size_t>(email_len));
  19610. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19611. }
  19612. }
  19613. break;
  19614. case WOLFSSL_GEN_URI:
  19615. entry.type = SanType::URI;
  19616. {
  19617. unsigned char *uri = nullptr;
  19618. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19619. &uri, name->d.uniformResourceIdentifier);
  19620. if (uri && uri_len > 0) {
  19621. entry.value = std::string(reinterpret_cast<char *>(uri),
  19622. static_cast<size_t>(uri_len));
  19623. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19624. }
  19625. }
  19626. break;
  19627. default: entry.type = SanType::OTHER; break;
  19628. }
  19629. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19630. }
  19631. wolfSSL_sk_free(san_names);
  19632. return true;
  19633. }
  19634. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19635. time_t &not_after) {
  19636. if (!cert) return false;
  19637. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19638. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19639. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19640. if (!nb || !na) return false;
  19641. // wolfSSL_ASN1_TIME_to_tm is available
  19642. struct tm tm_nb = {}, tm_na = {};
  19643. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19644. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19645. #ifdef _WIN32
  19646. not_before = _mkgmtime(&tm_nb);
  19647. not_after = _mkgmtime(&tm_na);
  19648. #else
  19649. not_before = timegm(&tm_nb);
  19650. not_after = timegm(&tm_na);
  19651. #endif
  19652. return true;
  19653. }
  19654. inline std::string get_cert_serial(cert_t cert) {
  19655. if (!cert) return "";
  19656. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19657. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19658. if (!serial_asn1) return "";
  19659. // Get the serial number data
  19660. int len = serial_asn1->length;
  19661. unsigned char *data = serial_asn1->data;
  19662. if (!data || len <= 0) return "";
  19663. std::string result;
  19664. result.reserve(static_cast<size_t>(len) * 2);
  19665. for (int i = 0; i < len; i++) {
  19666. char hex[3];
  19667. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19668. result += hex;
  19669. }
  19670. return result;
  19671. }
  19672. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19673. if (!cert) return false;
  19674. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19675. int der_len = 0;
  19676. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19677. if (!der_data || der_len <= 0) return false;
  19678. der.assign(der_data, der_data + der_len);
  19679. return true;
  19680. }
  19681. inline const char *get_sni(const_session_t session) {
  19682. if (!session) return nullptr;
  19683. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19684. // For server: return SNI received from client during handshake
  19685. if (!wsession->sni_hostname.empty()) {
  19686. return wsession->sni_hostname.c_str();
  19687. }
  19688. // For client: return the hostname set via set_sni
  19689. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19690. return nullptr;
  19691. }
  19692. inline uint64_t peek_error() {
  19693. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19694. }
  19695. inline uint64_t get_error() {
  19696. uint64_t err = impl::wolfssl_last_error();
  19697. impl::wolfssl_last_error() = 0;
  19698. return err;
  19699. }
  19700. inline std::string error_string(uint64_t code) {
  19701. char buf[256];
  19702. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19703. return std::string(buf);
  19704. }
  19705. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19706. if (!pem || len == 0) { return nullptr; }
  19707. // Validate by attempting to load into a temporary ctx
  19708. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19709. if (!tmp_ctx) { return nullptr; }
  19710. int ret = wolfSSL_CTX_load_verify_buffer(
  19711. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19712. static_cast<long>(len), SSL_FILETYPE_PEM);
  19713. wolfSSL_CTX_free(tmp_ctx);
  19714. if (ret != SSL_SUCCESS) { return nullptr; }
  19715. return static_cast<ca_store_t>(
  19716. new impl::WolfSSLCAStore{std::string(pem, len)});
  19717. }
  19718. inline void free_ca_store(ca_store_t store) {
  19719. delete static_cast<impl::WolfSSLCAStore *>(store);
  19720. }
  19721. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19722. if (!ctx || !store) { return false; }
  19723. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19724. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19725. int ret = wolfSSL_CTX_load_verify_buffer(
  19726. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19727. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19728. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19729. // This function takes ownership of the store; the PEM data was copied into
  19730. // the context, so release the source
  19731. free_ca_store(store);
  19732. return ret == SSL_SUCCESS;
  19733. }
  19734. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19735. certs.clear();
  19736. if (!ctx) { return 0; }
  19737. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19738. if (wctx->ca_pem_data_.empty()) { return 0; }
  19739. const std::string &pem = wctx->ca_pem_data_;
  19740. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19741. const std::string end_marker = "-----END CERTIFICATE-----";
  19742. size_t pos = 0;
  19743. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19744. size_t end_pos = pem.find(end_marker, pos);
  19745. if (end_pos == std::string::npos) { break; }
  19746. end_pos += end_marker.size();
  19747. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19748. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19749. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19750. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19751. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19752. pos = end_pos;
  19753. }
  19754. return certs.size();
  19755. }
  19756. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19757. std::vector<std::string> names;
  19758. if (!ctx) { return names; }
  19759. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19760. if (wctx->ca_pem_data_.empty()) { return names; }
  19761. const std::string &pem = wctx->ca_pem_data_;
  19762. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19763. const std::string end_marker = "-----END CERTIFICATE-----";
  19764. size_t pos = 0;
  19765. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19766. size_t end_pos = pem.find(end_marker, pos);
  19767. if (end_pos == std::string::npos) { break; }
  19768. end_pos += end_marker.size();
  19769. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19770. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19771. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19772. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19773. if (x509) {
  19774. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19775. if (subject) {
  19776. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19777. if (name_str) {
  19778. names.push_back(name_str);
  19779. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19780. }
  19781. }
  19782. wolfSSL_X509_free(x509);
  19783. }
  19784. pos = end_pos;
  19785. }
  19786. return names;
  19787. }
  19788. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19789. const char *key_pem, const char *password) {
  19790. if (!ctx || !cert_pem || !key_pem) { return false; }
  19791. // Try the pair on a scratch context first, so that a bad one leaves the
  19792. // server's certificate and key as they were
  19793. auto tmp = create_server_context();
  19794. if (!tmp) { return false; }
  19795. auto se = detail::scope_exit([&] { free_context(tmp); });
  19796. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  19797. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  19798. }
  19799. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19800. if (!ctx || !ca_pem) { return false; }
  19801. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19802. // Replace the CAs rather than add to them, as the other backends do, once
  19803. // the new ones are known to load
  19804. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  19805. if (!store) { return false; }
  19806. free_ca_store(store);
  19807. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  19808. wctx->ca_pem_data_.clear();
  19809. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  19810. }
  19811. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19812. if (!ctx) { return false; }
  19813. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19814. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  19815. : nullptr;
  19816. {
  19817. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  19818. // A handshake running the previous callback keeps it until it returns.
  19819. wctx->verify_callback.swap(stored);
  19820. }
  19821. impl::apply_verify_mode(*wctx);
  19822. return true;
  19823. }
  19824. inline long get_verify_error(const_session_t session) {
  19825. if (!session) { return -1; }
  19826. auto *wsession =
  19827. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19828. return wolfSSL_get_verify_result(wsession->ssl);
  19829. }
  19830. inline std::string verify_error_string(long error_code) {
  19831. if (error_code == 0) { return ""; }
  19832. const char *str =
  19833. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19834. return str ? std::string(str) : std::string();
  19835. }
  19836. } // namespace tls
  19837. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19838. // WebSocket implementation
  19839. namespace ws {
  19840. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19841. bool fin) {
  19842. std::lock_guard<std::mutex> lock(write_mutex_);
  19843. if (closed_) { return false; }
  19844. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19845. }
  19846. inline ReadResult WebSocket::read(std::string &msg) {
  19847. // Answers a control frame; any other opcode here is a protocol error.
  19848. // Returns false when the connection is done.
  19849. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  19850. switch (op) {
  19851. case Opcode::Ping: {
  19852. std::lock_guard<std::mutex> lock(write_mutex_);
  19853. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19854. payload.size(), true, !is_server_);
  19855. return true;
  19856. }
  19857. case Opcode::Pong: {
  19858. std::lock_guard<std::mutex> lock(ping_mutex_);
  19859. unacked_pings_ = 0;
  19860. return true;
  19861. }
  19862. case Opcode::Close: {
  19863. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  19864. // malformed, which is answered with a protocol error instead.
  19865. if (closed_.exchange(true)) { return false; }
  19866. auto reply = payload;
  19867. if (!impl::is_valid_close_payload(payload)) {
  19868. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  19869. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  19870. }
  19871. std::lock_guard<std::mutex> lock(write_mutex_);
  19872. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  19873. reply.size(), true, !is_server_);
  19874. return false;
  19875. }
  19876. default: closed_ = true; return false;
  19877. }
  19878. };
  19879. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19880. while (!closed_) {
  19881. Opcode opcode;
  19882. std::string payload;
  19883. bool fin;
  19884. impl::FrameRead r =
  19885. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19886. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19887. // A timeout landed on a frame boundary: the connection is untouched and
  19888. // still usable, so hand control back without closing it. That is only
  19889. // useful to a caller who asked for the timeout; the compile-time default
  19890. // is a backstop against a peer gone quiet, and elapsing it closes the
  19891. // connection so a plain `while (ws.read(msg))` loop ends.
  19892. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19893. if (r != impl::FrameRead::Ok) {
  19894. closed_ = true;
  19895. return Fail;
  19896. }
  19897. switch (opcode) {
  19898. case Opcode::Text:
  19899. case Opcode::Binary: {
  19900. auto result = opcode == Opcode::Text ? Text : Binary;
  19901. msg = std::move(payload);
  19902. // Handle fragmentation
  19903. if (!fin) {
  19904. while (true) {
  19905. Opcode cont_opcode;
  19906. std::string cont_payload;
  19907. bool cont_fin;
  19908. // Only what is left of the limit, but room for a control frame,
  19909. // which may come between the fragments.
  19910. auto max_len =
  19911. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  19912. ? size_t(0)
  19913. : (std::max)(size_t(125),
  19914. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  19915. msg.size());
  19916. // A timeout is not reportable here: half of a fragmented message is
  19917. // already in `msg` and read() has no way to resume it, so it is a
  19918. // failure like any other. Timeouts are only ever seen on a message
  19919. // boundary.
  19920. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  19921. cont_fin, is_server_,
  19922. max_len) != impl::FrameRead::Ok) {
  19923. closed_ = true;
  19924. return Fail;
  19925. }
  19926. // RFC 6455 5.4: the fragments are continuation frames, with only
  19927. // control frames between them.
  19928. if (cont_opcode != Opcode::Continuation) {
  19929. if (handle_control(cont_opcode, cont_payload)) { continue; }
  19930. return Fail;
  19931. }
  19932. msg += cont_payload;
  19933. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  19934. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19935. closed_ = true;
  19936. return Fail;
  19937. }
  19938. if (cont_fin) { break; }
  19939. }
  19940. }
  19941. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19942. if (result == Text && !impl::is_valid_utf8(msg)) {
  19943. // close() takes the read lock to wait for the peer's Close reply, so
  19944. // it must not run while this thread still holds it.
  19945. read_lock.unlock();
  19946. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19947. return Fail;
  19948. }
  19949. return result;
  19950. }
  19951. default:
  19952. if (handle_control(opcode, payload)) { continue; }
  19953. return Fail;
  19954. }
  19955. }
  19956. return Fail;
  19957. }
  19958. inline bool WebSocket::send(const std::string &data) {
  19959. return send_frame(Opcode::Text, data.data(), data.size());
  19960. }
  19961. inline bool WebSocket::send(const char *data, size_t len) {
  19962. return send_frame(Opcode::Binary, data, len);
  19963. }
  19964. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19965. if (closed_.exchange(true)) { return; }
  19966. ping_cv_.notify_all();
  19967. std::string payload;
  19968. auto code = static_cast<uint16_t>(status);
  19969. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19970. payload.push_back(static_cast<char>(code & 0xFF));
  19971. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19972. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  19973. // cut back to a whole UTF-8 character
  19974. auto short_reason = reason.substr(0, 123);
  19975. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  19976. short_reason.pop_back();
  19977. }
  19978. payload += short_reason;
  19979. // A code that may not be sent, such as NoStatus, goes without a payload
  19980. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  19981. {
  19982. std::lock_guard<std::mutex> lock(write_mutex_);
  19983. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19984. payload.size(), true, !is_server_);
  19985. }
  19986. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19987. // Close response before closing the TCP connection.
  19988. //
  19989. // Wait only when no other thread is parsing frames. When one is, it is the
  19990. // thread positioned to see the peer's reply, and reading here would take
  19991. // bytes out of the message it is assembling. Bailing out also leaves the
  19992. // stream, including its read timeout, entirely to that thread.
  19993. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19994. if (!read_lock.owns_lock()) { return; }
  19995. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19996. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19997. Opcode op;
  19998. std::string resp;
  19999. bool fin;
  20000. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20001. impl::FrameRead::Ok) {
  20002. if (op == Opcode::Close) { break; }
  20003. }
  20004. }
  20005. inline WebSocket::~WebSocket() {
  20006. {
  20007. std::lock_guard<std::mutex> lock(ping_mutex_);
  20008. closed_ = true;
  20009. }
  20010. ping_cv_.notify_all();
  20011. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20012. }
  20013. inline void WebSocket::start_heartbeat() {
  20014. if (ping_interval_sec_ <= 0) { return; }
  20015. ping_thread_ = std::thread([this]() {
  20016. std::unique_lock<std::mutex> lock(ping_mutex_);
  20017. // The predicate keeps a spurious wakeup from sending a ping early
  20018. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20019. [this]() { return closed_.load(); })) {
  20020. // If the peer has failed to respond to the previous pings, give up.
  20021. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20022. // opt-in liveness check controlled by max_missed_pongs_.
  20023. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20024. lock.unlock();
  20025. close(CloseStatus::GoingAway, "pong timeout");
  20026. // Wake a read() blocked on the unresponsive peer. Only the read side
  20027. // is shut down: a TLS backend answers the EOF with an alert, and
  20028. // writing it to a socket closed for writing raises SIGPIPE.
  20029. #ifdef _WIN32
  20030. shutdown(strm_.socket(), SD_RECEIVE);
  20031. #else
  20032. shutdown(strm_.socket(), SHUT_RD);
  20033. #endif
  20034. return;
  20035. }
  20036. lock.unlock();
  20037. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20038. lock.lock();
  20039. closed_ = true;
  20040. break;
  20041. }
  20042. lock.lock();
  20043. unacked_pings_++;
  20044. }
  20045. });
  20046. }
  20047. inline const Request &WebSocket::request() const { return req_; }
  20048. inline bool WebSocket::is_open() const { return !closed_; }
  20049. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20050. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20051. // poll(), where 0 would instead mean "return immediately", so hand it the
  20052. // negative poll uses for an unbounded wait.
  20053. if (sec == 0 && usec == 0) { sec = -1; }
  20054. strm_.set_read_timeout(sec, usec);
  20055. read_timeout_set_ = true;
  20056. }
  20057. // WebSocketClient implementation
  20058. inline WebSocketClient::WebSocketClient(
  20059. const std::string &scheme_host_port_path, const Headers &headers)
  20060. : headers_(headers) {
  20061. detail::UrlComponents uc;
  20062. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20063. !uc.host.empty() && !uc.path.empty()) {
  20064. auto &scheme = uc.scheme;
  20065. #ifdef CPPHTTPLIB_SSL_ENABLED
  20066. if (scheme != "ws" && scheme != "wss") {
  20067. #else
  20068. if (scheme != "ws") {
  20069. #endif
  20070. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20071. std::string msg = "'" + scheme + "' scheme is not supported.";
  20072. throw std::invalid_argument(msg);
  20073. #endif
  20074. return;
  20075. }
  20076. auto is_ssl = scheme == "wss";
  20077. host_ = std::move(uc.host);
  20078. port_ = is_ssl ? 443 : 80;
  20079. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20080. path_ = std::move(uc.path);
  20081. if (!uc.query.empty()) { path_ += uc.query; }
  20082. #ifdef CPPHTTPLIB_SSL_ENABLED
  20083. is_ssl_ = is_ssl;
  20084. if (is_ssl_) {
  20085. // The context lives as long as the client so that CA configuration
  20086. // survives reconnects; sessions are created per connection.
  20087. tls_ctx_ = tls::create_client_context();
  20088. if (!tls_ctx_) { return; }
  20089. }
  20090. #else
  20091. if (is_ssl) { return; }
  20092. #endif
  20093. is_valid_ = true;
  20094. }
  20095. }
  20096. #ifdef CPPHTTPLIB_SSL_ENABLED
  20097. inline WebSocketClient::WebSocketClient(
  20098. const std::string &scheme_host_port_path, const PemMemory &pem,
  20099. const Headers &headers)
  20100. : WebSocketClient(scheme_host_port_path, headers) {
  20101. // For ws:// URLs the client certificate is silently ignored, consistent
  20102. // with the TLS-only setters such as set_ca_cert_path().
  20103. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20104. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  20105. pem.private_key_password)) {
  20106. tls::free_context(tls_ctx_);
  20107. tls_ctx_ = nullptr;
  20108. is_valid_ = false;
  20109. }
  20110. }
  20111. }
  20112. #endif
  20113. inline WebSocketClient::~WebSocketClient() {
  20114. shutdown_and_close();
  20115. #ifdef CPPHTTPLIB_SSL_ENABLED
  20116. if (tls_ctx_) {
  20117. tls::free_context(tls_ctx_);
  20118. tls_ctx_ = nullptr;
  20119. }
  20120. #endif
  20121. }
  20122. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20123. inline void WebSocketClient::shutdown_and_close() {
  20124. // Send the close frame while the TLS session is still alive: ws_ holds an
  20125. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20126. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20127. if (ws_ && ws_->is_open()) { ws_->close(); }
  20128. ws_.reset();
  20129. #ifdef CPPHTTPLIB_SSL_ENABLED
  20130. if (is_ssl_) {
  20131. if (tls_session_) {
  20132. tls::shutdown(tls_session_, true);
  20133. tls::free_session(tls_session_);
  20134. tls_session_ = nullptr;
  20135. }
  20136. }
  20137. #endif
  20138. if (sock_ != INVALID_SOCKET) {
  20139. detail::shutdown_socket(sock_);
  20140. detail::close_socket(sock_);
  20141. sock_ = INVALID_SOCKET;
  20142. }
  20143. }
  20144. // The handshakes belong to establishing the connection, so an unset read
  20145. // timeout leaves them bounded by the connection timeout instead of forever.
  20146. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20147. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20148. return {connection_timeout_sec_, connection_timeout_usec_};
  20149. }
  20150. return {read_timeout_sec_, read_timeout_usec_};
  20151. }
  20152. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20153. Error &error, int &ssl_error,
  20154. uint64_t &ssl_backend_error) {
  20155. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20156. // The streams wait with poll(), where 0 instead means "return immediately",
  20157. // so they are given the negative poll uses for an unbounded wait.
  20158. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20159. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20160. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20161. #ifdef CPPHTTPLIB_SSL_ENABLED
  20162. if (is_ssl_) {
  20163. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20164. // is not safe to call concurrently on one client to begin with, since
  20165. // nothing else here is guarded either.
  20166. if (server_certificate_verification_ && !certs_loaded_) {
  20167. uint64_t backend_error = 0;
  20168. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20169. ca_cert_dir_path_, custom_ca_loaded_,
  20170. system_ca_mode_, backend_error);
  20171. certs_loaded_ = true;
  20172. }
  20173. detail::ClientTlsSessionOptions options;
  20174. options.server_hostname_verification = server_hostname_verification_;
  20175. options.session_verifier = session_verifier_;
  20176. auto timeout = handshake_timeout();
  20177. detail::ClientTlsSessionError tls_error;
  20178. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20179. server_certificate_verification_,
  20180. timeout.first, timeout.second,
  20181. &tls_error, options)) {
  20182. error = tls_error.error;
  20183. ssl_error = tls_error.ssl_error;
  20184. ssl_backend_error = tls_error.backend_error;
  20185. return false;
  20186. }
  20187. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20188. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20189. write_timeout_usec_));
  20190. return true;
  20191. }
  20192. #else
  20193. (void)error;
  20194. (void)ssl_error;
  20195. (void)ssl_backend_error;
  20196. #endif
  20197. strm = std::unique_ptr<Stream>(
  20198. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20199. write_timeout_sec_, write_timeout_usec_));
  20200. return true;
  20201. }
  20202. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20203. #ifdef CPPHTTPLIB_SSL_ENABLED
  20204. auto is_ssl = is_ssl_;
  20205. #else
  20206. auto is_ssl = false;
  20207. #endif
  20208. if (!req.has_header("Host")) {
  20209. req.headers.emplace("Host", detail::make_default_host_header_value(
  20210. host_, port_, is_ssl, address_family_));
  20211. }
  20212. detail::add_default_user_agent_header(req);
  20213. }
  20214. inline Result WebSocketClient::connect() {
  20215. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20216. shutdown_and_close();
  20217. auto error = Error::Success;
  20218. if (!create_and_connect_socket(error)) {
  20219. return Result{error, -1, Headers{}};
  20220. }
  20221. if (is_proxy_enabled()) {
  20222. Response proxy_res;
  20223. if (!connect_with_proxy(proxy_res, error)) {
  20224. shutdown_and_close();
  20225. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20226. }
  20227. }
  20228. std::unique_ptr<Stream> strm;
  20229. auto stream_error = Error::SSLConnection;
  20230. int ssl_error = 0;
  20231. uint64_t ssl_backend_error = 0;
  20232. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20233. shutdown_and_close();
  20234. #ifdef CPPHTTPLIB_SSL_ENABLED
  20235. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20236. #else
  20237. return Result{stream_error, -1, Headers{}};
  20238. #endif
  20239. }
  20240. Request req;
  20241. req.method = "GET";
  20242. req.path = path_;
  20243. req.headers = headers_;
  20244. prepare_default_headers(req);
  20245. detail::WebSocketUpgradeResponse upgrade;
  20246. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20247. shutdown_and_close();
  20248. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20249. }
  20250. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20251. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20252. websocket_ping_interval_sec_,
  20253. websocket_max_missed_pongs_));
  20254. // The stream was created with the timeout already; tell the WebSocket
  20255. // whether it came from the caller, so read() knows to report it as Timeout.
  20256. ws_->read_timeout_set_ = read_timeout_set_;
  20257. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20258. }
  20259. inline ReadResult WebSocketClient::read(std::string &msg) {
  20260. if (!ws_) { return Fail; }
  20261. return ws_->read(msg);
  20262. }
  20263. inline bool WebSocketClient::send(const std::string &data) {
  20264. if (!ws_) { return false; }
  20265. return ws_->send(data);
  20266. }
  20267. inline bool WebSocketClient::send(const char *data, size_t len) {
  20268. if (!ws_) { return false; }
  20269. return ws_->send(data, len);
  20270. }
  20271. inline void WebSocketClient::close(CloseStatus status,
  20272. const std::string &reason) {
  20273. if (ws_) { ws_->close(status, reason); }
  20274. }
  20275. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20276. inline const std::string &WebSocketClient::subprotocol() const {
  20277. return subprotocol_;
  20278. }
  20279. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20280. read_timeout_sec_ = sec;
  20281. read_timeout_usec_ = usec;
  20282. read_timeout_set_ = true;
  20283. // The members above only seed the next connect(); read() consults the
  20284. // stream, so an already-open connection has to be told directly.
  20285. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20286. }
  20287. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20288. write_timeout_sec_ = sec;
  20289. write_timeout_usec_ = usec;
  20290. }
  20291. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20292. websocket_ping_interval_sec_ = sec;
  20293. }
  20294. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20295. websocket_max_missed_pongs_ = count;
  20296. }
  20297. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20298. inline void WebSocketClient::set_address_family(int family) {
  20299. address_family_ = family;
  20300. }
  20301. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20302. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20303. socket_options_ = std::move(socket_options);
  20304. }
  20305. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20306. connection_timeout_sec_ = sec;
  20307. connection_timeout_usec_ = usec;
  20308. }
  20309. inline void WebSocketClient::set_interface(const std::string &intf) {
  20310. interface_ = intf;
  20311. }
  20312. inline void WebSocketClient::set_hostname_addr_map(
  20313. std::map<std::string, std::string> addr_map) {
  20314. addr_map_ = std::move(addr_map);
  20315. }
  20316. inline bool WebSocketClient::is_proxy_enabled() const {
  20317. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20318. if (no_proxy_entries_.empty()) { return true; }
  20319. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20320. no_proxy_entries_);
  20321. }
  20322. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20323. std::string connect_host;
  20324. std::string ip;
  20325. auto port = port_;
  20326. if (is_proxy_enabled()) {
  20327. connect_host = proxy_host_;
  20328. port = proxy_port_;
  20329. } else {
  20330. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20331. }
  20332. sock_ = detail::create_client_socket(
  20333. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20334. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20335. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20336. write_timeout_usec_, interface_, error);
  20337. if (sock_ != INVALID_SOCKET) { return true; }
  20338. if (error == Error::Success) { error = Error::Connection; }
  20339. return false;
  20340. }
  20341. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20342. Response &proxy_res,
  20343. Error &error) {
  20344. auto timeout = handshake_timeout();
  20345. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20346. write_timeout_sec_, write_timeout_usec_);
  20347. if (!detail::write_request_head(strm, req, error)) { return false; }
  20348. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20349. error = Error::Read;
  20350. return false;
  20351. }
  20352. return true;
  20353. }
  20354. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20355. // forward an Upgrade request.
  20356. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20357. Error &error) {
  20358. Request req;
  20359. req.method = "CONNECT";
  20360. req.path = detail::make_host_and_port_string_always_port(host_, port_);
  20361. req.headers.emplace("Host", req.path);
  20362. detail::add_default_user_agent_header(req);
  20363. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20364. proxy_basic_auth_password_,
  20365. proxy_bearer_token_auth_token_, true);
  20366. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20367. #ifdef CPPHTTPLIB_SSL_ENABLED
  20368. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20369. std::map<std::string, std::string> auth;
  20370. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20371. !proxy_digest_auth_username_.empty() &&
  20372. !proxy_digest_auth_password_.empty() &&
  20373. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20374. proxy_res = Response();
  20375. shutdown_and_close();
  20376. if (!create_and_connect_socket(error)) { return false; }
  20377. req.headers.erase("Proxy-Authorization");
  20378. req.headers.insert(detail::make_digest_authentication_header(
  20379. req, req.path, auth, 1, detail::random_string(10),
  20380. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20381. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20382. }
  20383. #endif
  20384. if (proxy_res.status != StatusCode::OK_200) {
  20385. error = Error::ProxyConnection;
  20386. return false;
  20387. }
  20388. return true;
  20389. }
  20390. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20391. proxy_host_ = host;
  20392. proxy_port_ = port;
  20393. }
  20394. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20395. const std::string &password) {
  20396. proxy_basic_auth_username_ = username;
  20397. proxy_basic_auth_password_ = password;
  20398. }
  20399. inline void
  20400. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20401. proxy_bearer_token_auth_token_ = token;
  20402. }
  20403. inline void
  20404. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20405. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20406. }
  20407. #ifdef CPPHTTPLIB_SSL_ENABLED
  20408. inline void
  20409. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20410. const std::string &ca_cert_dir_path) {
  20411. ca_cert_file_path_ = ca_cert_file_path;
  20412. ca_cert_dir_path_ = ca_cert_dir_path;
  20413. }
  20414. inline void
  20415. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20416. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20417. }
  20418. inline void WebSocketClient::set_session_verifier(
  20419. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20420. session_verifier_ = std::move(verifier);
  20421. }
  20422. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20423. if (store && tls_ctx_) {
  20424. // set_ca_store takes ownership of store
  20425. tls::set_ca_store(tls_ctx_, store);
  20426. custom_ca_loaded_ = true;
  20427. } else if (store) {
  20428. tls::free_ca_store(store);
  20429. }
  20430. }
  20431. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20432. std::size_t size) {
  20433. if (tls_ctx_ && ca_cert && size > 0) {
  20434. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20435. custom_ca_loaded_ = true;
  20436. }
  20437. }
  20438. inline void
  20439. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20440. server_certificate_verification_ = enabled;
  20441. }
  20442. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20443. server_hostname_verification_ = enabled;
  20444. }
  20445. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20446. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20447. }
  20448. inline void
  20449. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  20450. const std::string &password) {
  20451. proxy_digest_auth_username_ = username;
  20452. proxy_digest_auth_password_ = password;
  20453. }
  20454. #endif // CPPHTTPLIB_SSL_ENABLED
  20455. } // namespace ws
  20456. // ----------------------------------------------------------------------------
  20457. } // namespace httplib
  20458. #endif // CPPHTTPLIB_HTTPLIB_H