httplib.h 883 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587
  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.67.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x004300"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT
  104. #define CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT 100
  105. #endif
  106. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  107. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  108. #endif
  109. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  110. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  111. #endif
  112. // How much of an unread request body the server skips to reuse the connection,
  113. // 0 for no limit
  114. #ifndef CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH
  115. #define CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH (256 * 1024) // 256KB
  116. #endif
  117. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  118. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  119. #endif
  120. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  121. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  122. #endif
  123. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  124. // 1400 rather than a round number: a body that already fits in one 1500-byte
  125. // MTU gains nothing from being made smaller.
  126. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  127. #endif
  128. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  129. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  130. #endif
  131. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  132. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  133. #endif
  134. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  135. // recurses roughly once per matched character for quantified patterns such
  136. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  137. // a default ~8MB thread stack that has been observed to take on the order of
  138. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  139. // margin below that (well under the 8192-byte request URI limit) while still
  140. // fitting any realistic route segment; raise it if a route legitimately needs
  141. // longer paths. Regex routes are never applied to paths longer than this.
  142. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  143. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  144. #endif
  145. #ifndef CPPHTTPLIB_TCP_NODELAY
  146. #define CPPHTTPLIB_TCP_NODELAY false
  147. #endif
  148. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  149. #define CPPHTTPLIB_IPV6_V6ONLY false
  150. #endif
  151. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  152. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  153. #endif
  154. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  155. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  156. #endif
  157. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  158. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  159. #endif
  160. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  161. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  162. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  163. ? std::thread::hardware_concurrency() - 1 \
  164. : 0))
  165. #endif
  166. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  167. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  168. #endif
  169. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  170. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  171. #endif
  172. #ifndef CPPHTTPLIB_RECV_FLAGS
  173. #define CPPHTTPLIB_RECV_FLAGS 0
  174. #endif
  175. #ifndef CPPHTTPLIB_SEND_FLAGS
  176. #define CPPHTTPLIB_SEND_FLAGS 0
  177. #endif
  178. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  179. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  180. #endif
  181. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  182. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  183. #endif
  184. // These bound the parsing of every request, so 0 cannot lift them.
  185. static_assert(CPPHTTPLIB_REQUEST_URI_MAX_LENGTH > 0,
  186. "CPPHTTPLIB_REQUEST_URI_MAX_LENGTH must be positive");
  187. static_assert(CPPHTTPLIB_HEADER_MAX_LENGTH > 0,
  188. "CPPHTTPLIB_HEADER_MAX_LENGTH must be positive");
  189. static_assert(CPPHTTPLIB_HEADER_MAX_COUNT > 0,
  190. "CPPHTTPLIB_HEADER_MAX_COUNT must be positive");
  191. static_assert(CPPHTTPLIB_MAX_LINE_LENGTH > 0,
  192. "CPPHTTPLIB_MAX_LINE_LENGTH must be positive");
  193. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  194. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  195. #endif
  196. // One macro used to set the read timeout for both sides. They want different
  197. // defaults: a client's read timeout is the caller's own tool (it waits forever
  198. // until asked not to), while a server keeps a ceiling that reclaims a worker
  199. // from a peer that has gone quiet. The old name still works and sets both.
  200. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  201. #pragma message( \
  202. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  203. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  204. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  205. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  207. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  208. #endif
  209. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  210. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  211. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  212. #endif
  213. #endif
  214. // 0 waits forever. A read timeout is how a caller gets control back to send on
  215. // the same connection; it is not a liveness check (that is ping/pong). Only a
  216. // timeout set at runtime through set_read_timeout() is reported as
  217. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  218. // ws::Fail and closes the connection.
  219. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  220. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  221. #endif
  222. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  223. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  224. #endif
  225. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  226. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  227. #endif
  228. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  229. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  230. #endif
  231. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  232. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  233. #endif
  234. // A WebSocket connection carries small messages each way, which Nagle's
  235. // algorithm would hold back for the peer's delayed ACK (tens of milliseconds
  236. // on Linux), so it sets TCP_NODELAY unless this is false.
  237. #ifndef CPPHTTPLIB_WEBSOCKET_TCP_NODELAY
  238. #define CPPHTTPLIB_WEBSOCKET_TCP_NODELAY true
  239. #endif
  240. /*
  241. * Headers
  242. */
  243. #ifdef _WIN32
  244. #ifndef _CRT_SECURE_NO_WARNINGS
  245. #define _CRT_SECURE_NO_WARNINGS
  246. #endif //_CRT_SECURE_NO_WARNINGS
  247. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  248. #define _CRT_NONSTDC_NO_DEPRECATE
  249. #endif //_CRT_NONSTDC_NO_DEPRECATE
  250. #if defined(_MSC_VER)
  251. #if _MSC_VER < 1900
  252. #error Sorry, Visual Studio versions prior to 2015 are not supported
  253. #endif
  254. #pragma comment(lib, "ws2_32.lib")
  255. #ifndef _SSIZE_T_DEFINED
  256. using ssize_t = __int64;
  257. #define _SSIZE_T_DEFINED
  258. #endif
  259. #endif // _MSC_VER
  260. #ifndef S_ISREG
  261. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  262. #endif // S_ISREG
  263. #ifndef S_ISDIR
  264. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  265. #endif // S_ISDIR
  266. #ifndef NOMINMAX
  267. #define NOMINMAX
  268. #endif // NOMINMAX
  269. #include <io.h>
  270. #include <winsock2.h>
  271. #include <ws2tcpip.h>
  272. #if defined(__has_include)
  273. #if __has_include(<afunix.h>)
  274. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  275. #include <afunix.h>
  276. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  277. #endif
  278. #endif
  279. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  280. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  281. #endif
  282. using nfds_t = unsigned long;
  283. using socket_t = SOCKET;
  284. using socklen_t = int;
  285. #else // not _WIN32
  286. #include <arpa/inet.h>
  287. #if !defined(_AIX) && !defined(__MVS__)
  288. #include <ifaddrs.h>
  289. #endif
  290. #ifdef __MVS__
  291. #include <strings.h>
  292. #ifndef NI_MAXHOST
  293. #define NI_MAXHOST 1025
  294. #endif
  295. #endif
  296. #include <net/if.h>
  297. #include <netdb.h>
  298. #include <netinet/in.h>
  299. #ifdef __linux__
  300. #include <resolv.h>
  301. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  302. #include <sys/epoll.h>
  303. #include <sys/eventfd.h>
  304. #endif
  305. #include <csignal>
  306. #include <netinet/tcp.h>
  307. #include <poll.h>
  308. #include <pthread.h>
  309. #include <sys/socket.h>
  310. #include <sys/un.h>
  311. #include <unistd.h>
  312. using socket_t = int;
  313. #ifndef INVALID_SOCKET
  314. #define INVALID_SOCKET (-1)
  315. #endif
  316. #endif //_WIN32
  317. #if defined(__APPLE__)
  318. #include <TargetConditionals.h>
  319. #endif
  320. #if defined(__APPLE__) || defined(__FreeBSD__)
  321. #define CPPHTTPLIB_KQUEUE_POLLER
  322. #include <sys/event.h>
  323. #endif
  324. #include <algorithm>
  325. #include <array>
  326. #include <atomic>
  327. #include <cassert>
  328. #include <chrono>
  329. #include <climits>
  330. #include <condition_variable>
  331. #include <cstdlib>
  332. #include <cstring>
  333. #include <errno.h>
  334. #include <exception>
  335. #include <fcntl.h>
  336. #include <fstream>
  337. #include <functional>
  338. #include <iomanip>
  339. #include <iostream>
  340. #include <iterator>
  341. #include <list>
  342. #include <map>
  343. #include <memory>
  344. #include <mutex>
  345. #include <random>
  346. #include <regex>
  347. #include <set>
  348. #include <sstream>
  349. #include <string>
  350. #include <sys/stat.h>
  351. #include <system_error>
  352. #include <thread>
  353. #include <type_traits>
  354. #include <unordered_map>
  355. #include <unordered_set>
  356. #include <utility>
  357. #include <vector>
  358. // On macOS with a TLS backend, enable Keychain root certificates by default
  359. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  360. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  361. // only; on those platforms the user must provide a CA bundle explicitly.
  362. #if defined(__APPLE__) && defined(__clang__) && \
  363. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  364. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  365. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  366. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  367. #if TARGET_OS_OSX
  368. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  369. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  370. #endif
  371. #endif
  372. #endif
  373. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  374. defined(__APPLE__) && !TARGET_OS_OSX
  375. #error \
  376. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  377. #endif
  378. // On Windows, enable Schannel certificate verification by default
  379. // unless the user explicitly opts out.
  380. #if defined(_WIN32) && \
  381. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  382. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  383. #endif
  384. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  385. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  386. #if TARGET_OS_MAC && defined(__clang__)
  387. #include <CFNetwork/CFHost.h>
  388. #include <CoreFoundation/CoreFoundation.h>
  389. #endif
  390. #endif
  391. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  392. #ifdef _WIN32
  393. #include <wincrypt.h>
  394. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  395. // used
  396. #undef X509_NAME
  397. #undef X509_CERT_PAIR
  398. #undef X509_EXTENSIONS
  399. #undef PKCS7_SIGNER_INFO
  400. #ifdef _MSC_VER
  401. #pragma comment(lib, "crypt32.lib")
  402. #endif
  403. #endif // _WIN32
  404. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  405. #if TARGET_OS_OSX
  406. #include <Security/Security.h>
  407. #endif
  408. #endif
  409. #include <openssl/err.h>
  410. #include <openssl/evp.h>
  411. #include <openssl/rand.h>
  412. #include <openssl/ssl.h>
  413. #include <openssl/x509v3.h>
  414. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  415. #include <openssl/applink.c>
  416. #endif
  417. #include <iostream>
  418. #include <sstream>
  419. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  420. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  421. #error Please use OpenSSL or a current version of BoringSSL
  422. #endif
  423. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  424. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  425. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  426. #endif
  427. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  428. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  429. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  430. // in with this first include group so the version gating below can use it.
  431. #include <mbedtls/error.h>
  432. #include <mbedtls/net_sockets.h>
  433. #include <mbedtls/oid.h>
  434. #include <mbedtls/pk.h>
  435. #include <mbedtls/ssl.h>
  436. #include <mbedtls/version.h>
  437. #include <mbedtls/x509_crt.h>
  438. #if MBEDTLS_VERSION_MAJOR >= 4
  439. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  440. #include <psa/crypto.h>
  441. #else
  442. #include <mbedtls/ctr_drbg.h>
  443. #include <mbedtls/entropy.h>
  444. #include <mbedtls/md5.h>
  445. #include <mbedtls/sha1.h>
  446. #include <mbedtls/sha256.h>
  447. #include <mbedtls/sha512.h>
  448. #endif
  449. #ifdef _WIN32
  450. #include <wincrypt.h>
  451. #ifdef _MSC_VER
  452. #pragma comment(lib, "crypt32.lib")
  453. #endif
  454. #endif // _WIN32
  455. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  456. #if TARGET_OS_OSX
  457. #include <Security/Security.h>
  458. #endif
  459. #endif
  460. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  461. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  462. #if MBEDTLS_VERSION_MAJOR >= 4
  463. #define CPPHTTPLIB_MBEDTLS_V4
  464. #endif
  465. #if MBEDTLS_VERSION_MAJOR >= 3
  466. #define CPPHTTPLIB_MBEDTLS_V3
  467. #endif
  468. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  469. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  470. #include <wolfssl/options.h>
  471. #include <wolfssl/openssl/x509v3.h>
  472. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  473. #ifndef WOLFSSL_GEN_EMAIL
  474. #define WOLFSSL_GEN_EMAIL 1
  475. #endif
  476. #ifndef WOLFSSL_GEN_DNS
  477. #define WOLFSSL_GEN_DNS 2
  478. #endif
  479. #ifndef WOLFSSL_GEN_URI
  480. #define WOLFSSL_GEN_URI 6
  481. #endif
  482. #ifndef WOLFSSL_GEN_IPADD
  483. #define WOLFSSL_GEN_IPADD 7
  484. #endif
  485. #include <wolfssl/ssl.h>
  486. #include <wolfssl/wolfcrypt/hash.h>
  487. #include <wolfssl/wolfcrypt/md5.h>
  488. #include <wolfssl/wolfcrypt/sha256.h>
  489. #include <wolfssl/wolfcrypt/sha512.h>
  490. #ifdef _WIN32
  491. #include <wincrypt.h>
  492. #ifdef _MSC_VER
  493. #pragma comment(lib, "crypt32.lib")
  494. #endif
  495. #endif // _WIN32
  496. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  497. #if TARGET_OS_OSX
  498. #include <Security/Security.h>
  499. #endif
  500. #endif
  501. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  502. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  503. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  504. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  505. #define CPPHTTPLIB_SSL_ENABLED
  506. #endif
  507. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  508. #include <zlib.h>
  509. #endif
  510. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  511. #include <brotli/decode.h>
  512. #include <brotli/encode.h>
  513. #endif
  514. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  515. #include <zstd.h>
  516. #endif
  517. /*
  518. * Declaration
  519. */
  520. namespace httplib {
  521. namespace ws {
  522. class WebSocket;
  523. } // namespace ws
  524. namespace sse {
  525. class SSEClient;
  526. } // namespace sse
  527. namespace detail {
  528. /*
  529. * Backport std::make_unique from C++14.
  530. *
  531. * NOTE: This code came up with the following stackoverflow post:
  532. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  533. *
  534. */
  535. template <class T, class... Args>
  536. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  537. make_unique(Args &&...args) {
  538. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  539. }
  540. template <class T>
  541. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  542. make_unique(std::size_t n) {
  543. typedef typename std::remove_extent<T>::type RT;
  544. return std::unique_ptr<T>(new RT[n]);
  545. }
  546. // Locale-independent ASCII character classification. The <cctype>
  547. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  548. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  549. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  550. // classified without regard to the locale.
  551. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  552. inline bool is_ascii_alpha(char c) {
  553. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  554. }
  555. inline bool is_ascii_alnum(char c) {
  556. return is_ascii_digit(c) || is_ascii_alpha(c);
  557. }
  558. namespace case_ignore {
  559. inline unsigned char to_lower(int c) {
  560. const static unsigned char table[256] = {
  561. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  562. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  563. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  564. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  565. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  566. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  567. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  568. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  569. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  570. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  571. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  572. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  573. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  574. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  575. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  576. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  577. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  578. 255,
  579. };
  580. return table[(unsigned char)(char)c];
  581. }
  582. inline std::string to_lower(const std::string &s) {
  583. std::string result = s;
  584. std::transform(
  585. result.begin(), result.end(), result.begin(),
  586. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  587. return result;
  588. }
  589. inline bool equal(const std::string &a, const std::string &b) {
  590. return a.size() == b.size() &&
  591. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  592. return to_lower(ca) == to_lower(cb);
  593. });
  594. }
  595. // For a literal, without building a std::string from it.
  596. template <size_t N>
  597. inline bool equal(const std::string &a, const char (&b)[N]) {
  598. return a.size() == N - 1 &&
  599. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  600. return to_lower(ca) == to_lower(cb);
  601. });
  602. }
  603. struct equal_to {
  604. bool operator()(const std::string &a, const std::string &b) const {
  605. return equal(a, b);
  606. }
  607. };
  608. struct hash {
  609. size_t operator()(const std::string &key) const {
  610. size_t h = 0;
  611. for (auto c : key) {
  612. // Unsets the 6 high bits of h, therefore no overflow happens
  613. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  614. static_cast<unsigned char>(to_lower(c));
  615. }
  616. return h;
  617. }
  618. };
  619. template <typename T>
  620. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  621. detail::case_ignore::equal_to>;
  622. } // namespace case_ignore
  623. // This is based on
  624. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  625. struct scope_exit {
  626. explicit scope_exit(std::function<void(void)> &&f)
  627. : exit_function(std::move(f)), execute_on_destruction{true} {}
  628. scope_exit(scope_exit &&rhs) noexcept
  629. : exit_function(std::move(rhs.exit_function)),
  630. execute_on_destruction{rhs.execute_on_destruction} {
  631. rhs.release();
  632. }
  633. ~scope_exit() {
  634. if (execute_on_destruction) { this->exit_function(); }
  635. }
  636. void release() { this->execute_on_destruction = false; }
  637. private:
  638. scope_exit(const scope_exit &) = delete;
  639. void operator=(const scope_exit &) = delete;
  640. scope_exit &operator=(scope_exit &&) = delete;
  641. std::function<void(void)> exit_function;
  642. bool execute_on_destruction;
  643. };
  644. // Simple from_chars implementation for integer and double types (C++17
  645. // substitute)
  646. template <typename T> struct from_chars_result {
  647. const char *ptr;
  648. std::errc ec;
  649. };
  650. template <typename T>
  651. inline from_chars_result<T> from_chars(const char *first, const char *last,
  652. T &value, int base = 10) {
  653. value = 0;
  654. const char *p = first;
  655. bool negative = false;
  656. if (p != last && *p == '-') {
  657. negative = true;
  658. ++p;
  659. }
  660. if (p == last) { return {first, std::errc::invalid_argument}; }
  661. auto radix = static_cast<T>(base);
  662. T result = 0;
  663. for (; p != last; ++p) {
  664. char c = *p;
  665. int digit = -1;
  666. if (is_ascii_digit(c)) {
  667. digit = c - '0';
  668. } else if ('a' <= c && c <= 'z') {
  669. digit = c - 'a' + 10;
  670. } else if ('A' <= c && c <= 'Z') {
  671. digit = c - 'A' + 10;
  672. } else {
  673. break;
  674. }
  675. if (digit < 0 || digit >= base) { break; }
  676. auto d = static_cast<T>(digit);
  677. if (result > ((std::numeric_limits<T>::max)() - d) / radix) {
  678. return {p, std::errc::result_out_of_range};
  679. }
  680. result = result * radix + d;
  681. }
  682. if (p == first || (negative && p == first + 1)) {
  683. return {first, std::errc::invalid_argument};
  684. }
  685. value = negative ? T(0) - result : result;
  686. return {p, std::errc{}};
  687. }
  688. // from_chars for double (hand-written, locale-independent)
  689. //
  690. // The only double consumed by this library is the HTTP quality value, whose
  691. // grammar is (RFC 9110 12.4.2):
  692. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  693. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  694. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  695. // '.' always the decimal separator (std::strtod would instead read it from the
  696. // global C locale, mis-parsing q-values once an embedder calls
  697. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  698. // the result to [0, 1], so inputs outside that range need not be distinguished
  699. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  700. // cases that exponent and wide-range handling would introduce.
  701. inline from_chars_result<double> from_chars(const char *first, const char *last,
  702. double &value) {
  703. value = 0.0;
  704. const char *p = first;
  705. // Each 1eN is exactly representable, so a single final division by the
  706. // matching entry yields a correctly-rounded result.
  707. static const double powers_of_ten[] = {
  708. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  709. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  710. const int max_frac_digits =
  711. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  712. // Accumulate digits into a 64-bit integer and remember how many were
  713. // fractional. Two independent caps keep this bounded and safe:
  714. // * accumulation saturates before mantissa could overflow uint64_t, and
  715. // * frac_digits is capped at max_frac_digits so it is always a valid index
  716. // into powers_of_ten (without this an input like "0.000...0" would never
  717. // grow mantissa, so the saturation cap alone would not bound it).
  718. // Both caps only drop digits far beyond the precision a q-value needs; any
  719. // value they would change is well outside [0, 1] and rejected by the caller.
  720. uint64_t mantissa = 0;
  721. int frac_digits = 0;
  722. bool seen_digit = false;
  723. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  724. auto accumulate = [&](char c) {
  725. if (mantissa <= limit) {
  726. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  727. return true;
  728. }
  729. return false;
  730. };
  731. for (; p != last && is_ascii_digit(*p); ++p) {
  732. seen_digit = true;
  733. accumulate(*p);
  734. }
  735. if (p != last && *p == '.') {
  736. ++p;
  737. for (; p != last && is_ascii_digit(*p); ++p) {
  738. seen_digit = true;
  739. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  740. }
  741. }
  742. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  743. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  744. return {p, std::errc{}};
  745. }
  746. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  747. int &out) {
  748. int val = 0;
  749. auto r = from_chars(s, s + len, val);
  750. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  751. return false;
  752. }
  753. out = val;
  754. return true;
  755. }
  756. inline bool parse_port(const char *s, size_t len, int &port) {
  757. return parse_int_in_range(s, len, 1, 65535, port);
  758. }
  759. inline bool parse_port(const std::string &s, int &port) {
  760. return parse_port(s.data(), s.size(), port);
  761. }
  762. struct UrlComponents {
  763. std::string scheme;
  764. std::string host;
  765. std::string port;
  766. std::string path;
  767. std::string query;
  768. };
  769. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  770. uc = {};
  771. size_t pos = 0;
  772. auto sep = url.find("://");
  773. if (sep != std::string::npos) {
  774. // Schemes are case-insensitive (RFC 3986 3.1)
  775. uc.scheme = case_ignore::to_lower(url.substr(0, sep));
  776. // Scheme must be [a-z]+ only
  777. if (uc.scheme.empty()) { return false; }
  778. for (auto c : uc.scheme) {
  779. if (c < 'a' || c > 'z') { return false; }
  780. }
  781. pos = sep + 3;
  782. } else if (url.compare(0, 2, "//") == 0) {
  783. pos = 2;
  784. }
  785. auto has_authority_prefix = pos > 0;
  786. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  787. url[0] != '?' && url[0] != '#');
  788. if (has_authority) {
  789. // userinfo is not supported, and a backslash that some parsers take for
  790. // '/' would leave them seeing another host than this one.
  791. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  792. return false;
  793. }
  794. if (pos < url.size() && url[pos] == '[') {
  795. auto close = url.find(']', pos);
  796. if (close == std::string::npos) { return false; }
  797. uc.host = url.substr(pos + 1, close - pos - 1);
  798. // IPv6 host must be [a-fA-F0-9:]+ only
  799. if (uc.host.empty()) { return false; }
  800. for (auto c : uc.host) {
  801. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  802. (c >= 'A' && c <= 'F') || c == ':')) {
  803. return false;
  804. }
  805. }
  806. pos = close + 1;
  807. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  808. // path, query or fragment delimiter (or the end of input). Otherwise the
  809. // trailing bytes would be folded into the path while the connection
  810. // still targets the bracketed address.
  811. if (pos < url.size()) {
  812. auto c = url[pos];
  813. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  814. }
  815. } else {
  816. auto end = url.find_first_of(":/?#", pos);
  817. if (end == std::string::npos) { end = url.size(); }
  818. uc.host = url.substr(pos, end - pos);
  819. pos = end;
  820. }
  821. if (pos < url.size() && url[pos] == ':') {
  822. ++pos;
  823. auto end = url.find_first_of("/?#", pos);
  824. if (end == std::string::npos) { end = url.size(); }
  825. uc.port = url.substr(pos, end - pos);
  826. pos = end;
  827. }
  828. // Without :// or //, the entire input must be consumed as host[:port].
  829. // If there is leftover (path, query, etc.), this is not a valid
  830. // host[:port] string — clear and reparse as a plain path.
  831. if (!has_authority_prefix && pos < url.size()) {
  832. uc.host.clear();
  833. uc.port.clear();
  834. pos = 0;
  835. }
  836. }
  837. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  838. auto end = url.find_first_of("?#", pos);
  839. if (end == std::string::npos) { end = url.size(); }
  840. uc.path = url.substr(pos, end - pos);
  841. pos = end;
  842. }
  843. if (pos < url.size() && url[pos] == '?') {
  844. auto end = url.find('#', pos);
  845. if (end == std::string::npos) { end = url.size(); }
  846. uc.query = url.substr(pos, end - pos);
  847. }
  848. return true;
  849. }
  850. // Removes "." and ".." segments from a path that starts with '/' (RFC 3986
  851. // section 5.2.4).
  852. inline std::string remove_dot_segments(const std::string &path) {
  853. std::string out;
  854. size_t i = 0;
  855. while (i < path.size()) {
  856. auto next = (std::min)(path.find('/', i + 1), path.size());
  857. auto segment = path.substr(i + 1, next - i - 1);
  858. auto is_last = next == path.size();
  859. if (segment == "." || segment == "..") {
  860. if (segment == "..") {
  861. out.erase((std::min)(out.rfind('/'), out.size()));
  862. }
  863. if (is_last) { out += '/'; }
  864. } else {
  865. out += '/';
  866. out += segment;
  867. }
  868. i = next;
  869. }
  870. if (out.empty()) { out = "/"; }
  871. return out;
  872. }
  873. // Resolves a relative-path or query-only Location value against the path of
  874. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  875. // references starting with '/' are returned unchanged.
  876. inline std::string resolve_relative_location(const std::string &location,
  877. const std::string &base) {
  878. if (location.empty() || location[0] == '/') { return location; }
  879. // A ':' in the first segment means the value has a scheme.
  880. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  881. // A path starting with "//" would be re-parsed as an authority. Prefix "/."
  882. // (as the URL Standard does); remove_dot_segments strips it later.
  883. auto on_this_host = [](std::string path) -> std::string {
  884. if (path.compare(0, 2, "//") == 0) { path.insert(0, "/."); }
  885. return path;
  886. };
  887. if (location[0] == '#') {
  888. return on_this_host(base.substr(0, base.find('#')) + location);
  889. }
  890. auto base_path = base.substr(0, base.find_first_of("?#"));
  891. if (location[0] == '?') { return on_this_host(base_path + location); }
  892. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  893. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  894. // Remove "." and ".." segments from the merged path.
  895. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  896. return on_this_host(remove_dot_segments(merged.substr(0, path_end)) +
  897. merged.substr(path_end));
  898. }
  899. } // namespace detail
  900. enum class SSLVerifierResponse {
  901. // no decision has been made, use the built-in certificate verifier
  902. NoDecisionMade,
  903. // connection certificate is verified and accepted
  904. CertificateAccepted,
  905. // connection certificate was processed but is rejected
  906. CertificateRejected
  907. };
  908. // System CA loading policy for SSL clients. Auto (the default) loads system
  909. // CA certs only when no custom CA is configured; enable_system_ca() switches
  910. // to an explicit policy.
  911. enum class SystemCAMode { Auto, Enabled, Disabled };
  912. enum StatusCode {
  913. // Information responses
  914. Continue_100 = 100,
  915. SwitchingProtocol_101 = 101,
  916. Processing_102 = 102,
  917. EarlyHints_103 = 103,
  918. // Successful responses
  919. OK_200 = 200,
  920. Created_201 = 201,
  921. Accepted_202 = 202,
  922. NonAuthoritativeInformation_203 = 203,
  923. NoContent_204 = 204,
  924. ResetContent_205 = 205,
  925. PartialContent_206 = 206,
  926. MultiStatus_207 = 207,
  927. AlreadyReported_208 = 208,
  928. IMUsed_226 = 226,
  929. // Redirection messages
  930. MultipleChoices_300 = 300,
  931. MovedPermanently_301 = 301,
  932. Found_302 = 302,
  933. SeeOther_303 = 303,
  934. NotModified_304 = 304,
  935. UseProxy_305 = 305,
  936. unused_306 = 306,
  937. TemporaryRedirect_307 = 307,
  938. PermanentRedirect_308 = 308,
  939. // Client error responses
  940. BadRequest_400 = 400,
  941. Unauthorized_401 = 401,
  942. PaymentRequired_402 = 402,
  943. Forbidden_403 = 403,
  944. NotFound_404 = 404,
  945. MethodNotAllowed_405 = 405,
  946. NotAcceptable_406 = 406,
  947. ProxyAuthenticationRequired_407 = 407,
  948. RequestTimeout_408 = 408,
  949. Conflict_409 = 409,
  950. Gone_410 = 410,
  951. LengthRequired_411 = 411,
  952. PreconditionFailed_412 = 412,
  953. PayloadTooLarge_413 = 413,
  954. UriTooLong_414 = 414,
  955. UnsupportedMediaType_415 = 415,
  956. RangeNotSatisfiable_416 = 416,
  957. ExpectationFailed_417 = 417,
  958. ImATeapot_418 = 418,
  959. MisdirectedRequest_421 = 421,
  960. UnprocessableContent_422 = 422,
  961. Locked_423 = 423,
  962. FailedDependency_424 = 424,
  963. TooEarly_425 = 425,
  964. UpgradeRequired_426 = 426,
  965. PreconditionRequired_428 = 428,
  966. TooManyRequests_429 = 429,
  967. RequestHeaderFieldsTooLarge_431 = 431,
  968. UnavailableForLegalReasons_451 = 451,
  969. // Server error responses
  970. InternalServerError_500 = 500,
  971. NotImplemented_501 = 501,
  972. BadGateway_502 = 502,
  973. ServiceUnavailable_503 = 503,
  974. GatewayTimeout_504 = 504,
  975. HttpVersionNotSupported_505 = 505,
  976. VariantAlsoNegotiates_506 = 506,
  977. InsufficientStorage_507 = 507,
  978. LoopDetected_508 = 508,
  979. NotExtended_510 = 510,
  980. NetworkAuthenticationRequired_511 = 511,
  981. };
  982. namespace detail {
  983. // A multimap that keeps its entries in the order they were inserted.
  984. //
  985. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  986. // fields sharing a field name significant and forbids a proxy from reordering
  987. // them, and a query string's parameters are meaningful in the order the caller
  988. // wrote them. Neither standard container expresses it: std::unordered_multimap
  989. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  990. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  991. // key, which would drop control data such as Host behind whatever else the
  992. // message carries and alphabetise a query string.
  993. //
  994. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  995. // scan, which beats hashing for the handful of entries a message carries
  996. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  997. //
  998. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  999. // Params, whose parameter names are case-sensitive, not.
  1000. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  1001. public:
  1002. using key_type = std::string;
  1003. using mapped_type = Mapped;
  1004. using value_type = std::pair<std::string, Mapped>;
  1005. using size_type = std::size_t;
  1006. using difference_type = std::ptrdiff_t;
  1007. using reference = value_type &;
  1008. using const_reference = const value_type &;
  1009. private:
  1010. static size_type npos() { return static_cast<size_type>(-1); }
  1011. static bool keys_equal(const std::string &a, const std::string &b) {
  1012. return KeyEqual()(a, b);
  1013. }
  1014. // Iterating yields every entry in insertion order, but equal_range() and
  1015. // find() have to walk only the entries sharing one key, which are not
  1016. // adjacent. Both are the same iterator type: key_idx_ selects between the
  1017. // two traversals, and since equality compares only the position, an iterator
  1018. // restricted to one key still compares equal to end().
  1019. template <typename V> class iterator_t {
  1020. public:
  1021. using iterator_category = std::bidirectional_iterator_tag;
  1022. using value_type = insertion_ordered_multimap::value_type;
  1023. using difference_type = insertion_ordered_multimap::difference_type;
  1024. using pointer = V *;
  1025. using reference = V &;
  1026. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  1027. template <typename U,
  1028. typename std::enable_if<std::is_convertible<U *, V *>::value,
  1029. int>::type = 0>
  1030. iterator_t(const iterator_t<U> &rhs)
  1031. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  1032. key_idx_(rhs.key_idx_) {}
  1033. reference operator*() const { return data_[idx_]; }
  1034. pointer operator->() const { return data_ + idx_; }
  1035. iterator_t &operator++() {
  1036. // Saturating, so that advancing past the last entry of a key stays at
  1037. // end() instead of running off the container.
  1038. if (idx_ >= size_) { return *this; }
  1039. ++idx_;
  1040. if (key_idx_ != npos()) {
  1041. while (idx_ < size_ && !matches(idx_)) {
  1042. ++idx_;
  1043. }
  1044. }
  1045. return *this;
  1046. }
  1047. iterator_t operator++(int) {
  1048. auto tmp = *this;
  1049. ++*this;
  1050. return tmp;
  1051. }
  1052. iterator_t &operator--() {
  1053. if (idx_ == 0) { return *this; }
  1054. --idx_;
  1055. if (key_idx_ != npos()) {
  1056. while (idx_ > 0 && !matches(idx_)) {
  1057. --idx_;
  1058. }
  1059. }
  1060. return *this;
  1061. }
  1062. iterator_t operator--(int) {
  1063. auto tmp = *this;
  1064. --*this;
  1065. return tmp;
  1066. }
  1067. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1068. return idx_ == rhs.idx_;
  1069. }
  1070. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1071. return idx_ != rhs.idx_;
  1072. }
  1073. private:
  1074. friend class insertion_ordered_multimap;
  1075. template <typename> friend class iterator_t;
  1076. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1077. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1078. bool matches(size_type i) const {
  1079. return keys_equal(data_[i].first, data_[key_idx_].first);
  1080. }
  1081. V *data_;
  1082. size_type idx_;
  1083. size_type size_;
  1084. size_type key_idx_;
  1085. };
  1086. public:
  1087. using iterator = iterator_t<value_type>;
  1088. using const_iterator = iterator_t<const value_type>;
  1089. insertion_ordered_multimap() = default;
  1090. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1091. : entries_(il) {}
  1092. template <typename InputIt>
  1093. insertion_ordered_multimap(InputIt first, InputIt last)
  1094. : entries_(first, last) {}
  1095. iterator begin() { return make_iter(0, npos()); }
  1096. iterator end() { return make_iter(entries_.size(), npos()); }
  1097. const_iterator begin() const { return make_citer(0, npos()); }
  1098. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1099. const_iterator cbegin() const { return begin(); }
  1100. const_iterator cend() const { return end(); }
  1101. bool empty() const { return entries_.empty(); }
  1102. size_type size() const { return entries_.size(); }
  1103. void clear() { entries_.clear(); }
  1104. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1105. iterator insert(const value_type &val) {
  1106. entries_.push_back(val);
  1107. return make_iter(entries_.size() - 1, npos());
  1108. }
  1109. iterator insert(value_type &&val) {
  1110. entries_.push_back(std::move(val));
  1111. return make_iter(entries_.size() - 1, npos());
  1112. }
  1113. template <typename... Args> iterator emplace(Args &&...args) {
  1114. entries_.emplace_back(std::forward<Args>(args)...);
  1115. return make_iter(entries_.size() - 1, npos());
  1116. }
  1117. // For entries that have to lead the message, such as the Host header field
  1118. // (RFC 9110 5.3 recommends sending control data first).
  1119. template <typename... Args> iterator emplace_front(Args &&...args) {
  1120. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1121. return make_iter(0, npos());
  1122. }
  1123. iterator find(const std::string &key) {
  1124. auto i = index_of(key);
  1125. return i == npos() ? end() : make_iter(i, i);
  1126. }
  1127. const_iterator find(const std::string &key) const {
  1128. auto i = index_of(key);
  1129. return i == npos() ? end() : make_citer(i, i);
  1130. }
  1131. size_type count(const std::string &key) const {
  1132. size_type n = 0;
  1133. for (const auto &entry : entries_) {
  1134. if (keys_equal(entry.first, key)) { n++; }
  1135. }
  1136. return n;
  1137. }
  1138. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1139. auto i = index_of(key);
  1140. return i == npos() ? std::make_pair(end(), end())
  1141. : std::make_pair(make_iter(i, i), end());
  1142. }
  1143. std::pair<const_iterator, const_iterator>
  1144. equal_range(const std::string &key) const {
  1145. auto i = index_of(key);
  1146. return i == npos() ? std::make_pair(end(), end())
  1147. : std::make_pair(make_citer(i, i), end());
  1148. }
  1149. size_type erase(const std::string &key) {
  1150. auto before = entries_.size();
  1151. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1152. [key](const value_type &entry) {
  1153. return keys_equal(entry.first, key);
  1154. }),
  1155. entries_.end());
  1156. return before - entries_.size();
  1157. }
  1158. iterator erase(const_iterator pos) {
  1159. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1160. return make_iter(pos.idx_, npos());
  1161. }
  1162. // Erases what iterating [first, last) would actually visit, so erasing an
  1163. // equal_range() removes only the entries with that key, not everything
  1164. // positioned between them.
  1165. iterator erase(const_iterator first, const_iterator last) {
  1166. auto from = first.idx_;
  1167. auto to = last.idx_;
  1168. if (from >= to) { return make_iter(from, npos()); }
  1169. auto begin_it = entries_.begin();
  1170. auto from_it = begin_it + static_cast<difference_type>(from);
  1171. auto to_it = begin_it + static_cast<difference_type>(to);
  1172. if (first.key_idx_ == npos()) {
  1173. entries_.erase(from_it, to_it);
  1174. } else {
  1175. auto key = entries_[first.key_idx_].first;
  1176. auto keep = from_it;
  1177. for (auto it = from_it; it != to_it; ++it) {
  1178. if (!keys_equal(it->first, key)) {
  1179. if (keep != it) { *keep = std::move(*it); }
  1180. ++keep;
  1181. }
  1182. }
  1183. if (keep != to_it) {
  1184. keep = std::move(to_it, entries_.end(), keep);
  1185. } else {
  1186. keep = entries_.end();
  1187. }
  1188. entries_.erase(keep, entries_.end());
  1189. }
  1190. return make_iter(from, npos());
  1191. }
  1192. friend bool operator==(const insertion_ordered_multimap &lhs,
  1193. const insertion_ordered_multimap &rhs) {
  1194. return lhs.entries_ == rhs.entries_;
  1195. }
  1196. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1197. const insertion_ordered_multimap &rhs) {
  1198. return !(lhs == rhs);
  1199. }
  1200. private:
  1201. size_type index_of(const std::string &key) const {
  1202. for (size_type i = 0; i < entries_.size(); i++) {
  1203. if (keys_equal(entries_[i].first, key)) { return i; }
  1204. }
  1205. return npos();
  1206. }
  1207. iterator make_iter(size_type idx, size_type key_idx) {
  1208. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1209. }
  1210. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1211. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1212. }
  1213. std::vector<value_type> entries_;
  1214. };
  1215. } // namespace detail
  1216. using Headers =
  1217. detail::insertion_ordered_multimap<std::string,
  1218. detail::case_ignore::equal_to>;
  1219. // Query parameter names are case-sensitive, unlike header field names.
  1220. using Params =
  1221. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1222. using Match = std::smatch;
  1223. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1224. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1225. /*
  1226. * detail: type-erased storage used by UserData.
  1227. * ABI-stable regardless of C++ standard — always uses this custom
  1228. * implementation instead of std::any.
  1229. */
  1230. namespace detail {
  1231. using any_type_id = const void *;
  1232. template <typename T> any_type_id any_typeid() noexcept {
  1233. static const char id = 0;
  1234. return &id;
  1235. }
  1236. struct any_storage {
  1237. virtual ~any_storage() = default;
  1238. virtual std::unique_ptr<any_storage> clone() const = 0;
  1239. virtual any_type_id type_id() const noexcept = 0;
  1240. };
  1241. template <typename T> struct any_value final : any_storage {
  1242. T value;
  1243. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1244. std::unique_ptr<any_storage> clone() const override {
  1245. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1246. }
  1247. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1248. };
  1249. } // namespace detail
  1250. class UserData {
  1251. public:
  1252. UserData() = default;
  1253. UserData(UserData &&) noexcept = default;
  1254. UserData &operator=(UserData &&) noexcept = default;
  1255. UserData(const UserData &o) {
  1256. for (const auto &e : o.entries_) {
  1257. if (e.second) { entries_[e.first] = e.second->clone(); }
  1258. }
  1259. }
  1260. UserData &operator=(const UserData &o) {
  1261. if (this != &o) {
  1262. entries_.clear();
  1263. for (const auto &e : o.entries_) {
  1264. if (e.second) { entries_[e.first] = e.second->clone(); }
  1265. }
  1266. }
  1267. return *this;
  1268. }
  1269. template <typename T> void set(const std::string &key, T &&value) {
  1270. using D = typename std::decay<T>::type;
  1271. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1272. }
  1273. template <typename T> T *get(const std::string &key) noexcept {
  1274. auto it = entries_.find(key);
  1275. if (it == entries_.end() || !it->second) { return nullptr; }
  1276. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1277. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1278. }
  1279. template <typename T> const T *get(const std::string &key) const noexcept {
  1280. auto it = entries_.find(key);
  1281. if (it == entries_.end() || !it->second) { return nullptr; }
  1282. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1283. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1284. }
  1285. bool has(const std::string &key) const noexcept {
  1286. return entries_.find(key) != entries_.end();
  1287. }
  1288. void erase(const std::string &key) { entries_.erase(key); }
  1289. void clear() noexcept { entries_.clear(); }
  1290. private:
  1291. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1292. entries_;
  1293. };
  1294. struct Response;
  1295. using ResponseHandler = std::function<bool(const Response &response)>;
  1296. struct FormData {
  1297. std::string name;
  1298. std::string content;
  1299. std::string filename;
  1300. std::string content_type;
  1301. Headers headers;
  1302. };
  1303. struct FormField {
  1304. std::string name;
  1305. std::string content;
  1306. Headers headers;
  1307. };
  1308. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1309. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1310. // should see the parts as they were sent. A std::multimap sorts by field name
  1311. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1312. // than the case-insensitive predicate Headers uses.
  1313. using FormFields =
  1314. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1315. using FormFiles =
  1316. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1317. struct MultipartFormData {
  1318. FormFields fields; // Text fields from multipart
  1319. FormFiles files; // Files from multipart
  1320. // Text field access
  1321. std::string get_field(const std::string &key, size_t id = 0) const;
  1322. std::vector<std::string> get_fields(const std::string &key) const;
  1323. bool has_field(const std::string &key) const;
  1324. size_t get_field_count(const std::string &key) const;
  1325. // File access
  1326. FormData get_file(const std::string &key, size_t id = 0) const;
  1327. std::vector<FormData> get_files(const std::string &key) const;
  1328. bool has_file(const std::string &key) const;
  1329. size_t get_file_count(const std::string &key) const;
  1330. };
  1331. struct UploadFormData {
  1332. std::string name;
  1333. std::string content;
  1334. std::string filename;
  1335. std::string content_type;
  1336. };
  1337. using UploadFormDataItems = std::vector<UploadFormData>;
  1338. class DataSink {
  1339. public:
  1340. DataSink() : os(&sb_), sb_(*this) {}
  1341. DataSink(const DataSink &) = delete;
  1342. DataSink &operator=(const DataSink &) = delete;
  1343. DataSink(DataSink &&) = delete;
  1344. DataSink &operator=(DataSink &&) = delete;
  1345. std::function<bool(const char *data, size_t data_len)> write;
  1346. // Only `write` is mandatory. The rest are defaulted so that a provider
  1347. // calling one on a writer that does not set it gets sensible behaviour
  1348. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1349. // `this` is safe: DataSink is neither copyable nor movable.
  1350. std::function<bool()> is_writable = []() { return true; };
  1351. std::function<void()> done = []() {};
  1352. std::function<void(const Headers &trailer)> done_with_trailer =
  1353. [this](const Headers & /*trailer*/) { done(); };
  1354. std::ostream os;
  1355. private:
  1356. class data_sink_streambuf final : public std::streambuf {
  1357. public:
  1358. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1359. protected:
  1360. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1361. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1362. return 0;
  1363. }
  1364. private:
  1365. DataSink &sink_;
  1366. };
  1367. data_sink_streambuf sb_;
  1368. };
  1369. using ContentProvider =
  1370. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1371. using ContentProviderWithoutLength =
  1372. std::function<bool(size_t offset, DataSink &sink)>;
  1373. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1374. struct FormDataProvider {
  1375. std::string name;
  1376. ContentProviderWithoutLength provider;
  1377. std::string filename;
  1378. std::string content_type;
  1379. };
  1380. using FormDataProviderItems = std::vector<FormDataProvider>;
  1381. inline FormDataProvider
  1382. make_file_provider(const std::string &name, const std::string &filepath,
  1383. const std::string &filename = std::string(),
  1384. const std::string &content_type = std::string()) {
  1385. FormDataProvider fdp;
  1386. fdp.name = name;
  1387. fdp.filename = filename.empty() ? filepath : filename;
  1388. fdp.content_type = content_type;
  1389. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1390. std::ifstream f(filepath, std::ios::binary);
  1391. if (!f) { return false; }
  1392. if (offset > 0) {
  1393. f.seekg(static_cast<std::streamoff>(offset));
  1394. if (!f.good()) {
  1395. sink.done();
  1396. return true;
  1397. }
  1398. }
  1399. char buf[8192];
  1400. f.read(buf, sizeof(buf));
  1401. auto n = static_cast<size_t>(f.gcount());
  1402. if (n > 0) { return sink.write(buf, n); }
  1403. sink.done(); // EOF
  1404. return true;
  1405. };
  1406. return fdp;
  1407. }
  1408. inline std::pair<size_t, ContentProvider>
  1409. make_file_body(const std::string &filepath) {
  1410. size_t size = 0;
  1411. {
  1412. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1413. if (!f) { return {0, ContentProvider{}}; }
  1414. size = static_cast<size_t>(f.tellg());
  1415. }
  1416. ContentProvider provider = [filepath](size_t offset, size_t length,
  1417. DataSink &sink) -> bool {
  1418. std::ifstream f(filepath, std::ios::binary);
  1419. if (!f) { return false; }
  1420. f.seekg(static_cast<std::streamoff>(offset));
  1421. if (!f.good()) { return false; }
  1422. char buf[8192];
  1423. while (length > 0) {
  1424. auto to_read = (std::min)(sizeof(buf), length);
  1425. f.read(buf, static_cast<std::streamsize>(to_read));
  1426. auto n = static_cast<size_t>(f.gcount());
  1427. // The file is shorter than the size make_file_body() measured, which the
  1428. // caller has already committed to as Content-Length. The body cannot be
  1429. // completed, so fail as every other error here does.
  1430. if (n == 0) { return false; }
  1431. if (!sink.write(buf, n)) { return false; }
  1432. length -= n;
  1433. }
  1434. return true;
  1435. };
  1436. return {size, std::move(provider)};
  1437. }
  1438. using ContentReceiverWithProgress = std::function<bool(
  1439. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1440. using ContentReceiver =
  1441. std::function<bool(const char *data, size_t data_length)>;
  1442. using FormDataHeader = std::function<bool(const FormData &file)>;
  1443. class ContentReader {
  1444. public:
  1445. using Reader = std::function<bool(ContentReceiver receiver)>;
  1446. using FormDataReader =
  1447. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1448. ContentReader(Reader reader, FormDataReader multipart_reader)
  1449. : reader_(std::move(reader)),
  1450. formdata_reader_(std::move(multipart_reader)) {}
  1451. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1452. return formdata_reader_(std::move(header), std::move(receiver));
  1453. }
  1454. bool operator()(ContentReceiver receiver) const {
  1455. return reader_(std::move(receiver));
  1456. }
  1457. Reader reader_;
  1458. FormDataReader formdata_reader_;
  1459. };
  1460. using Range = std::pair<ssize_t, ssize_t>;
  1461. using Ranges = std::vector<Range>;
  1462. #ifdef CPPHTTPLIB_SSL_ENABLED
  1463. // TLS abstraction layer - public type definitions and API
  1464. namespace tls {
  1465. // Opaque handles (defined as void* for abstraction)
  1466. using ctx_t = void *;
  1467. using session_t = void *;
  1468. using const_session_t = const void *; // For read-only session access
  1469. using cert_t = void *;
  1470. using ca_store_t = void *;
  1471. // TLS versions
  1472. enum class Version {
  1473. TLS1_2 = 0x0303,
  1474. TLS1_3 = 0x0304,
  1475. };
  1476. // Subject Alternative Names (SAN) entry types
  1477. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1478. // SAN entry structure
  1479. struct SanEntry {
  1480. SanType type;
  1481. std::string value;
  1482. };
  1483. // Verification context for certificate verification callback
  1484. struct VerifyContext {
  1485. session_t session; // TLS session handle
  1486. cert_t cert; // Current certificate being verified
  1487. int depth; // Certificate chain depth (0 = leaf)
  1488. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1489. long error_code; // Backend-specific error code (0 = no error)
  1490. const char *error_string; // Human-readable error description
  1491. // Certificate introspection methods
  1492. std::string subject_cn() const;
  1493. std::string issuer_name() const;
  1494. bool check_hostname(const char *hostname) const;
  1495. std::vector<SanEntry> sans() const;
  1496. bool validity(time_t &not_before, time_t &not_after) const;
  1497. std::string serial() const;
  1498. };
  1499. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1500. // TlsError codes for TLS operations (backend-independent)
  1501. enum class ErrorCode : int {
  1502. Success = 0,
  1503. WantRead, // Non-blocking: need to wait for read
  1504. WantWrite, // Non-blocking: need to wait for write
  1505. PeerClosed, // Peer closed the connection
  1506. Fatal, // Unrecoverable error
  1507. SyscallError, // System call error (check sys_errno)
  1508. CertVerifyFailed, // Certificate verification failed
  1509. HostnameMismatch, // Hostname verification failed
  1510. };
  1511. // TLS error information
  1512. struct TlsError {
  1513. ErrorCode code = ErrorCode::Fatal;
  1514. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1515. int sys_errno = 0; // errno when SyscallError
  1516. // Convert verification error code to human-readable string
  1517. static std::string verify_error_to_string(long error_code);
  1518. };
  1519. // RAII wrapper for peer certificate
  1520. class PeerCert {
  1521. public:
  1522. PeerCert();
  1523. PeerCert(PeerCert &&other) noexcept;
  1524. PeerCert &operator=(PeerCert &&other) noexcept;
  1525. ~PeerCert();
  1526. PeerCert(const PeerCert &) = delete;
  1527. PeerCert &operator=(const PeerCert &) = delete;
  1528. explicit operator bool() const;
  1529. std::string subject_cn() const;
  1530. std::string issuer_name() const;
  1531. bool check_hostname(const char *hostname) const;
  1532. std::vector<SanEntry> sans() const;
  1533. bool validity(time_t &not_before, time_t &not_after) const;
  1534. std::string serial() const;
  1535. private:
  1536. explicit PeerCert(cert_t cert);
  1537. cert_t cert_ = nullptr;
  1538. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1539. };
  1540. // Callback for TLS context setup (used by SSLServer constructor)
  1541. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1542. } // namespace tls
  1543. #endif
  1544. struct Request {
  1545. std::string method;
  1546. std::string path;
  1547. std::string matched_route;
  1548. Params params;
  1549. Headers headers;
  1550. Headers trailers;
  1551. std::string body;
  1552. std::string remote_addr;
  1553. int remote_port = -1;
  1554. std::string local_addr;
  1555. int local_port = -1;
  1556. // for server
  1557. std::string version;
  1558. std::string target;
  1559. MultipartFormData form;
  1560. Ranges ranges;
  1561. Match matches;
  1562. std::unordered_map<std::string, std::string> path_params;
  1563. std::function<bool()> is_connection_closed = []() { return true; };
  1564. // for client
  1565. std::vector<std::string> accept_content_types;
  1566. ResponseHandler response_handler;
  1567. ContentReceiverWithProgress content_receiver;
  1568. DownloadProgress download_progress;
  1569. UploadProgress upload_progress;
  1570. bool has_header(const std::string &key) const;
  1571. std::string get_header_value(const std::string &key, const char *def = "",
  1572. size_t id = 0) const;
  1573. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1574. size_t id = 0) const;
  1575. size_t get_header_value_count(const std::string &key) const;
  1576. void set_header(const std::string &key, const std::string &val);
  1577. bool has_trailer(const std::string &key) const;
  1578. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1579. size_t get_trailer_value_count(const std::string &key) const;
  1580. bool has_param(const std::string &key) const;
  1581. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1582. std::vector<std::string> get_param_values(const std::string &key) const;
  1583. size_t get_param_value_count(const std::string &key) const;
  1584. bool is_multipart_form_data() const;
  1585. // private members...
  1586. bool body_read_started_ = false;
  1587. bool body_consumed_ = false;
  1588. bool expect_100_continue_pending_ = false;
  1589. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1590. size_t content_length_ = 0;
  1591. ContentProvider content_provider_;
  1592. bool is_chunked_content_provider_ = false;
  1593. size_t authorization_count_ = 0;
  1594. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1595. (std::chrono::steady_clock::time_point::min)();
  1596. #ifdef CPPHTTPLIB_SSL_ENABLED
  1597. tls::const_session_t ssl = nullptr;
  1598. tls::PeerCert peer_cert() const;
  1599. std::string sni() const;
  1600. #endif
  1601. };
  1602. namespace detail {
  1603. // Declared up here, away from the rest of the compression helpers, because
  1604. // `Response` stores one.
  1605. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1606. } // namespace detail
  1607. struct Response {
  1608. std::string version;
  1609. int status = -1;
  1610. std::string reason;
  1611. Headers headers;
  1612. Headers trailers;
  1613. std::string body;
  1614. std::string location; // Redirect location
  1615. // User-defined context — set by pre-routing/pre-request handlers and read
  1616. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1617. UserData user_data;
  1618. bool has_header(const std::string &key) const;
  1619. std::string get_header_value(const std::string &key, const char *def = "",
  1620. size_t id = 0) const;
  1621. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1622. size_t id = 0) const;
  1623. size_t get_header_value_count(const std::string &key) const;
  1624. void set_header(const std::string &key, const std::string &val);
  1625. bool has_trailer(const std::string &key) const;
  1626. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1627. size_t get_trailer_value_count(const std::string &key) const;
  1628. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1629. void set_content(const char *s, size_t n, const std::string &content_type);
  1630. void set_content(const std::string &s, const std::string &content_type);
  1631. void set_content(std::string &&s, const std::string &content_type);
  1632. void set_content_provider(
  1633. size_t length, const std::string &content_type, ContentProvider provider,
  1634. ContentProviderResourceReleaser resource_releaser = nullptr);
  1635. void set_content_provider(
  1636. const std::string &content_type, ContentProviderWithoutLength provider,
  1637. ContentProviderResourceReleaser resource_releaser = nullptr);
  1638. void set_chunked_content_provider(
  1639. const std::string &content_type, ContentProviderWithoutLength provider,
  1640. ContentProviderResourceReleaser resource_releaser = nullptr);
  1641. void set_file_content(const std::string &path,
  1642. const std::string &content_type);
  1643. void set_file_content(const std::string &path);
  1644. Response() = default;
  1645. Response(const Response &) = default;
  1646. Response &operator=(const Response &) = default;
  1647. Response(Response &&) = default;
  1648. Response &operator=(Response &&) = default;
  1649. ~Response() {
  1650. if (content_provider_resource_releaser_) {
  1651. content_provider_resource_releaser_(content_provider_success_);
  1652. }
  1653. }
  1654. // private members...
  1655. size_t content_length_ = 0;
  1656. ContentProvider content_provider_;
  1657. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1658. bool is_chunked_content_provider_ = false;
  1659. bool is_file_content_provider_ = false;
  1660. bool content_provider_success_ = false;
  1661. std::string file_content_path_;
  1662. std::string file_content_content_type_;
  1663. // Content coding chosen for the response body, decided once so that the
  1664. // headers and the body cannot disagree: where the file is opened for a
  1665. // file-backed content provider (keeping the ETag honest), and in
  1666. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1667. // for every other kind of response.
  1668. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1669. };
  1670. enum class Error {
  1671. Success = 0,
  1672. Unknown,
  1673. Connection,
  1674. BindIPAddress,
  1675. Read,
  1676. Write,
  1677. ExceedRedirectCount,
  1678. Canceled,
  1679. SSLConnection,
  1680. SSLLoadingCerts,
  1681. SSLServerVerification,
  1682. SSLServerHostnameVerification,
  1683. UnsupportedMultipartBoundaryChars,
  1684. Compression,
  1685. ConnectionTimeout,
  1686. ProxyConnection,
  1687. ConnectionClosed,
  1688. Timeout,
  1689. ResourceExhaustion,
  1690. TooManyFormDataFiles,
  1691. ExceedMaxPayloadSize,
  1692. ExceedUriMaxLength,
  1693. ExceedMaxSocketDescriptorCount,
  1694. InvalidRequestLine,
  1695. InvalidHTTPMethod,
  1696. InvalidHTTPVersion,
  1697. InvalidHeaders,
  1698. MultipartParsing,
  1699. OpenFile,
  1700. Listen,
  1701. GetSockName,
  1702. UnsupportedAddressFamily,
  1703. HTTPParsing,
  1704. InvalidRangeHeader,
  1705. UnsupportedContentEncoding,
  1706. WebSocketHandshake,
  1707. UserCallbackException,
  1708. // For internal use only
  1709. SSLPeerCouldBeClosed_,
  1710. };
  1711. std::string to_string(Error error);
  1712. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1713. class Stream {
  1714. public:
  1715. virtual ~Stream() = default;
  1716. virtual bool is_readable() const = 0;
  1717. virtual bool wait_readable() const = 0;
  1718. virtual bool wait_writable() const = 0;
  1719. virtual bool is_peer_alive() const { return wait_writable(); }
  1720. virtual ssize_t read(char *ptr, size_t size) = 0;
  1721. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1722. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1723. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1724. virtual socket_t socket() const = 0;
  1725. virtual time_t duration() const = 0;
  1726. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1727. (void)sec;
  1728. (void)usec;
  1729. }
  1730. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1731. // each one. 0 lifts the bound.
  1732. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1733. // Lets a wait for data end early once `interrupted` returns true, so that
  1734. // another thread can stop a blocked read on every platform.
  1735. virtual void set_read_interrupt(std::function<bool()> interrupted) {
  1736. (void)interrupted;
  1737. }
  1738. // Bytes already pulled off the socket and sitting in this stream's own
  1739. // buffer. Exposing them lets a line reader scan for a terminator in one
  1740. // pass instead of asking for a byte at a time. A stream that does no
  1741. // buffering of its own reports none, and readers fall back to read().
  1742. virtual const char *buffered_data(size_t &size) const {
  1743. size = 0;
  1744. return nullptr;
  1745. }
  1746. // Discards `size` bytes previously returned by buffered_data().
  1747. virtual void consume_buffered(size_t size) { (void)size; }
  1748. ssize_t write(const char *ptr);
  1749. ssize_t write(const std::string &s);
  1750. Error get_error() const { return error_; }
  1751. protected:
  1752. Error error_ = Error::Success;
  1753. };
  1754. class TaskQueue {
  1755. public:
  1756. TaskQueue() = default;
  1757. virtual ~TaskQueue() = default;
  1758. virtual bool enqueue(std::function<void()> fn) = 0;
  1759. virtual void shutdown() = 0;
  1760. virtual void on_idle() {}
  1761. };
  1762. class ThreadPool final : public TaskQueue {
  1763. public:
  1764. explicit ThreadPool(
  1765. size_t n, size_t max_n = 0, size_t mqr = 0,
  1766. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1767. ThreadPool(const ThreadPool &) = delete;
  1768. ~ThreadPool() override = default;
  1769. bool enqueue(std::function<void()> fn) override;
  1770. void shutdown() override;
  1771. private:
  1772. void worker(bool is_dynamic);
  1773. void move_to_finished(std::thread::id id);
  1774. void cleanup_finished_threads();
  1775. size_t base_thread_count_;
  1776. size_t max_thread_count_;
  1777. size_t max_queued_requests_;
  1778. time_t idle_timeout_sec_;
  1779. size_t idle_thread_count_;
  1780. bool shutdown_;
  1781. std::list<std::function<void()>> jobs_;
  1782. std::vector<std::thread> threads_; // base threads
  1783. std::list<std::thread> dynamic_threads_; // dynamic threads
  1784. std::vector<std::thread>
  1785. finished_threads_; // exited dynamic threads awaiting join
  1786. std::condition_variable cond_;
  1787. std::mutex mutex_;
  1788. };
  1789. using Logger = std::function<void(const Request &, const Response &)>;
  1790. // Forward declaration for Error type
  1791. enum class Error;
  1792. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1793. using SocketOptions = std::function<void(socket_t sock)>;
  1794. void default_socket_options(socket_t sock);
  1795. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1796. const char *status_message(int status);
  1797. std::string to_string(Error error);
  1798. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1799. std::string get_bearer_token_auth(const Request &req);
  1800. namespace detail {
  1801. class MatcherBase {
  1802. public:
  1803. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1804. virtual ~MatcherBase() = default;
  1805. const std::string &pattern() const { return pattern_; }
  1806. // Match request path and populate its matches and
  1807. virtual bool match(Request &request) const = 0;
  1808. private:
  1809. std::string pattern_;
  1810. };
  1811. /**
  1812. * Captures parameters in request path and stores them in Request::path_params
  1813. *
  1814. * Capture name is a substring of a pattern from : to /.
  1815. * The rest of the pattern is matched against the request path directly
  1816. * Parameters are captured starting from the next character after
  1817. * the end of the last matched static pattern fragment until the next /.
  1818. *
  1819. * Example pattern:
  1820. * "/path/fragments/:capture/more/fragments/:second_capture"
  1821. * Static fragments:
  1822. * "/path/fragments/", "more/fragments/"
  1823. *
  1824. * Given the following request path:
  1825. * "/path/fragments/:1/more/fragments/:2"
  1826. * the resulting capture will be
  1827. * {{"capture", "1"}, {"second_capture", "2"}}
  1828. */
  1829. class PathParamsMatcher final : public MatcherBase {
  1830. public:
  1831. PathParamsMatcher(const std::string &pattern);
  1832. bool match(Request &request) const override;
  1833. private:
  1834. // Treat segment separators as the end of path parameter capture
  1835. // Does not need to handle query parameters as they are parsed before path
  1836. // matching
  1837. static constexpr char separator = '/';
  1838. // Contains static path fragments to match against, excluding the '/' after
  1839. // path params
  1840. // Fragments are separated by path params
  1841. std::vector<std::string> static_fragments_;
  1842. // Stores the names of the path parameters to be used as keys in the
  1843. // Request::path_params map
  1844. std::vector<std::string> param_names_;
  1845. };
  1846. /**
  1847. * Performs std::regex_match on request path
  1848. * and stores the result in Request::matches
  1849. *
  1850. * Note that regex match is performed directly on the whole request.
  1851. * This means that wildcard patterns may match multiple path segments with /:
  1852. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1853. */
  1854. class RegexMatcher final : public MatcherBase {
  1855. public:
  1856. RegexMatcher(const std::string &pattern)
  1857. : MatcherBase(pattern), regex_(pattern) {}
  1858. bool match(Request &request) const override;
  1859. private:
  1860. std::regex regex_;
  1861. };
  1862. int close_socket(socket_t sock) noexcept;
  1863. bool is_accept_resource_error();
  1864. bool is_accept_transient_error();
  1865. ssize_t write_headers(Stream &strm, const Headers &headers);
  1866. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1867. time_t usec);
  1868. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1869. const std::string &boundary);
  1870. ContentProvider
  1871. make_multipart_content_provider(const UploadFormDataItems &items,
  1872. const std::string &boundary);
  1873. } // namespace detail
  1874. bool is_valid_multipart_boundary(const std::string &boundary);
  1875. // Serializer for multipart/form-data request bodies. The boundary is owned
  1876. // by the writer so that per-part framing and the final terminator always
  1877. // agree. Field names and filenames are escaped following the WHATWG HTML
  1878. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1879. // in content types.
  1880. class MultipartFormDataWriter {
  1881. public:
  1882. MultipartFormDataWriter();
  1883. // precondition: is_valid_multipart_boundary(boundary)
  1884. explicit MultipartFormDataWriter(std::string boundary);
  1885. const std::string &boundary() const;
  1886. std::string content_type() const;
  1887. // In-memory items -> whole body (known length)
  1888. std::string serialize(const UploadFormDataItems &items) const;
  1889. size_t content_length(const UploadFormDataItems &items) const;
  1890. // Per-part framing for streaming via a content provider
  1891. std::string item_begin(const UploadFormData &item) const;
  1892. static std::string item_end();
  1893. std::string finish() const;
  1894. private:
  1895. std::string boundary_;
  1896. };
  1897. class Server {
  1898. public:
  1899. using Handler = std::function<void(const Request &, Response &)>;
  1900. using ExceptionHandler =
  1901. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1902. enum class HandlerResponse {
  1903. Handled,
  1904. Unhandled,
  1905. };
  1906. using HandlerWithResponse =
  1907. std::function<HandlerResponse(const Request &, Response &)>;
  1908. using HandlerWithContentReader = std::function<void(
  1909. const Request &, Response &, const ContentReader &content_reader)>;
  1910. using Expect100ContinueHandler =
  1911. std::function<int(const Request &, Response &)>;
  1912. using StartHandler = std::function<void()>;
  1913. using WebSocketHandler =
  1914. std::function<void(const Request &, ws::WebSocket &)>;
  1915. using SubProtocolSelector =
  1916. std::function<std::string(const std::vector<std::string> &protocols)>;
  1917. Server();
  1918. virtual ~Server();
  1919. virtual bool is_valid() const;
  1920. Server &Get(const std::string &pattern, Handler handler);
  1921. Server &Post(const std::string &pattern, Handler handler);
  1922. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1923. Server &Put(const std::string &pattern, Handler handler);
  1924. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1925. Server &Patch(const std::string &pattern, Handler handler);
  1926. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1927. Server &Delete(const std::string &pattern, Handler handler);
  1928. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1929. Server &Options(const std::string &pattern, Handler handler);
  1930. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1931. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1932. // server accept it; an unregistered method is still rejected with 400.
  1933. // `method` must be a valid HTTP method token and must not be one of the
  1934. // built-in methods, which have their own registration functions above. A
  1935. // rejected registration makes is_valid() return false, so listen() fails.
  1936. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1937. Handler handler);
  1938. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1939. HandlerWithContentReader handler);
  1940. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1941. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1942. SubProtocolSelector sub_protocol_selector);
  1943. bool set_base_dir(const std::string &dir,
  1944. const std::string &mount_point = std::string());
  1945. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1946. Headers headers = Headers());
  1947. bool remove_mount_point(const std::string &mount_point);
  1948. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1949. const std::string &mime);
  1950. Server &set_default_file_mimetype(const std::string &mime);
  1951. Server &set_file_request_handler(Handler handler);
  1952. template <class ErrorHandlerFunc>
  1953. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1954. return set_error_handler_core(
  1955. std::forward<ErrorHandlerFunc>(handler),
  1956. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1957. }
  1958. Server &set_exception_handler(ExceptionHandler handler);
  1959. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1960. Server &set_post_routing_handler(Handler handler);
  1961. Server &set_pre_request_handler(HandlerWithResponse handler);
  1962. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1963. Server &set_start_handler(StartHandler handler);
  1964. Server &set_logger(Logger logger);
  1965. Server &set_pre_compression_logger(Logger logger);
  1966. Server &set_error_logger(ErrorLogger error_logger);
  1967. Server &set_address_family(int family);
  1968. Server &set_tcp_nodelay(bool on);
  1969. Server &set_ipv6_v6only(bool on);
  1970. Server &set_socket_options(SocketOptions socket_options);
  1971. Server &set_default_headers(Headers headers);
  1972. Server &
  1973. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1974. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1975. Server &set_keep_alive_max_count(size_t count);
  1976. Server &set_keep_alive_timeout(time_t sec);
  1977. template <class Rep, class Period>
  1978. Server &
  1979. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1980. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1981. template <class Rep, class Period>
  1982. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1983. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1984. template <class Rep, class Period>
  1985. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1986. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1987. template <class Rep, class Period>
  1988. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1989. // Keeps idle keep-alive connections in an event loop instead of a worker
  1990. // thread each. Call it before listen(). See README for what changes.
  1991. Server &set_keep_alive_parking(bool on);
  1992. Server &set_payload_max_length(size_t length);
  1993. Server &set_compress(bool on);
  1994. Server &set_static_file_compression(bool on);
  1995. Server &set_static_file_compression_min_length(size_t length);
  1996. Server &set_static_file_compression_max_length(size_t length);
  1997. Server &set_websocket_ping_interval(time_t sec);
  1998. template <class Rep, class Period>
  1999. Server &set_websocket_ping_interval(
  2000. const std::chrono::duration<Rep, Period> &duration);
  2001. Server &set_websocket_max_missed_pongs(int count);
  2002. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  2003. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  2004. bool listen_after_bind();
  2005. bool listen(const std::string &host, int port, int socket_flags = 0);
  2006. bool is_running() const;
  2007. void wait_until_ready() const;
  2008. void stop() noexcept;
  2009. void decommission();
  2010. std::function<TaskQueue *(void)> new_task_queue;
  2011. protected:
  2012. bool process_request(Stream &strm, const std::string &remote_addr,
  2013. int remote_port, const std::string &local_addr,
  2014. int local_port, bool close_connection,
  2015. bool &connection_closed,
  2016. const std::function<void(Request &)> &setup_request,
  2017. bool *websocket_upgraded = nullptr);
  2018. // Runs the per-connection serving loop and stops an exception thrown by a
  2019. // user callback from escaping the worker thread.
  2020. //
  2021. // process_request() wraps only routing() and the hooks before a WebSocket
  2022. // upgrade in a try/catch. Content providers, the post-routing, error,
  2023. // logging and expect-100 handlers and WebSocket handlers all run outside
  2024. // it, and the task queue calls the job without a catch, so an exception
  2025. // from any of those would terminate the process.
  2026. //
  2027. // No 500 is possible here: by the time a content provider runs, the status
  2028. // line and headers are already on the wire. Report it through the error
  2029. // logger and drop the connection, which is what the peer observes either
  2030. // way. Other connections are unaffected.
  2031. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  2032. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  2033. return serve();
  2034. #else
  2035. try {
  2036. return serve();
  2037. } catch (...) {
  2038. // The error logger is a user callback too, so it must not be able to
  2039. // throw the guard back open.
  2040. try {
  2041. output_error_log(Error::UserCallbackException, nullptr);
  2042. } catch (...) {}
  2043. return false;
  2044. }
  2045. #endif
  2046. }
  2047. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2048. // stop() takes the listening socket away; listen() then waits for handlers
  2049. bool is_stopping() const { return svr_sock_ == INVALID_SOCKET; }
  2050. // See set_keep_alive_parking(). Defined in the implementation part.
  2051. struct KeepAliveConnection;
  2052. struct ParkingState;
  2053. std::unique_ptr<ParkingState> parking_;
  2054. bool keep_alive_parking_ = false;
  2055. bool idle_interval_set_ = false;
  2056. std::vector<std::string> trusted_proxies_;
  2057. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2058. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2059. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2060. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2061. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2062. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2063. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2064. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2065. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2066. bool compress_ = true;
  2067. bool static_file_compression_ = false;
  2068. size_t static_file_compression_min_length_ =
  2069. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2070. size_t static_file_compression_max_length_ =
  2071. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2072. time_t websocket_ping_interval_sec_ =
  2073. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2074. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2075. private:
  2076. using Handlers =
  2077. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2078. using HandlersForContentReader =
  2079. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2080. HandlerWithContentReader>>;
  2081. // Both handler tables for one custom method live in a single entry, so that
  2082. // routing() needs only one map lookup per request to reach either of them.
  2083. struct CustomHandlerEntry {
  2084. Handlers handlers;
  2085. HandlersForContentReader handlers_for_content_reader;
  2086. };
  2087. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2088. static std::unique_ptr<detail::MatcherBase>
  2089. make_matcher(const std::string &pattern);
  2090. static const std::set<std::string> &builtin_methods();
  2091. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2092. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2093. template <typename H>
  2094. Server &add_handler(
  2095. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2096. const std::string &pattern, H handler) {
  2097. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2098. return *this;
  2099. }
  2100. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2101. Server &set_error_handler_core(Handler handler, std::false_type);
  2102. socket_t create_server_socket(const std::string &host, int port,
  2103. int socket_flags,
  2104. SocketOptions socket_options) const;
  2105. int bind_internal(const std::string &host, int port, int socket_flags);
  2106. bool listen_internal();
  2107. bool accept_loop(TaskQueue &task_queue);
  2108. bool parking_loop(TaskQueue &task_queue);
  2109. void prepare_accepted_socket(socket_t sock) const;
  2110. struct PlainConnection;
  2111. void resume_connection(std::shared_ptr<KeepAliveConnection> conn);
  2112. bool abandon_listen_socket();
  2113. bool routing(Request &req, Response &res, Stream &strm,
  2114. bool skip_pre_routing);
  2115. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  2116. bool handle_exception(Request &req, Response &res);
  2117. #endif
  2118. bool handle_file_request(Request &req, Response &res);
  2119. bool check_if_not_modified(const Request &req, Response &res,
  2120. const std::string &etag, time_t mtime) const;
  2121. bool check_if_range(Request &req, const std::string &etag,
  2122. time_t mtime) const;
  2123. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2124. Stream &strm);
  2125. bool dispatch_request_for_content_reader(
  2126. Request &req, Response &res, ContentReader content_reader,
  2127. const HandlersForContentReader &handlers) const;
  2128. bool parse_request_line(const char *s, Request &req) const;
  2129. detail::EncodingType static_file_encoding(const Request &req,
  2130. const Response &res,
  2131. const std::string &content_type,
  2132. size_t length) const;
  2133. bool apply_static_file_compression(const Request &req, Response &res) const;
  2134. void apply_ranges(const Request &req, Response &res,
  2135. std::string &content_type, std::string &boundary) const;
  2136. bool write_response(Stream &strm, bool close_connection, Request &req,
  2137. Response &res);
  2138. bool write_response_with_content(Stream &strm, bool close_connection,
  2139. const Request &req, Response &res);
  2140. bool write_response_core(Stream &strm, bool close_connection,
  2141. const Request &req, Response &res,
  2142. bool need_apply_ranges);
  2143. bool write_content_with_provider(Stream &strm, const Request &req,
  2144. Response &res, const std::string &boundary,
  2145. const std::string &content_type);
  2146. bool read_content(Stream &strm, Request &req, Response &res);
  2147. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2148. Response &res,
  2149. ContentReceiver receiver,
  2150. FormDataHeader multipart_header,
  2151. ContentReceiver multipart_receiver);
  2152. bool read_content_core(Stream &strm, Request &req, Response &res,
  2153. ContentReceiver receiver,
  2154. FormDataHeader multipart_header,
  2155. ContentReceiver multipart_receiver) const;
  2156. virtual bool process_and_close_socket(socket_t sock);
  2157. // The connection that parking_loop() keeps for a socket it has accepted.
  2158. virtual std::shared_ptr<KeepAliveConnection>
  2159. new_keep_alive_connection(socket_t sock);
  2160. void output_log(const Request &req, const Response &res) const;
  2161. void output_pre_compression_log(const Request &req,
  2162. const Response &res) const;
  2163. void output_error_log(const Error &err, const Request *req) const;
  2164. std::atomic<bool> is_running_{false};
  2165. std::atomic<bool> is_decommissioned{false};
  2166. // Set when CustomRoute() refuses a registration. Written before listen(),
  2167. // read by is_valid() on the same thread, so it needs no synchronization.
  2168. bool has_invalid_registration_ = false;
  2169. struct MountPointEntry {
  2170. std::string mount_point;
  2171. std::string base_dir;
  2172. std::string resolved_base_dir;
  2173. Headers headers;
  2174. };
  2175. std::vector<MountPointEntry> base_dirs_;
  2176. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2177. std::string default_file_mimetype_ = "application/octet-stream";
  2178. Handler file_request_handler_;
  2179. Handlers get_handlers_;
  2180. Handlers post_handlers_;
  2181. HandlersForContentReader post_handlers_for_content_reader_;
  2182. Handlers put_handlers_;
  2183. HandlersForContentReader put_handlers_for_content_reader_;
  2184. Handlers patch_handlers_;
  2185. HandlersForContentReader patch_handlers_for_content_reader_;
  2186. Handlers delete_handlers_;
  2187. HandlersForContentReader delete_handlers_for_content_reader_;
  2188. Handlers options_handlers_;
  2189. CustomHandlers custom_handlers_;
  2190. struct WebSocketHandlerEntry {
  2191. std::unique_ptr<detail::MatcherBase> matcher;
  2192. WebSocketHandler handler;
  2193. SubProtocolSelector sub_protocol_selector;
  2194. };
  2195. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2196. WebSocketHandlers websocket_handlers_;
  2197. HandlerWithResponse error_handler_;
  2198. ExceptionHandler exception_handler_;
  2199. HandlerWithResponse pre_routing_handler_;
  2200. Handler post_routing_handler_;
  2201. HandlerWithResponse pre_request_handler_;
  2202. Expect100ContinueHandler expect_100_continue_handler_;
  2203. StartHandler start_handler_;
  2204. mutable std::mutex logger_mutex_;
  2205. Logger logger_;
  2206. Logger pre_compression_logger_;
  2207. ErrorLogger error_logger_;
  2208. int address_family_ = AF_UNSPEC;
  2209. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2210. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2211. SocketOptions socket_options_ = default_socket_options;
  2212. Headers default_headers_;
  2213. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2214. detail::write_headers;
  2215. };
  2216. class Result {
  2217. public:
  2218. Result() = default;
  2219. Result(std::unique_ptr<Response> &&res, Error err,
  2220. Headers &&request_headers = Headers{})
  2221. : res_(std::move(res)), err_(err),
  2222. request_headers_(std::move(request_headers)) {}
  2223. // Response
  2224. operator bool() const { return res_ != nullptr; }
  2225. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2226. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2227. const Response &value() const { return *res_; }
  2228. Response &value() { return *res_; }
  2229. const Response &operator*() const { return *res_; }
  2230. Response &operator*() { return *res_; }
  2231. const Response *operator->() const { return res_.get(); }
  2232. Response *operator->() { return res_.get(); }
  2233. // Error
  2234. Error error() const { return err_; }
  2235. // Request Headers
  2236. bool has_request_header(const std::string &key) const;
  2237. std::string get_request_header_value(const std::string &key,
  2238. const char *def = "",
  2239. size_t id = 0) const;
  2240. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2241. size_t id = 0) const;
  2242. size_t get_request_header_value_count(const std::string &key) const;
  2243. private:
  2244. std::unique_ptr<Response> res_;
  2245. Error err_ = Error::Unknown;
  2246. Headers request_headers_;
  2247. #ifdef CPPHTTPLIB_SSL_ENABLED
  2248. public:
  2249. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2250. int ssl_error)
  2251. : res_(std::move(res)), err_(err),
  2252. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2253. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2254. int ssl_error, uint64_t ssl_backend_error)
  2255. : res_(std::move(res)), err_(err),
  2256. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2257. ssl_backend_error_(ssl_backend_error) {}
  2258. int ssl_error() const { return ssl_error_; }
  2259. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2260. private:
  2261. int ssl_error_ = 0;
  2262. uint64_t ssl_backend_error_ = 0;
  2263. #endif
  2264. };
  2265. struct ClientConnection {
  2266. socket_t sock = INVALID_SOCKET;
  2267. bool is_open() const { return sock != INVALID_SOCKET; }
  2268. ClientConnection() = default;
  2269. ~ClientConnection();
  2270. ClientConnection(const ClientConnection &) = delete;
  2271. ClientConnection &operator=(const ClientConnection &) = delete;
  2272. ClientConnection(ClientConnection &&other) noexcept
  2273. : sock(other.sock)
  2274. #ifdef CPPHTTPLIB_SSL_ENABLED
  2275. ,
  2276. session(other.session)
  2277. #endif
  2278. {
  2279. other.sock = INVALID_SOCKET;
  2280. #ifdef CPPHTTPLIB_SSL_ENABLED
  2281. other.session = nullptr;
  2282. #endif
  2283. }
  2284. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2285. if (this != &other) {
  2286. sock = other.sock;
  2287. other.sock = INVALID_SOCKET;
  2288. #ifdef CPPHTTPLIB_SSL_ENABLED
  2289. session = other.session;
  2290. other.session = nullptr;
  2291. #endif
  2292. }
  2293. return *this;
  2294. }
  2295. #ifdef CPPHTTPLIB_SSL_ENABLED
  2296. tls::session_t session = nullptr;
  2297. #endif
  2298. };
  2299. namespace detail {
  2300. struct ChunkedDecoder;
  2301. struct BodyReader {
  2302. Stream *stream = nullptr;
  2303. bool has_content_length = false;
  2304. size_t content_length = 0;
  2305. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2306. size_t bytes_read = 0;
  2307. bool chunked = false;
  2308. bool eof = false;
  2309. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2310. Error last_error = Error::Success;
  2311. ssize_t read(char *buf, size_t len);
  2312. bool has_error() const { return last_error != Error::Success; }
  2313. };
  2314. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2315. size_t len) {
  2316. (void)stream;
  2317. return br.read(buf, len);
  2318. }
  2319. class decompressor;
  2320. enum class NoProxyKind {
  2321. Wildcard, // "*"
  2322. HostnameSuffix, // "example.com" or ".example.com"
  2323. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2324. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2325. };
  2326. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2327. // Lets one CIDR matcher cover both families.
  2328. using IPBytes = std::array<uint8_t, 16>;
  2329. struct NoProxyEntry {
  2330. NoProxyKind kind = NoProxyKind::Wildcard;
  2331. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2332. IPBytes net{};
  2333. int prefix_bits = 0;
  2334. };
  2335. struct NormalizedTarget {
  2336. std::string hostname; // lowercase; brackets and trailing dot removed
  2337. bool is_ipv4 = false;
  2338. bool is_ipv6 = false;
  2339. IPBytes ip{};
  2340. };
  2341. } // namespace detail
  2342. class ClientImpl {
  2343. public:
  2344. explicit ClientImpl(const std::string &host);
  2345. explicit ClientImpl(const std::string &host, int port);
  2346. explicit ClientImpl(const std::string &host, int port,
  2347. const std::string &client_cert_path,
  2348. const std::string &client_key_path);
  2349. virtual ~ClientImpl();
  2350. virtual bool is_valid() const;
  2351. struct StreamHandle {
  2352. std::unique_ptr<Response> response;
  2353. Error error = Error::Success;
  2354. StreamHandle() = default;
  2355. StreamHandle(const StreamHandle &) = delete;
  2356. StreamHandle &operator=(const StreamHandle &) = delete;
  2357. StreamHandle(StreamHandle &&) = default;
  2358. StreamHandle &operator=(StreamHandle &&) = default;
  2359. ~StreamHandle() = default;
  2360. bool is_valid() const {
  2361. return response != nullptr && error == Error::Success;
  2362. }
  2363. ssize_t read(char *buf, size_t len);
  2364. void parse_trailers_if_needed();
  2365. Error get_read_error() const { return body_reader_.last_error; }
  2366. bool has_read_error() const { return body_reader_.has_error(); }
  2367. bool trailers_parsed_ = false;
  2368. private:
  2369. friend class ClientImpl;
  2370. friend class sse::SSEClient;
  2371. ssize_t read_with_decompression(char *buf, size_t len);
  2372. std::unique_ptr<ClientConnection> connection_;
  2373. std::unique_ptr<Stream> socket_stream_;
  2374. Stream *stream_ = nullptr;
  2375. detail::BodyReader body_reader_;
  2376. std::unique_ptr<detail::decompressor> decompressor_;
  2377. std::string decompress_buffer_;
  2378. size_t decompress_offset_ = 0;
  2379. size_t decompressed_bytes_read_ = 0;
  2380. };
  2381. // clang-format off
  2382. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2383. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2384. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2385. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2386. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2387. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2388. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2389. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2390. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2391. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2392. Result Head(const std::string &path);
  2393. Result Head(const std::string &path, const Headers &headers);
  2394. Result Post(const std::string &path);
  2395. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2396. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2397. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2398. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2399. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2400. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2401. Result Post(const std::string &path, const Params &params);
  2402. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2403. Result Post(const std::string &path, const Headers &headers);
  2404. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2405. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2406. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2407. 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);
  2408. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2409. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2410. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2411. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2412. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2413. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2414. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2415. Result Put(const std::string &path);
  2416. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2417. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2418. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2419. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2420. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2421. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2422. Result Put(const std::string &path, const Params &params);
  2423. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2424. Result Put(const std::string &path, const Headers &headers);
  2425. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2426. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2427. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2428. 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);
  2429. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2430. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2431. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2432. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2433. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2434. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2435. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2436. Result Patch(const std::string &path);
  2437. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2438. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2439. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2440. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2441. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2442. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2443. Result Patch(const std::string &path, const Params &params);
  2444. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2445. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2446. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2447. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2448. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2449. 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);
  2450. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2451. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2452. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2453. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2454. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2455. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2456. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2457. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2458. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2459. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2460. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2461. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2462. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2463. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2464. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2465. Result Options(const std::string &path);
  2466. Result Options(const std::string &path, const Headers &headers);
  2467. // clang-format on
  2468. // Streaming API: Open a stream for reading response body incrementally
  2469. // Socket ownership is transferred to StreamHandle for true streaming
  2470. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2471. StreamHandle open_stream(const std::string &method, const std::string &path,
  2472. const Params &params = {},
  2473. const Headers &headers = {},
  2474. const std::string &body = {},
  2475. const std::string &content_type = {});
  2476. bool send(Request &req, Response &res, Error &error);
  2477. Result send(const Request &req);
  2478. void stop();
  2479. std::string host() const;
  2480. int port() const;
  2481. size_t is_socket_open() const;
  2482. socket_t socket() const;
  2483. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2484. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2485. void
  2486. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2487. void
  2488. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2489. void set_default_headers(Headers headers);
  2490. void
  2491. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2492. void set_address_family(int family);
  2493. void set_tcp_nodelay(bool on);
  2494. void set_ipv6_v6only(bool on);
  2495. void set_socket_options(SocketOptions socket_options);
  2496. void set_connection_timeout(time_t sec, time_t usec = 0);
  2497. template <class Rep, class Period>
  2498. void
  2499. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2500. void set_read_timeout(time_t sec, time_t usec = 0);
  2501. template <class Rep, class Period>
  2502. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2503. void set_write_timeout(time_t sec, time_t usec = 0);
  2504. template <class Rep, class Period>
  2505. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2506. void set_max_timeout(time_t msec);
  2507. template <class Rep, class Period>
  2508. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2509. void set_basic_auth(const std::string &username, const std::string &password);
  2510. void set_bearer_token_auth(const std::string &token);
  2511. void set_keep_alive(bool on);
  2512. void set_follow_location(bool on);
  2513. void set_path_encode(bool on);
  2514. void set_compress(bool on);
  2515. void set_decompress(bool on);
  2516. void set_payload_max_length(size_t length);
  2517. void set_interface(const std::string &intf);
  2518. void set_proxy(const std::string &host, int port);
  2519. void set_proxy_basic_auth(const std::string &username,
  2520. const std::string &password);
  2521. void set_proxy_bearer_token_auth(const std::string &token);
  2522. void set_no_proxy(const std::vector<std::string> &patterns);
  2523. void set_logger(Logger logger);
  2524. void set_error_logger(ErrorLogger error_logger);
  2525. protected:
  2526. struct Socket {
  2527. socket_t sock = INVALID_SOCKET;
  2528. // For Mbed TLS compatibility: start_time for request timeout tracking
  2529. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2530. bool is_open() const { return sock != INVALID_SOCKET; }
  2531. #ifdef CPPHTTPLIB_SSL_ENABLED
  2532. tls::session_t ssl = nullptr;
  2533. #endif
  2534. };
  2535. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2536. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2537. virtual bool setup_proxy_connection(
  2538. Socket &socket,
  2539. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2540. Response &res, bool &success, Error &error);
  2541. bool is_proxy_enabled_for_host(const std::string &host) const;
  2542. // All of:
  2543. // shutdown_ssl
  2544. // shutdown_socket
  2545. // close_socket
  2546. // disconnect
  2547. // should ONLY be called on socket_ with socket_mutex_ locked, or on a
  2548. // connection being opened, and only when no other thread is using it.
  2549. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2550. void shutdown_socket(Socket &socket) const;
  2551. void close_socket(Socket &socket);
  2552. void disconnect(bool gracefully);
  2553. // Under socket_mutex_: whether the connection kept alive can take another
  2554. // request. One with anything to read, or one set up under TLS settings
  2555. // changed since, is closed instead.
  2556. bool socket_reusable();
  2557. // Makes socket_ ready for a request, with socket_mutex_ held by guard. A new
  2558. // connection is opened without the lock, so that stop() can end it.
  2559. bool
  2560. prepare_socket(std::unique_lock<std::mutex> &guard,
  2561. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2562. Response &res, bool &success, Error &error);
  2563. // TLS settings apply as a connection is set up, so a change makes the
  2564. // connection kept alive unfit for the next request.
  2565. void tls_settings_changed() { tls_settings_version_++; }
  2566. std::string make_request_target(const Request &req) const;
  2567. bool process_request(Stream &strm, Request &req, Response &res,
  2568. bool close_connection, Error &error);
  2569. bool write_content_with_provider(Stream &strm, const Request &req,
  2570. Error &error) const;
  2571. void output_log(const Request &req, const Response &res) const;
  2572. void output_error_log(const Error &err, const Request *req) const;
  2573. // Socket endpoint information
  2574. const std::string host_;
  2575. const int port_;
  2576. // Current open socket
  2577. Socket socket_;
  2578. mutable std::mutex socket_mutex_;
  2579. std::recursive_mutex request_mutex_;
  2580. // How many send() calls are running on this client, guarded by
  2581. // request_mutex_
  2582. size_t send_depth_ = 0;
  2583. // Also guarded by request_mutex_
  2584. size_t socket_tls_settings_version_ = 0;
  2585. // These are all protected under socket_mutex
  2586. size_t socket_requests_in_flight_ = 0;
  2587. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2588. bool socket_should_be_closed_when_request_is_done_ = false;
  2589. // Set by stop(), cleared as a send() or an open_stream() starts. Its waits
  2590. // poll it: shutdown() does not reach a connection being opened, nor wake a
  2591. // read on Windows.
  2592. std::atomic<bool> stop_requested_{false};
  2593. std::function<bool()> stop_interrupt() const {
  2594. return [this] { return stop_requested_.load(); };
  2595. }
  2596. std::atomic<size_t> tls_settings_version_{0};
  2597. // Hostname to connection target map. The value is an IP literal or another
  2598. // hostname; only the connection target changes, never the identity.
  2599. std::map<std::string, std::string> addr_map_;
  2600. // Hostname to CONNECT target map, used only through a proxy.
  2601. std::map<std::string, std::string> tunnel_addr_map_;
  2602. // Default headers
  2603. Headers default_headers_;
  2604. // Header writer
  2605. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2606. detail::write_headers;
  2607. // Settings
  2608. std::string client_cert_path_;
  2609. std::string client_key_path_;
  2610. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2611. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2612. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2613. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2614. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2615. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2616. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2617. std::string basic_auth_username_;
  2618. std::string basic_auth_password_;
  2619. std::string bearer_token_auth_token_;
  2620. bool keep_alive_ = false;
  2621. bool follow_location_ = false;
  2622. bool path_encode_ = true;
  2623. int address_family_ = AF_UNSPEC;
  2624. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2625. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2626. SocketOptions socket_options_ = nullptr;
  2627. bool compress_ = false;
  2628. bool decompress_ = true;
  2629. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2630. bool has_payload_max_length_ = false;
  2631. std::string interface_;
  2632. std::string proxy_host_;
  2633. int proxy_port_ = -1;
  2634. std::string proxy_basic_auth_username_;
  2635. std::string proxy_basic_auth_password_;
  2636. std::string proxy_bearer_token_auth_token_;
  2637. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2638. mutable detail::NormalizedTarget host_normalized_;
  2639. mutable bool host_normalized_valid_ = false;
  2640. mutable std::mutex logger_mutex_;
  2641. Logger logger_;
  2642. ErrorLogger error_logger_;
  2643. private:
  2644. bool send_(Request &req, Response &res, Error &error);
  2645. Result send_(Request &&req);
  2646. socket_t create_client_socket(Error &error) const;
  2647. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2648. bool skip_100_continue = true) const;
  2649. bool write_request(Stream &strm, Request &req, bool close_connection,
  2650. Error &error, bool skip_body, bool &rejected_locally);
  2651. bool write_request_body(Stream &strm, Request &req, Error &error);
  2652. void prepare_default_headers(Request &r, bool for_stream,
  2653. const std::string &ct);
  2654. bool redirect(Request &req, Response &res, Error &error);
  2655. bool create_redirect_client(const std::string &scheme,
  2656. const std::string &host, int port, Request &req,
  2657. Response &res, const std::string &path,
  2658. const std::string &location, Error &error);
  2659. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2660. bool handle_request(Stream &strm, Request &req, Response &res,
  2661. bool close_connection, Error &error);
  2662. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2663. Request &req, const char *body, size_t content_length,
  2664. ContentProvider content_provider,
  2665. ContentProviderWithoutLength content_provider_without_length,
  2666. const std::string &content_type, ContentReceiver content_receiver,
  2667. Error &error);
  2668. Result send_with_content_provider_and_receiver(
  2669. const std::string &method, const std::string &path,
  2670. const Headers &headers, const char *body, size_t content_length,
  2671. ContentProvider content_provider,
  2672. ContentProviderWithoutLength content_provider_without_length,
  2673. const std::string &content_type, ContentReceiver content_receiver,
  2674. UploadProgress progress);
  2675. ContentProviderWithoutLength get_multipart_content_provider(
  2676. const std::string &boundary, const UploadFormDataItems &items,
  2677. const FormDataProviderItems &provider_items) const;
  2678. virtual bool
  2679. process_socket(const Socket &socket,
  2680. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2681. std::function<bool(Stream &strm)> callback);
  2682. virtual bool is_ssl() const;
  2683. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2684. StreamHandle open_stream_(Request &req);
  2685. void add_credential_headers(Request &req);
  2686. std::string proxy_target_prefix() const;
  2687. #ifdef CPPHTTPLIB_SSL_ENABLED
  2688. public:
  2689. void set_digest_auth(const std::string &username,
  2690. const std::string &password);
  2691. void set_proxy_digest_auth(const std::string &username,
  2692. const std::string &password);
  2693. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2694. const std::string &ca_cert_dir_path = std::string());
  2695. void enable_server_certificate_verification(bool enabled);
  2696. void enable_server_hostname_verification(bool enabled);
  2697. void enable_system_ca(bool enabled);
  2698. protected:
  2699. std::string digest_auth_username_;
  2700. std::string digest_auth_password_;
  2701. std::string proxy_digest_auth_username_;
  2702. std::string proxy_digest_auth_password_;
  2703. std::string ca_cert_file_path_;
  2704. std::string ca_cert_dir_path_;
  2705. bool server_certificate_verification_ = true;
  2706. bool server_hostname_verification_ = true;
  2707. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2708. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2709. int last_ssl_error_ = 0;
  2710. uint64_t last_backend_error_ = 0;
  2711. #endif
  2712. };
  2713. namespace detail {
  2714. // Stands in for a client that Client could not make from its arguments, so a
  2715. // request fails rather than going through a null pointer.
  2716. class InvalidClientImpl final : public ClientImpl {
  2717. public:
  2718. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2719. bool is_valid() const override { return false; }
  2720. private:
  2721. bool create_and_connect_socket(Socket &, Error &error) override {
  2722. error = Error::Connection;
  2723. return false;
  2724. }
  2725. };
  2726. } // namespace detail
  2727. class Client {
  2728. public:
  2729. // Universal interface
  2730. explicit Client(const std::string &scheme_host_port);
  2731. explicit Client(const std::string &scheme_host_port,
  2732. const std::string &client_cert_path,
  2733. const std::string &client_key_path);
  2734. // HTTP only interface
  2735. explicit Client(const std::string &host, int port);
  2736. explicit Client(const std::string &host, int port,
  2737. const std::string &client_cert_path,
  2738. const std::string &client_key_path);
  2739. Client(Client &&) = default;
  2740. Client &operator=(Client &&) = default;
  2741. ~Client();
  2742. bool is_valid() const;
  2743. // clang-format off
  2744. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2745. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2746. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2747. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2748. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2749. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2750. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2751. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2752. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2753. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2754. Result Head(const std::string &path);
  2755. Result Head(const std::string &path, const Headers &headers);
  2756. Result Post(const std::string &path);
  2757. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2758. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2759. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2760. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2761. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2762. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2763. Result Post(const std::string &path, const Params &params);
  2764. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2765. Result Post(const std::string &path, const Headers &headers);
  2766. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2767. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2768. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2769. 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);
  2770. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2771. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2772. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2773. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2774. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2775. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2776. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2777. Result Put(const std::string &path);
  2778. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2779. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2780. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2781. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2782. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2783. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2784. Result Put(const std::string &path, const Params &params);
  2785. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2786. Result Put(const std::string &path, const Headers &headers);
  2787. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2788. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2789. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2790. 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);
  2791. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2792. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2793. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2794. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2795. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2796. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2797. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2798. Result Patch(const std::string &path);
  2799. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2800. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2801. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2802. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2803. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2804. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2805. Result Patch(const std::string &path, const Params &params);
  2806. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2807. Result Patch(const std::string &path, const Headers &headers);
  2808. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2809. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2810. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2811. 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);
  2812. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2813. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2814. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2815. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2816. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2817. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2818. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2819. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2820. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2821. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2822. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2823. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2824. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2825. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2826. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2827. Result Options(const std::string &path);
  2828. Result Options(const std::string &path, const Headers &headers);
  2829. // clang-format on
  2830. // Streaming API: Open a stream for reading response body incrementally
  2831. // Socket ownership is transferred to StreamHandle for true streaming
  2832. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2833. ClientImpl::StreamHandle open_stream(const std::string &method,
  2834. const std::string &path,
  2835. const Params &params = {},
  2836. const Headers &headers = {},
  2837. const std::string &body = {},
  2838. const std::string &content_type = {});
  2839. bool send(Request &req, Response &res, Error &error);
  2840. Result send(const Request &req);
  2841. void stop();
  2842. std::string host() const;
  2843. int port() const;
  2844. size_t is_socket_open() const;
  2845. socket_t socket() const;
  2846. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2847. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2848. void
  2849. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2850. void
  2851. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2852. void set_default_headers(Headers headers);
  2853. void
  2854. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2855. void set_address_family(int family);
  2856. void set_tcp_nodelay(bool on);
  2857. void set_socket_options(SocketOptions socket_options);
  2858. void set_connection_timeout(time_t sec, time_t usec = 0);
  2859. template <class Rep, class Period>
  2860. void
  2861. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2862. void set_read_timeout(time_t sec, time_t usec = 0);
  2863. template <class Rep, class Period>
  2864. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2865. void set_write_timeout(time_t sec, time_t usec = 0);
  2866. template <class Rep, class Period>
  2867. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2868. void set_max_timeout(time_t msec);
  2869. template <class Rep, class Period>
  2870. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2871. void set_basic_auth(const std::string &username, const std::string &password);
  2872. void set_bearer_token_auth(const std::string &token);
  2873. void set_keep_alive(bool on);
  2874. void set_follow_location(bool on);
  2875. void set_path_encode(bool on);
  2876. void set_compress(bool on);
  2877. void set_decompress(bool on);
  2878. void set_payload_max_length(size_t length);
  2879. void set_interface(const std::string &intf);
  2880. void set_proxy(const std::string &host, int port);
  2881. void set_proxy_basic_auth(const std::string &username,
  2882. const std::string &password);
  2883. void set_proxy_bearer_token_auth(const std::string &token);
  2884. void set_no_proxy(const std::vector<std::string> &patterns);
  2885. void set_logger(Logger logger);
  2886. void set_error_logger(ErrorLogger error_logger);
  2887. private:
  2888. std::unique_ptr<ClientImpl> cli_;
  2889. #ifdef CPPHTTPLIB_SSL_ENABLED
  2890. public:
  2891. void set_digest_auth(const std::string &username,
  2892. const std::string &password);
  2893. void set_proxy_digest_auth(const std::string &username,
  2894. const std::string &password);
  2895. void enable_server_certificate_verification(bool enabled);
  2896. void enable_server_hostname_verification(bool enabled);
  2897. void enable_system_ca(bool enabled);
  2898. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2899. const std::string &ca_cert_dir_path = std::string());
  2900. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2901. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2902. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2903. void set_session_verifier(
  2904. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2905. tls::ctx_t tls_context() const;
  2906. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2907. void enable_windows_certificate_verification(bool enabled);
  2908. #endif
  2909. private:
  2910. bool is_ssl_ = false;
  2911. #endif
  2912. };
  2913. #ifdef CPPHTTPLIB_SSL_ENABLED
  2914. class SSLServer : public Server {
  2915. public:
  2916. SSLServer(const char *cert_path, const char *private_key_path,
  2917. const char *client_ca_cert_file_path = nullptr,
  2918. const char *client_ca_cert_dir_path = nullptr,
  2919. const char *private_key_password = nullptr);
  2920. struct PemMemory {
  2921. const char *cert_pem;
  2922. size_t cert_pem_len;
  2923. const char *key_pem;
  2924. size_t key_pem_len;
  2925. const char *client_ca_pem;
  2926. size_t client_ca_pem_len;
  2927. const char *private_key_password;
  2928. };
  2929. explicit SSLServer(const PemMemory &pem);
  2930. // The callback receives the ctx_t handle which can be cast to the
  2931. // appropriate backend type (SSL_CTX* for OpenSSL,
  2932. // tls::impl::MbedTlsContext* for Mbed TLS)
  2933. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2934. ~SSLServer() override;
  2935. bool is_valid() const override;
  2936. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2937. const char *client_ca_pem = nullptr,
  2938. const char *password = nullptr);
  2939. tls::ctx_t tls_context() const { return ctx_; }
  2940. int ssl_last_error() const { return last_ssl_error_; }
  2941. private:
  2942. bool process_and_close_socket(socket_t sock) override;
  2943. std::shared_ptr<KeepAliveConnection>
  2944. new_keep_alive_connection(socket_t sock) override;
  2945. struct TlsConnection;
  2946. // Creates a session and runs the handshake. Null on failure, which sets
  2947. // last_ssl_error_.
  2948. tls::session_t start_session(socket_t sock);
  2949. tls::ctx_t ctx_ = nullptr;
  2950. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2951. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2952. // bounds, and new ones wait while it is pending so that they cannot keep it
  2953. // waiting.
  2954. std::mutex ctx_mutex_;
  2955. std::condition_variable ctx_cv_;
  2956. size_t handshakes_in_progress_ = 0;
  2957. size_t updates_pending_ = 0;
  2958. int last_ssl_error_ = 0;
  2959. };
  2960. class SSLClient final : public ClientImpl {
  2961. public:
  2962. explicit SSLClient(const std::string &host);
  2963. explicit SSLClient(const std::string &host, int port);
  2964. explicit SSLClient(const std::string &host, int port,
  2965. const std::string &client_cert_path,
  2966. const std::string &client_key_path,
  2967. const std::string &private_key_password = std::string());
  2968. struct PemMemory {
  2969. const char *cert_pem;
  2970. size_t cert_pem_len;
  2971. const char *key_pem;
  2972. size_t key_pem_len;
  2973. const char *private_key_password;
  2974. };
  2975. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2976. ~SSLClient() override;
  2977. bool is_valid() const override;
  2978. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2979. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2980. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2981. // Post-handshake session verifier (backend-independent)
  2982. void set_session_verifier(
  2983. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2984. tls::ctx_t tls_context() const { return ctx_; }
  2985. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2986. void enable_windows_certificate_verification(bool enabled);
  2987. #endif
  2988. private:
  2989. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2990. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2991. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2992. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2993. bool
  2994. process_socket(const Socket &socket,
  2995. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2996. std::function<bool(Stream &strm)> callback) override;
  2997. bool is_ssl() const override;
  2998. bool setup_proxy_connection(
  2999. Socket &socket,
  3000. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3001. Response &res, bool &success, Error &error) override;
  3002. bool connect_with_proxy(
  3003. Socket &sock,
  3004. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3005. Response &res, bool &success, Error &error);
  3006. bool initialize_ssl(Socket &socket, Error &error);
  3007. void init_ctx();
  3008. void reset_ctx_on_error();
  3009. bool load_certs();
  3010. tls::ctx_t ctx_ = nullptr;
  3011. std::mutex ctx_mutex_;
  3012. std::once_flag initialize_cert_;
  3013. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  3014. // since the store handle itself is owned by ctx_ and leaves no other trace.
  3015. bool ca_cert_store_set_ = false;
  3016. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  3017. // no certificate, so that a CA that failed to come through fails
  3018. // verification instead of letting the system CAs in.
  3019. bool custom_ca_loaded_ = false;
  3020. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  3021. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  3022. // set_server_certificate_verifier() installed there.
  3023. tls::VerifyCallback server_certificate_verifier_;
  3024. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  3025. bool enable_windows_cert_verification_ = true;
  3026. #endif
  3027. friend class ClientImpl;
  3028. };
  3029. #endif // CPPHTTPLIB_SSL_ENABLED
  3030. namespace detail {
  3031. template <typename T, typename U>
  3032. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  3033. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  3034. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  3035. duration - std::chrono::seconds(sec))
  3036. .count();
  3037. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  3038. }
  3039. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  3040. return N - 1;
  3041. }
  3042. inline bool is_numeric(const std::string &str) {
  3043. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  3044. }
  3045. // std::ranges::next(first, n, last) for C++11
  3046. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  3047. for (; n > 0 && first != last; --n) {
  3048. ++first;
  3049. }
  3050. return first;
  3051. }
  3052. inline size_t get_header_value_u64(const Headers &headers,
  3053. const std::string &key, size_t def,
  3054. size_t id, bool &is_invalid_value) {
  3055. is_invalid_value = false;
  3056. auto rng = headers.equal_range(key);
  3057. auto it = bounded_next(rng.first, id, rng.second);
  3058. if (it != rng.second) {
  3059. if (is_numeric(it->second)) {
  3060. // Parse at size_t width so an out-of-range Content-Length is reported
  3061. // rather than silently saturated/truncated (a value above 2^32 would
  3062. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  3063. // and return SIZE_MAX so the existing oversized-value guards reject it.
  3064. size_t val = 0;
  3065. const auto &s = it->second;
  3066. auto r = from_chars(s.data(), s.data() + s.size(), val);
  3067. if (r.ec == std::errc::result_out_of_range) {
  3068. is_invalid_value = true;
  3069. return (std::numeric_limits<size_t>::max)();
  3070. }
  3071. return val;
  3072. } else {
  3073. is_invalid_value = true;
  3074. }
  3075. }
  3076. return def;
  3077. }
  3078. inline size_t get_header_value_u64(const Headers &headers,
  3079. const std::string &key, size_t def,
  3080. size_t id) {
  3081. auto dummy = false;
  3082. return get_header_value_u64(headers, key, def, id, dummy);
  3083. }
  3084. } // namespace detail
  3085. template <class Rep, class Period>
  3086. inline Server &
  3087. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3088. detail::duration_to_sec_and_usec(
  3089. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3090. return *this;
  3091. }
  3092. template <class Rep, class Period>
  3093. inline Server &
  3094. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3095. detail::duration_to_sec_and_usec(
  3096. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3097. return *this;
  3098. }
  3099. template <class Rep, class Period>
  3100. inline Server &
  3101. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  3102. detail::duration_to_sec_and_usec(
  3103. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  3104. return *this;
  3105. }
  3106. template <class Rep, class Period>
  3107. inline void ClientImpl::set_connection_timeout(
  3108. const std::chrono::duration<Rep, Period> &duration) {
  3109. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3110. set_connection_timeout(sec, usec);
  3111. });
  3112. }
  3113. template <class Rep, class Period>
  3114. inline void ClientImpl::set_read_timeout(
  3115. const std::chrono::duration<Rep, Period> &duration) {
  3116. detail::duration_to_sec_and_usec(
  3117. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3118. }
  3119. template <class Rep, class Period>
  3120. inline void ClientImpl::set_write_timeout(
  3121. const std::chrono::duration<Rep, Period> &duration) {
  3122. detail::duration_to_sec_and_usec(
  3123. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3124. }
  3125. template <class Rep, class Period>
  3126. inline void ClientImpl::set_max_timeout(
  3127. const std::chrono::duration<Rep, Period> &duration) {
  3128. auto msec =
  3129. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3130. set_max_timeout(static_cast<time_t>(msec));
  3131. }
  3132. template <class Rep, class Period>
  3133. inline void Client::set_connection_timeout(
  3134. const std::chrono::duration<Rep, Period> &duration) {
  3135. cli_->set_connection_timeout(duration);
  3136. }
  3137. template <class Rep, class Period>
  3138. inline void
  3139. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3140. cli_->set_read_timeout(duration);
  3141. }
  3142. template <class Rep, class Period>
  3143. inline void
  3144. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3145. cli_->set_write_timeout(duration);
  3146. }
  3147. inline void Client::set_max_timeout(time_t msec) {
  3148. cli_->set_max_timeout(msec);
  3149. }
  3150. template <class Rep, class Period>
  3151. inline void
  3152. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3153. cli_->set_max_timeout(duration);
  3154. }
  3155. /*
  3156. * Forward declarations and types that will be part of the .h file if split into
  3157. * .h + .cc.
  3158. */
  3159. std::string hosted_at(const std::string &hostname);
  3160. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3161. // JavaScript-style URL encoding/decoding functions
  3162. std::string encode_uri_component(const std::string &value);
  3163. std::string encode_uri(const std::string &value);
  3164. std::string decode_uri_component(const std::string &value);
  3165. std::string decode_uri(const std::string &value);
  3166. // RFC 3986 compliant URL component encoding/decoding functions
  3167. std::string encode_path_component(const std::string &component);
  3168. std::string decode_path_component(const std::string &component);
  3169. std::string encode_query_component(const std::string &component,
  3170. bool space_as_plus = true);
  3171. std::string decode_query_component(const std::string &component,
  3172. bool plus_as_space = true);
  3173. std::string sanitize_filename(const std::string &filename);
  3174. std::string append_query_params(const std::string &path, const Params &params);
  3175. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3176. std::pair<std::string, std::string>
  3177. make_basic_authentication_header(const std::string &username,
  3178. const std::string &password,
  3179. bool is_proxy = false);
  3180. namespace detail {
  3181. #if defined(_WIN32)
  3182. inline std::wstring u8string_to_wstring(const char *s) {
  3183. if (!s) { return std::wstring(); }
  3184. auto len = static_cast<int>(strlen(s));
  3185. if (!len) { return std::wstring(); }
  3186. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3187. if (!wlen) { return std::wstring(); }
  3188. std::wstring ws;
  3189. ws.resize(wlen);
  3190. wlen = ::MultiByteToWideChar(
  3191. CP_UTF8, 0, s, len,
  3192. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3193. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3194. return ws;
  3195. }
  3196. #endif
  3197. struct FileStat {
  3198. FileStat(const std::string &path);
  3199. bool is_file() const;
  3200. bool is_dir() const;
  3201. time_t mtime() const;
  3202. size_t size() const;
  3203. private:
  3204. #if defined(_WIN32)
  3205. struct _stat st_;
  3206. #else
  3207. struct stat st_;
  3208. #endif
  3209. int ret_ = -1;
  3210. };
  3211. std::string make_host_and_port_string(const std::string &host, int port,
  3212. bool is_ssl);
  3213. template <typename T>
  3214. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3215. Error &error);
  3216. bool write_data(Stream &strm, const char *d, size_t l);
  3217. std::string trim_copy(const std::string &s);
  3218. void divide(
  3219. const char *data, std::size_t size, char d,
  3220. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3221. fn);
  3222. void divide(
  3223. const std::string &str, char d,
  3224. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3225. fn);
  3226. void split(const char *b, const char *e, char d,
  3227. std::function<void(const char *, const char *)> fn);
  3228. void split(const char *b, const char *e, char d, size_t m,
  3229. std::function<void(const char *, const char *)> fn);
  3230. bool split_find(const char *b, const char *e, char d,
  3231. std::function<bool(const char *, const char *)> fn);
  3232. bool has_header_token(const Headers &headers, const std::string &key,
  3233. const std::string &token);
  3234. std::string websocket_accept_key(const std::string &client_key);
  3235. bool is_websocket_upgrade(const Request &req);
  3236. bool process_client_socket(
  3237. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3238. time_t write_timeout_sec, time_t write_timeout_usec,
  3239. time_t max_timeout_msec,
  3240. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3241. std::function<bool(Stream &)> callback);
  3242. socket_t create_client_socket(
  3243. const std::string &host, const std::string &ip, int port,
  3244. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  3245. SocketOptions socket_options, time_t connection_timeout_sec,
  3246. time_t connection_timeout_usec, time_t read_timeout_sec,
  3247. time_t read_timeout_usec, time_t write_timeout_sec,
  3248. time_t write_timeout_usec, const std::string &intf, Error &error,
  3249. const std::function<bool()> &interrupted = nullptr);
  3250. const char *get_header_value(const Headers &headers, const std::string &key,
  3251. const char *def, size_t id);
  3252. std::string get_combined_header_value(const Headers &headers,
  3253. const std::string &key);
  3254. std::string params_to_query_str(const Params &params);
  3255. void parse_query_text(const char *data, std::size_t size, Params &params);
  3256. void parse_query_text(const std::string &s, Params &params);
  3257. bool parse_multipart_boundary(const std::string &content_type,
  3258. std::string &boundary);
  3259. bool parse_range_header(const std::string &s, Ranges &ranges);
  3260. bool parse_accept_header(const std::string &s,
  3261. std::vector<std::string> &content_types);
  3262. void parse_disposition_params(const std::string &s, Params &params);
  3263. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3264. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3265. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3266. EncodingType encoding_type(const Request &req, const Response &res,
  3267. const std::string &content_type);
  3268. EncodingType encoding_type(const Request &req, const Response &res);
  3269. // Creates a connected pair of stream sockets that child processes do not
  3270. // inherit. Windows has no socketpair(), so it is emulated there.
  3271. bool create_socket_pair(socket_t sv[2]);
  3272. // Ends a Poller's wait() from another thread. The poller watches fd() for
  3273. // readability, level-triggered, and calls drain() when it is reported.
  3274. class PollerWaker {
  3275. public:
  3276. ~PollerWaker();
  3277. // An eventfd on Linux, a socket pair elsewhere.
  3278. bool open();
  3279. socket_t fd() const { return fd_; }
  3280. // An address inside the poller, which no caller's token can be.
  3281. uintptr_t token() const { return reinterpret_cast<uintptr_t>(this); }
  3282. // From any thread. While one is pending, later calls make no syscall.
  3283. void wake() noexcept;
  3284. void drain() noexcept;
  3285. private:
  3286. socket_t fd_ = INVALID_SOCKET;
  3287. socket_t pair_fd_ = INVALID_SOCKET; // the end wake() writes; none on Linux
  3288. std::atomic<bool> pending_{false};
  3289. };
  3290. // One-shot readiness notification for a reactor:
  3291. // - A delivered event disarms the descriptor; arm() it again to wait again.
  3292. // - A hang-up or an error counts as readable.
  3293. // - Only an unarmed descriptor may be armed, and an armed one must be
  3294. // disarmed before it is closed.
  3295. // - wake() may be called from any thread; the rest belongs to one thread.
  3296. class Poller {
  3297. public:
  3298. using Token = uintptr_t;
  3299. virtual ~Poller() = default;
  3300. virtual bool arm(socket_t fd, Token token) = 0;
  3301. virtual void disarm(socket_t fd) = 0;
  3302. // Fills `ready` in no particular order and returns whether wake() was
  3303. // called. A negative timeout waits until either happens.
  3304. virtual bool wait(int timeout_ms, std::vector<Token> &ready) = 0;
  3305. virtual void wake() noexcept = 0;
  3306. };
  3307. // poll() on POSIX, WSAPoll() on Windows. Works everywhere.
  3308. class PollPoller final : public Poller {
  3309. public:
  3310. // nullptr when the descriptors cannot be created.
  3311. static std::unique_ptr<Poller> create();
  3312. bool arm(socket_t fd, Token token) override;
  3313. void disarm(socket_t fd) override;
  3314. bool wait(int timeout_ms, std::vector<Token> &ready) override;
  3315. void wake() noexcept override { waker_.wake(); }
  3316. private:
  3317. PollPoller() = default;
  3318. void remove_at(size_t index);
  3319. PollerWaker waker_;
  3320. // fds_[0] is the waker's, which is always armed; tokens_[i] belongs to
  3321. // fds_[i].
  3322. std::vector<struct pollfd> fds_;
  3323. std::vector<Token> tokens_;
  3324. std::unordered_map<socket_t, size_t> index_;
  3325. };
  3326. #ifdef __linux__
  3327. // epoll with EPOLLONESHOT. Waits in O(ready) instead of O(armed).
  3328. class EpollPoller final : public Poller {
  3329. public:
  3330. // nullptr when the descriptors cannot be created.
  3331. static std::unique_ptr<Poller> create();
  3332. ~EpollPoller() override;
  3333. bool arm(socket_t fd, Token token) override;
  3334. void disarm(socket_t fd) override;
  3335. bool wait(int timeout_ms, std::vector<Token> &ready) override;
  3336. void wake() noexcept override { waker_.wake(); }
  3337. private:
  3338. EpollPoller() = default;
  3339. int epfd_ = -1;
  3340. PollerWaker waker_; // always armed
  3341. std::vector<struct epoll_event> events_;
  3342. };
  3343. #endif
  3344. #ifdef CPPHTTPLIB_KQUEUE_POLLER
  3345. // kqueue with EV_ONESHOT. Waits in O(ready) instead of O(armed).
  3346. class KqueuePoller final : public Poller {
  3347. public:
  3348. // nullptr when the descriptors cannot be created.
  3349. static std::unique_ptr<Poller> create();
  3350. ~KqueuePoller() override;
  3351. bool arm(socket_t fd, Token token) override;
  3352. void disarm(socket_t fd) override;
  3353. bool wait(int timeout_ms, std::vector<Token> &ready) override;
  3354. void wake() noexcept override { waker_.wake(); }
  3355. private:
  3356. KqueuePoller() = default;
  3357. int kq_ = -1;
  3358. PollerWaker waker_; // always armed
  3359. std::vector<struct kevent> events_;
  3360. };
  3361. #endif
  3362. // The best poller for this platform, or nullptr when it cannot be created.
  3363. std::unique_ptr<Poller> make_poller();
  3364. class BufferStream final : public Stream {
  3365. public:
  3366. BufferStream() = default;
  3367. ~BufferStream() override = default;
  3368. bool is_readable() const override;
  3369. bool wait_readable() const override;
  3370. bool wait_writable() const override;
  3371. ssize_t read(char *ptr, size_t size) override;
  3372. ssize_t write(const char *ptr, size_t size) override;
  3373. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3374. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3375. socket_t socket() const override;
  3376. time_t duration() const override;
  3377. const std::string &get_buffer() const;
  3378. private:
  3379. std::string buffer;
  3380. size_t position = 0;
  3381. };
  3382. class compressor {
  3383. public:
  3384. virtual ~compressor() = default;
  3385. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3386. virtual bool compress(const char *data, size_t data_length, bool last,
  3387. Callback callback) = 0;
  3388. };
  3389. class decompressor {
  3390. public:
  3391. virtual ~decompressor() = default;
  3392. virtual bool is_valid() const = 0;
  3393. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3394. virtual bool decompress(const char *data, size_t data_length,
  3395. Callback callback) = 0;
  3396. };
  3397. class nocompressor final : public compressor {
  3398. public:
  3399. ~nocompressor() override = default;
  3400. bool compress(const char *data, size_t data_length, bool /*last*/,
  3401. Callback callback) override;
  3402. };
  3403. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3404. class gzip_compressor final : public compressor {
  3405. public:
  3406. gzip_compressor();
  3407. ~gzip_compressor() override;
  3408. bool compress(const char *data, size_t data_length, bool last,
  3409. Callback callback) override;
  3410. private:
  3411. bool is_valid_ = false;
  3412. z_stream strm_;
  3413. };
  3414. class gzip_decompressor final : public decompressor {
  3415. public:
  3416. gzip_decompressor();
  3417. ~gzip_decompressor() override;
  3418. bool is_valid() const override;
  3419. bool decompress(const char *data, size_t data_length,
  3420. Callback callback) override;
  3421. private:
  3422. bool is_valid_ = false;
  3423. z_stream strm_;
  3424. };
  3425. #endif
  3426. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3427. class brotli_compressor final : public compressor {
  3428. public:
  3429. brotli_compressor();
  3430. ~brotli_compressor();
  3431. bool compress(const char *data, size_t data_length, bool last,
  3432. Callback callback) override;
  3433. private:
  3434. BrotliEncoderState *state_ = nullptr;
  3435. };
  3436. class brotli_decompressor final : public decompressor {
  3437. public:
  3438. brotli_decompressor();
  3439. ~brotli_decompressor();
  3440. bool is_valid() const override;
  3441. bool decompress(const char *data, size_t data_length,
  3442. Callback callback) override;
  3443. private:
  3444. BrotliDecoderResult decoder_r;
  3445. BrotliDecoderState *decoder_s = nullptr;
  3446. };
  3447. #endif
  3448. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3449. class zstd_compressor : public compressor {
  3450. public:
  3451. zstd_compressor();
  3452. ~zstd_compressor();
  3453. bool compress(const char *data, size_t data_length, bool last,
  3454. Callback callback) override;
  3455. private:
  3456. ZSTD_CCtx *ctx_ = nullptr;
  3457. };
  3458. class zstd_decompressor : public decompressor {
  3459. public:
  3460. zstd_decompressor();
  3461. ~zstd_decompressor();
  3462. bool is_valid() const override;
  3463. bool decompress(const char *data, size_t data_length,
  3464. Callback callback) override;
  3465. private:
  3466. ZSTD_DCtx *ctx_ = nullptr;
  3467. };
  3468. #endif
  3469. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3470. // to store data. The call can set memory on stack for performance.
  3471. class stream_line_reader {
  3472. public:
  3473. stream_line_reader(Stream &strm, char *fixed_buffer,
  3474. size_t fixed_buffer_size);
  3475. const char *ptr() const;
  3476. size_t size() const;
  3477. bool end_with_crlf() const;
  3478. bool getline();
  3479. private:
  3480. void append(char c);
  3481. void append(const char *data, size_t size);
  3482. Stream &strm_;
  3483. char *fixed_buffer_;
  3484. const size_t fixed_buffer_size_;
  3485. size_t fixed_buffer_used_size_ = 0;
  3486. std::string growable_buffer_;
  3487. };
  3488. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3489. const Headers &src_headers);
  3490. struct ChunkedDecoder {
  3491. Stream &strm;
  3492. size_t chunk_remaining = 0;
  3493. bool finished = false;
  3494. char line_buf[64];
  3495. size_t last_chunk_total = 0;
  3496. size_t last_chunk_offset = 0;
  3497. size_t overhead = 0;
  3498. explicit ChunkedDecoder(Stream &s);
  3499. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3500. size_t &out_chunk_total);
  3501. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3502. };
  3503. // A regular file opened to be served: mapped on Windows, read with pread()
  3504. // elsewhere.
  3505. class mmap {
  3506. public:
  3507. mmap(const char *path);
  3508. ~mmap();
  3509. bool open(const char *path);
  3510. void close();
  3511. bool is_open() const;
  3512. size_t size() const;
  3513. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3514. // down to 0, if the file has shrunk since it was opened.
  3515. size_t read(size_t offset, char *buf, size_t len) const;
  3516. private:
  3517. #if defined(_WIN32)
  3518. HANDLE hFile_ = NULL;
  3519. HANDLE hMapping_ = NULL;
  3520. void *addr_ = nullptr;
  3521. bool is_open_empty_file = false;
  3522. #else
  3523. int fd_ = -1;
  3524. #endif
  3525. size_t size_ = 0;
  3526. };
  3527. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3528. namespace fields {
  3529. bool is_token_char(char c);
  3530. bool is_token(const std::string &s);
  3531. bool is_field_name(const std::string &s);
  3532. bool is_vchar(char c);
  3533. bool is_obs_text(char c);
  3534. bool is_field_vchar(char c);
  3535. bool is_field_content(const std::string &s);
  3536. bool is_field_value(const std::string &s);
  3537. bool is_field_valid(const std::string &name, const std::string &value);
  3538. bool is_request_target(const std::string &s);
  3539. bool is_host(const std::string &s);
  3540. } // namespace fields
  3541. } // namespace detail
  3542. /*
  3543. * TLS Abstraction Layer Declarations
  3544. */
  3545. #ifdef CPPHTTPLIB_SSL_ENABLED
  3546. // TLS abstraction layer - backend-specific type declarations
  3547. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3548. namespace tls {
  3549. namespace impl {
  3550. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3551. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3552. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3553. struct MbedTlsContext {
  3554. mbedtls_ssl_config conf;
  3555. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3556. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3557. mbedtls_entropy_context entropy;
  3558. mbedtls_ctr_drbg_context ctr_drbg;
  3559. #endif
  3560. mbedtls_x509_crt ca_chain;
  3561. mbedtls_x509_crt own_cert;
  3562. mbedtls_pk_context own_key;
  3563. bool is_server = false;
  3564. // Peer certificate required (set_verify_client()); a client defaults to true
  3565. bool verify_client = false;
  3566. // Set by tls::set_verify_callback().
  3567. VerifyCallback verify_callback;
  3568. MbedTlsContext();
  3569. ~MbedTlsContext();
  3570. MbedTlsContext(const MbedTlsContext &) = delete;
  3571. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3572. };
  3573. } // namespace impl
  3574. } // namespace tls
  3575. #endif
  3576. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3577. namespace tls {
  3578. namespace impl {
  3579. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3580. // This struct is accessible via tls::impl for use in SSL context
  3581. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3582. struct WolfSSLContext {
  3583. WOLFSSL_CTX *ctx = nullptr;
  3584. bool is_server = false;
  3585. // Peer certificate required (set_verify_client()); a client defaults to true
  3586. bool verify_client = false;
  3587. // Replaced under verify_callback_mutex()
  3588. std::shared_ptr<VerifyCallback> verify_callback;
  3589. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3590. WolfSSLContext();
  3591. ~WolfSSLContext();
  3592. WolfSSLContext(const WolfSSLContext &) = delete;
  3593. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3594. };
  3595. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3596. struct WolfSSLCAStore {
  3597. std::string pem_data;
  3598. };
  3599. } // namespace impl
  3600. } // namespace tls
  3601. #endif
  3602. #endif // CPPHTTPLIB_SSL_ENABLED
  3603. namespace stream {
  3604. class Result {
  3605. public:
  3606. Result();
  3607. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3608. Result(Result &&other) noexcept;
  3609. Result &operator=(Result &&other) noexcept;
  3610. Result(const Result &) = delete;
  3611. Result &operator=(const Result &) = delete;
  3612. // Response info
  3613. bool is_valid() const;
  3614. explicit operator bool() const;
  3615. int status() const;
  3616. const Headers &headers() const;
  3617. std::string get_header_value(const std::string &key,
  3618. const char *def = "") const;
  3619. bool has_header(const std::string &key) const;
  3620. Error error() const;
  3621. Error read_error() const;
  3622. bool has_read_error() const;
  3623. // Stream reading
  3624. bool next();
  3625. const char *data() const;
  3626. size_t size() const;
  3627. std::string read_all();
  3628. private:
  3629. ClientImpl::StreamHandle handle_;
  3630. std::string buffer_;
  3631. size_t current_size_ = 0;
  3632. size_t chunk_size_;
  3633. bool finished_ = false;
  3634. };
  3635. // GET
  3636. template <typename ClientType>
  3637. inline Result Get(ClientType &cli, const std::string &path,
  3638. size_t chunk_size = 8192) {
  3639. return Result{cli.open_stream("GET", path), chunk_size};
  3640. }
  3641. template <typename ClientType>
  3642. inline Result Get(ClientType &cli, const std::string &path,
  3643. const Headers &headers, size_t chunk_size = 8192) {
  3644. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3645. }
  3646. template <typename ClientType>
  3647. inline Result Get(ClientType &cli, const std::string &path,
  3648. const Params &params, size_t chunk_size = 8192) {
  3649. return Result{cli.open_stream("GET", path, params), chunk_size};
  3650. }
  3651. template <typename ClientType>
  3652. inline Result Get(ClientType &cli, const std::string &path,
  3653. const Params &params, const Headers &headers,
  3654. size_t chunk_size = 8192) {
  3655. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3656. }
  3657. // POST
  3658. template <typename ClientType>
  3659. inline Result Post(ClientType &cli, const std::string &path,
  3660. const std::string &body, const std::string &content_type,
  3661. size_t chunk_size = 8192) {
  3662. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3663. chunk_size};
  3664. }
  3665. template <typename ClientType>
  3666. inline Result Post(ClientType &cli, const std::string &path,
  3667. const Headers &headers, const std::string &body,
  3668. const std::string &content_type, size_t chunk_size = 8192) {
  3669. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3670. chunk_size};
  3671. }
  3672. template <typename ClientType>
  3673. inline Result Post(ClientType &cli, const std::string &path,
  3674. const Params &params, const std::string &body,
  3675. const std::string &content_type, size_t chunk_size = 8192) {
  3676. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3677. chunk_size};
  3678. }
  3679. template <typename ClientType>
  3680. inline Result Post(ClientType &cli, const std::string &path,
  3681. const Params &params, const Headers &headers,
  3682. const std::string &body, const std::string &content_type,
  3683. size_t chunk_size = 8192) {
  3684. return Result{
  3685. cli.open_stream("POST", path, params, headers, body, content_type),
  3686. chunk_size};
  3687. }
  3688. // PUT
  3689. template <typename ClientType>
  3690. inline Result Put(ClientType &cli, const std::string &path,
  3691. const std::string &body, const std::string &content_type,
  3692. size_t chunk_size = 8192) {
  3693. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3694. chunk_size};
  3695. }
  3696. template <typename ClientType>
  3697. inline Result Put(ClientType &cli, const std::string &path,
  3698. const Headers &headers, const std::string &body,
  3699. const std::string &content_type, size_t chunk_size = 8192) {
  3700. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3701. chunk_size};
  3702. }
  3703. template <typename ClientType>
  3704. inline Result Put(ClientType &cli, const std::string &path,
  3705. const Params &params, const std::string &body,
  3706. const std::string &content_type, size_t chunk_size = 8192) {
  3707. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3708. chunk_size};
  3709. }
  3710. template <typename ClientType>
  3711. inline Result Put(ClientType &cli, const std::string &path,
  3712. const Params &params, const Headers &headers,
  3713. const std::string &body, const std::string &content_type,
  3714. size_t chunk_size = 8192) {
  3715. return Result{
  3716. cli.open_stream("PUT", path, params, headers, body, content_type),
  3717. chunk_size};
  3718. }
  3719. // PATCH
  3720. template <typename ClientType>
  3721. inline Result Patch(ClientType &cli, const std::string &path,
  3722. const std::string &body, const std::string &content_type,
  3723. size_t chunk_size = 8192) {
  3724. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3725. chunk_size};
  3726. }
  3727. template <typename ClientType>
  3728. inline Result Patch(ClientType &cli, const std::string &path,
  3729. const Headers &headers, const std::string &body,
  3730. const std::string &content_type, size_t chunk_size = 8192) {
  3731. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3732. chunk_size};
  3733. }
  3734. template <typename ClientType>
  3735. inline Result Patch(ClientType &cli, const std::string &path,
  3736. const Params &params, const std::string &body,
  3737. const std::string &content_type, size_t chunk_size = 8192) {
  3738. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3739. chunk_size};
  3740. }
  3741. template <typename ClientType>
  3742. inline Result Patch(ClientType &cli, const std::string &path,
  3743. const Params &params, const Headers &headers,
  3744. const std::string &body, const std::string &content_type,
  3745. size_t chunk_size = 8192) {
  3746. return Result{
  3747. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3748. chunk_size};
  3749. }
  3750. // DELETE
  3751. template <typename ClientType>
  3752. inline Result Delete(ClientType &cli, const std::string &path,
  3753. size_t chunk_size = 8192) {
  3754. return Result{cli.open_stream("DELETE", path), chunk_size};
  3755. }
  3756. template <typename ClientType>
  3757. inline Result Delete(ClientType &cli, const std::string &path,
  3758. const Headers &headers, size_t chunk_size = 8192) {
  3759. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3760. }
  3761. template <typename ClientType>
  3762. inline Result Delete(ClientType &cli, const std::string &path,
  3763. const std::string &body, const std::string &content_type,
  3764. size_t chunk_size = 8192) {
  3765. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3766. chunk_size};
  3767. }
  3768. template <typename ClientType>
  3769. inline Result Delete(ClientType &cli, const std::string &path,
  3770. const Headers &headers, const std::string &body,
  3771. const std::string &content_type,
  3772. size_t chunk_size = 8192) {
  3773. return Result{
  3774. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3775. chunk_size};
  3776. }
  3777. template <typename ClientType>
  3778. inline Result Delete(ClientType &cli, const std::string &path,
  3779. const Params &params, size_t chunk_size = 8192) {
  3780. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3781. }
  3782. template <typename ClientType>
  3783. inline Result Delete(ClientType &cli, const std::string &path,
  3784. const Params &params, const Headers &headers,
  3785. size_t chunk_size = 8192) {
  3786. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3787. }
  3788. template <typename ClientType>
  3789. inline Result Delete(ClientType &cli, const std::string &path,
  3790. const Params &params, const std::string &body,
  3791. const std::string &content_type,
  3792. size_t chunk_size = 8192) {
  3793. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3794. chunk_size};
  3795. }
  3796. template <typename ClientType>
  3797. inline Result Delete(ClientType &cli, const std::string &path,
  3798. const Params &params, const Headers &headers,
  3799. const std::string &body, const std::string &content_type,
  3800. size_t chunk_size = 8192) {
  3801. return Result{
  3802. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3803. chunk_size};
  3804. }
  3805. // HEAD
  3806. template <typename ClientType>
  3807. inline Result Head(ClientType &cli, const std::string &path,
  3808. size_t chunk_size = 8192) {
  3809. return Result{cli.open_stream("HEAD", path), chunk_size};
  3810. }
  3811. template <typename ClientType>
  3812. inline Result Head(ClientType &cli, const std::string &path,
  3813. const Headers &headers, size_t chunk_size = 8192) {
  3814. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3815. }
  3816. template <typename ClientType>
  3817. inline Result Head(ClientType &cli, const std::string &path,
  3818. const Params &params, size_t chunk_size = 8192) {
  3819. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3820. }
  3821. template <typename ClientType>
  3822. inline Result Head(ClientType &cli, const std::string &path,
  3823. const Params &params, const Headers &headers,
  3824. size_t chunk_size = 8192) {
  3825. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3826. }
  3827. // OPTIONS
  3828. template <typename ClientType>
  3829. inline Result Options(ClientType &cli, const std::string &path,
  3830. size_t chunk_size = 8192) {
  3831. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3832. }
  3833. template <typename ClientType>
  3834. inline Result Options(ClientType &cli, const std::string &path,
  3835. const Headers &headers, size_t chunk_size = 8192) {
  3836. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3837. }
  3838. template <typename ClientType>
  3839. inline Result Options(ClientType &cli, const std::string &path,
  3840. const Params &params, size_t chunk_size = 8192) {
  3841. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3842. }
  3843. template <typename ClientType>
  3844. inline Result Options(ClientType &cli, const std::string &path,
  3845. const Params &params, const Headers &headers,
  3846. size_t chunk_size = 8192) {
  3847. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3848. }
  3849. } // namespace stream
  3850. namespace sse {
  3851. struct SSEMessage {
  3852. std::string event; // Event type (default: "message")
  3853. std::string data; // Event payload
  3854. std::string id; // Event ID for Last-Event-ID header
  3855. SSEMessage();
  3856. void clear();
  3857. };
  3858. class SSEClient {
  3859. public:
  3860. using MessageHandler = std::function<void(const SSEMessage &)>;
  3861. using ErrorHandler = std::function<void(Error)>;
  3862. using OpenHandler = std::function<void()>;
  3863. SSEClient(Client &client, const std::string &path);
  3864. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3865. ~SSEClient();
  3866. SSEClient(const SSEClient &) = delete;
  3867. SSEClient &operator=(const SSEClient &) = delete;
  3868. // Event handlers
  3869. SSEClient &on_message(MessageHandler handler);
  3870. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3871. SSEClient &on_open(OpenHandler handler);
  3872. SSEClient &on_error(ErrorHandler handler);
  3873. SSEClient &set_reconnect_interval(int ms);
  3874. SSEClient &set_max_reconnect_attempts(int n);
  3875. // Update headers (thread-safe)
  3876. SSEClient &set_headers(const Headers &headers);
  3877. // State accessors
  3878. bool is_connected() const;
  3879. std::string last_event_id() const;
  3880. // Blocking start - runs event loop with auto-reconnect
  3881. void start();
  3882. // Non-blocking start - runs in background thread
  3883. void start_async();
  3884. // Stop the client (thread-safe)
  3885. void stop();
  3886. private:
  3887. void run_event_loop();
  3888. void dispatch_event(const SSEMessage &msg);
  3889. bool should_reconnect(int count) const;
  3890. void wait_for_reconnect();
  3891. // Client and path
  3892. Client &client_;
  3893. std::string path_;
  3894. Headers headers_;
  3895. mutable std::mutex headers_mutex_;
  3896. // Callbacks
  3897. MessageHandler on_message_;
  3898. std::map<std::string, MessageHandler> event_handlers_;
  3899. OpenHandler on_open_;
  3900. ErrorHandler on_error_;
  3901. // Configuration
  3902. int reconnect_interval_ms_ = 3000;
  3903. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3904. // State
  3905. std::atomic<bool> running_{false};
  3906. std::atomic<bool> connected_{false};
  3907. // Written by the event loop, which start_async() runs on its own thread
  3908. std::string last_event_id_;
  3909. mutable std::mutex last_event_id_mutex_;
  3910. // Async support
  3911. std::thread async_thread_;
  3912. };
  3913. } // namespace sse
  3914. namespace detail {
  3915. // Interprets an event stream fed in chunks of any size
  3916. class SSEParser {
  3917. public:
  3918. using EventHandler = std::function<void(const sse::SSEMessage &msg)>;
  3919. using IdHandler = std::function<void(const std::string &id)>;
  3920. using RetryHandler = std::function<void(int retry_ms)>;
  3921. SSEParser(EventHandler on_event, IdHandler on_id, RetryHandler on_retry,
  3922. size_t max_event_length = CPPHTTPLIB_SSE_MAX_EVENT_LENGTH);
  3923. // Returns false once the line and the event still waiting for their end
  3924. // exceed max_event_length. 0 means no limit.
  3925. bool parse(const char *buf, size_t n);
  3926. private:
  3927. void parse_line(const std::string &line);
  3928. EventHandler on_event_;
  3929. IdHandler on_id_;
  3930. RetryHandler on_retry_;
  3931. size_t max_event_length_;
  3932. std::string buffer_;
  3933. sse::SSEMessage msg_;
  3934. bool has_data_ = false;
  3935. bool has_id_ = false;
  3936. bool first_line_ = true;
  3937. bool after_cr_ = false;
  3938. };
  3939. } // namespace detail
  3940. namespace ws {
  3941. class WebSocketClient;
  3942. enum class Opcode : uint8_t {
  3943. Continuation = 0x0,
  3944. Text = 0x1,
  3945. Binary = 0x2,
  3946. Close = 0x8,
  3947. Ping = 0x9,
  3948. Pong = 0xA,
  3949. };
  3950. enum class CloseStatus : uint16_t {
  3951. Normal = 1000,
  3952. GoingAway = 1001,
  3953. ProtocolError = 1002,
  3954. UnsupportedData = 1003,
  3955. NoStatus = 1005,
  3956. Abnormal = 1006,
  3957. InvalidPayload = 1007,
  3958. PolicyViolation = 1008,
  3959. MessageTooBig = 1009,
  3960. MandatoryExtension = 1010,
  3961. InternalError = 1011,
  3962. };
  3963. // Timeout is returned only when a read timeout was set and it elapsed before
  3964. // any byte of a frame arrived: nothing was consumed and the connection is
  3965. // still open, so the caller can send on it and read again. `msg` is left
  3966. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3967. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3968. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3969. // upgrade handshake fully succeeded. On failure error() identifies the
  3970. // failing layer; status()/headers() expose the server's upgrade response
  3971. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3972. // CONNECT when error() is ProxyConnection.
  3973. class Result {
  3974. public:
  3975. Result() = default;
  3976. Result(Error err, int status, Headers &&headers)
  3977. : err_(err), status_(status), headers_(std::move(headers)) {}
  3978. explicit operator bool() const { return err_ == Error::Success; }
  3979. Error error() const { return err_; }
  3980. // Upgrade response info
  3981. int status() const { return status_; }
  3982. const Headers &headers() const { return headers_; }
  3983. std::string get_header_value(const std::string &key,
  3984. const char *def = "") const {
  3985. return detail::get_header_value(headers_, key, def, 0);
  3986. }
  3987. bool has_header(const std::string &key) const {
  3988. return headers_.find(key) != headers_.end();
  3989. }
  3990. #ifdef CPPHTTPLIB_SSL_ENABLED
  3991. Result(Error err, int status, Headers &&headers, int ssl_error,
  3992. uint64_t ssl_backend_error)
  3993. : err_(err), status_(status), headers_(std::move(headers)),
  3994. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3995. int ssl_error() const { return ssl_error_; }
  3996. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3997. #endif
  3998. private:
  3999. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  4000. int status_ = -1;
  4001. Headers headers_;
  4002. #ifdef CPPHTTPLIB_SSL_ENABLED
  4003. int ssl_error_ = 0;
  4004. uint64_t ssl_backend_error_ = 0;
  4005. #endif
  4006. };
  4007. namespace impl {
  4008. bool is_valid_utf8(const std::string &s);
  4009. // Three states: a frame, a failure (the connection cannot be read on), or a
  4010. // timeout with the stream still usable.
  4011. enum class FrameRead { Ok, Fail, Timeout };
  4012. // A frame read in as many calls as it takes. A timeout leaves what was read
  4013. // so far in place, and the next read() goes on from there, so the stream is
  4014. // usable after a timeout wherever in a frame it lands.
  4015. class FrameReader {
  4016. public:
  4017. FrameRead read(Stream &strm, Opcode &opcode, std::string &payload, bool &fin,
  4018. bool expect_masked, size_t max_len);
  4019. // Whether part of a frame has been read and the rest is still to come
  4020. bool begun() const { return have_ > 0; }
  4021. private:
  4022. void reset();
  4023. uint8_t head_[14] = {0}; // FIN + opcode, MASK + length, its extension, key
  4024. size_t have_ = 0; // bytes of the header read so far
  4025. size_t need_ = 2; // bytes of the header, once the second is read
  4026. bool sized_ = false; // the header is whole and its length checked
  4027. size_t len_ = 0; // the payload's length, once sized_
  4028. std::string payload_;
  4029. };
  4030. // A whole frame read in one go: a timeout before any of it came is reported,
  4031. // and one that cuts it short is a failure.
  4032. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4033. std::string &payload, bool &fin,
  4034. bool expect_masked, size_t max_len);
  4035. } // namespace impl
  4036. class WebSocket {
  4037. public:
  4038. WebSocket(const WebSocket &) = delete;
  4039. WebSocket &operator=(const WebSocket &) = delete;
  4040. ~WebSocket();
  4041. ReadResult read(std::string &msg);
  4042. bool send(const std::string &data);
  4043. bool send(const char *data, size_t len);
  4044. void close(CloseStatus status = CloseStatus::Normal,
  4045. const std::string &reason = "");
  4046. const Request &request() const;
  4047. bool is_open() const;
  4048. // Bound how long read() waits before returning Timeout. 0 waits forever.
  4049. // A server handler owns its connection's timeout this way; a client sets it
  4050. // through WebSocketClient. Safe to call while another thread is in read().
  4051. // It lands anywhere, inside a message too: what was read of it is kept,
  4052. // and the next read() goes on from there.
  4053. //
  4054. // Only a timeout set here is reported as Timeout. The compile-time default
  4055. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  4056. // than a request for control, so when it elapses read() returns Fail and
  4057. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  4058. void set_read_timeout(time_t sec, time_t usec = 0);
  4059. template <class Rep, class Period>
  4060. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  4061. private:
  4062. friend class httplib::Server;
  4063. friend class httplib::ws::WebSocketClient;
  4064. WebSocket(
  4065. Stream &strm, const Request &req, bool is_server,
  4066. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  4067. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS,
  4068. std::function<bool()> server_stopping = nullptr)
  4069. : strm_(strm), req_(req), is_server_(is_server),
  4070. ping_interval_sec_(ping_interval_sec),
  4071. max_missed_pongs_(max_missed_pongs),
  4072. server_stopping_(std::move(server_stopping)) {
  4073. interrupt_reads();
  4074. start_heartbeat();
  4075. }
  4076. WebSocket(
  4077. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  4078. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  4079. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS,
  4080. std::function<bool()> server_stopping = nullptr)
  4081. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  4082. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  4083. max_missed_pongs_(max_missed_pongs),
  4084. server_stopping_(std::move(server_stopping)) {
  4085. interrupt_reads();
  4086. start_heartbeat();
  4087. }
  4088. void interrupt_reads();
  4089. bool server_stopping() const {
  4090. return server_stopping_ && server_stopping_();
  4091. }
  4092. void start_heartbeat();
  4093. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  4094. Stream &strm_;
  4095. std::unique_ptr<Stream> owned_strm_;
  4096. Request req_;
  4097. bool is_server_;
  4098. time_t ping_interval_sec_;
  4099. int max_missed_pongs_;
  4100. int unacked_pings_ = 0;
  4101. std::atomic<bool> closed_{false};
  4102. // Set when the peer stopped answering pings, to end a read() waiting on it
  4103. std::atomic<bool> pong_timed_out_{false};
  4104. // A server connection's view of Server::stop(), which ends its read() too
  4105. std::function<bool()> server_stopping_;
  4106. // Set once the caller has bounded read() through set_read_timeout(). Until
  4107. // then the timeout in effect is the compile-time default, and elapsing it
  4108. // is a failure that closes the connection, not a Timeout.
  4109. std::atomic<bool> read_timeout_set_{false};
  4110. std::mutex write_mutex_;
  4111. // Owned by whichever thread is parsing frames off strm_. Only one thread
  4112. // may do so: a frame is read until it has the whole declared length,
  4113. // across several read() calls when a timeout lands inside it (frames_
  4114. // below), so a second parser stealing bytes silently corrupts the message
  4115. // the first one is assembling.
  4116. std::mutex read_mutex_;
  4117. // What read() has of the frame and the message it has not finished, kept
  4118. // across a timeout. Guarded by read_mutex_.
  4119. impl::FrameReader frames_;
  4120. std::string message_;
  4121. ReadResult message_kind_ = Fail; // Text or Binary while one is assembled
  4122. std::thread ping_thread_;
  4123. std::mutex ping_mutex_;
  4124. std::condition_variable ping_cv_;
  4125. };
  4126. class WebSocketClient {
  4127. public:
  4128. explicit WebSocketClient(const std::string &scheme_host_port_path,
  4129. const Headers &headers = {});
  4130. ~WebSocketClient();
  4131. WebSocketClient(const WebSocketClient &) = delete;
  4132. WebSocketClient &operator=(const WebSocketClient &) = delete;
  4133. bool is_valid() const;
  4134. Result connect();
  4135. ReadResult read(std::string &msg);
  4136. bool send(const std::string &data);
  4137. bool send(const char *data, size_t len);
  4138. void close(CloseStatus status = CloseStatus::Normal,
  4139. const std::string &reason = "");
  4140. bool is_open() const;
  4141. const std::string &subprotocol() const;
  4142. void set_read_timeout(time_t sec, time_t usec = 0);
  4143. template <class Rep, class Period>
  4144. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  4145. void set_write_timeout(time_t sec, time_t usec = 0);
  4146. template <class Rep, class Period>
  4147. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  4148. void set_websocket_ping_interval(time_t sec);
  4149. void set_websocket_max_missed_pongs(int count);
  4150. void set_tcp_nodelay(bool on);
  4151. void set_address_family(int family);
  4152. void set_ipv6_v6only(bool on);
  4153. void set_socket_options(SocketOptions socket_options);
  4154. void set_connection_timeout(time_t sec, time_t usec = 0);
  4155. template <class Rep, class Period>
  4156. void
  4157. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  4158. void set_interface(const std::string &intf);
  4159. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  4160. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  4161. void
  4162. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  4163. void
  4164. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  4165. void set_basic_auth(const std::string &username, const std::string &password);
  4166. void set_bearer_token_auth(const std::string &token);
  4167. void set_proxy(const std::string &host, int port);
  4168. void set_proxy_basic_auth(const std::string &username,
  4169. const std::string &password);
  4170. void set_proxy_bearer_token_auth(const std::string &token);
  4171. void set_no_proxy(const std::vector<std::string> &patterns);
  4172. #ifdef CPPHTTPLIB_SSL_ENABLED
  4173. struct PemMemory {
  4174. const char *cert_pem;
  4175. size_t cert_pem_len;
  4176. const char *key_pem;
  4177. size_t key_pem_len;
  4178. const char *private_key_password;
  4179. };
  4180. explicit WebSocketClient(const std::string &scheme_host_port_path,
  4181. const PemMemory &pem, const Headers &headers = {});
  4182. void set_ca_cert_path(const std::string &ca_cert_file_path,
  4183. const std::string &ca_cert_dir_path = std::string());
  4184. void set_ca_cert_store(tls::ca_store_t store);
  4185. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  4186. void enable_server_certificate_verification(bool enabled);
  4187. void enable_server_hostname_verification(bool enabled);
  4188. void enable_system_ca(bool enabled);
  4189. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  4190. void set_session_verifier(
  4191. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  4192. void set_proxy_digest_auth(const std::string &username,
  4193. const std::string &password);
  4194. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  4195. void enable_windows_certificate_verification(bool enabled);
  4196. #endif
  4197. #endif
  4198. private:
  4199. void shutdown_and_close();
  4200. std::pair<time_t, time_t> handshake_timeout() const;
  4201. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  4202. int &ssl_error, uint64_t &ssl_backend_error);
  4203. void prepare_default_headers(Request &req);
  4204. bool is_proxy_enabled() const;
  4205. bool create_and_connect_socket(Error &error);
  4206. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  4207. bool connect_with_proxy(Response &proxy_res, Error &error);
  4208. std::string host_;
  4209. int port_;
  4210. std::string path_;
  4211. Headers headers_;
  4212. std::string subprotocol_;
  4213. bool is_valid_ = false;
  4214. socket_t sock_ = INVALID_SOCKET;
  4215. std::unique_ptr<WebSocket> ws_;
  4216. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  4217. time_t read_timeout_usec_ = 0;
  4218. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  4219. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  4220. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  4221. time_t websocket_ping_interval_sec_ =
  4222. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  4223. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  4224. int address_family_ = AF_UNSPEC;
  4225. bool tcp_nodelay_ = CPPHTTPLIB_WEBSOCKET_TCP_NODELAY;
  4226. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  4227. SocketOptions socket_options_ = nullptr;
  4228. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  4229. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  4230. std::string interface_;
  4231. // Hostname to connection target map. The value is an IP literal or another
  4232. // hostname; only the connection target changes, never the identity.
  4233. std::map<std::string, std::string> addr_map_;
  4234. // Hostname to CONNECT target map, used only through a proxy.
  4235. std::map<std::string, std::string> tunnel_addr_map_;
  4236. std::string basic_auth_username_;
  4237. std::string basic_auth_password_;
  4238. std::string bearer_token_auth_token_;
  4239. std::string proxy_host_;
  4240. int proxy_port_ = -1;
  4241. std::string proxy_basic_auth_username_;
  4242. std::string proxy_basic_auth_password_;
  4243. std::string proxy_bearer_token_auth_token_;
  4244. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  4245. #ifdef CPPHTTPLIB_SSL_ENABLED
  4246. bool is_ssl_ = false;
  4247. tls::ctx_t tls_ctx_ = nullptr;
  4248. tls::session_t tls_session_ = nullptr;
  4249. std::string ca_cert_file_path_;
  4250. std::string ca_cert_dir_path_;
  4251. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  4252. // no certificate, so that a CA that failed to come through fails
  4253. // verification instead of letting the system CAs in.
  4254. bool custom_ca_loaded_ = false;
  4255. bool certs_loaded_ = false;
  4256. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  4257. bool server_certificate_verification_ = true;
  4258. bool server_hostname_verification_ = true;
  4259. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  4260. std::string proxy_digest_auth_username_;
  4261. std::string proxy_digest_auth_password_;
  4262. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  4263. bool enable_windows_cert_verification_ = true;
  4264. bool server_certificate_verifier_set_ = false;
  4265. #endif
  4266. #endif
  4267. };
  4268. template <class Rep, class Period>
  4269. inline void WebSocket::set_read_timeout(
  4270. const std::chrono::duration<Rep, Period> &duration) {
  4271. detail::duration_to_sec_and_usec(
  4272. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4273. }
  4274. template <class Rep, class Period>
  4275. inline void WebSocketClient::set_read_timeout(
  4276. const std::chrono::duration<Rep, Period> &duration) {
  4277. detail::duration_to_sec_and_usec(
  4278. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4279. }
  4280. template <class Rep, class Period>
  4281. inline void WebSocketClient::set_write_timeout(
  4282. const std::chrono::duration<Rep, Period> &duration) {
  4283. detail::duration_to_sec_and_usec(
  4284. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  4285. }
  4286. template <class Rep, class Period>
  4287. inline void WebSocketClient::set_connection_timeout(
  4288. const std::chrono::duration<Rep, Period> &duration) {
  4289. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  4290. set_connection_timeout(sec, usec);
  4291. });
  4292. }
  4293. } // namespace ws
  4294. namespace detail {
  4295. bool write_websocket_frame(Stream &strm, ws::Opcode opcode, const char *data,
  4296. size_t len, bool fin, bool mask);
  4297. } // namespace detail
  4298. // ----------------------------------------------------------------------------
  4299. /*
  4300. * Implementation that will be part of the .cc file if split into .h + .cc.
  4301. */
  4302. namespace stream {
  4303. // stream::Result implementations
  4304. inline Result::Result() : chunk_size_(8192) {}
  4305. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4306. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4307. inline Result::Result(Result &&other) noexcept
  4308. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4309. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4310. finished_(other.finished_) {
  4311. other.current_size_ = 0;
  4312. other.finished_ = true;
  4313. }
  4314. inline Result &Result::operator=(Result &&other) noexcept {
  4315. if (this != &other) {
  4316. handle_ = std::move(other.handle_);
  4317. buffer_ = std::move(other.buffer_);
  4318. current_size_ = other.current_size_;
  4319. chunk_size_ = other.chunk_size_;
  4320. finished_ = other.finished_;
  4321. other.current_size_ = 0;
  4322. other.finished_ = true;
  4323. }
  4324. return *this;
  4325. }
  4326. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4327. inline Result::operator bool() const { return is_valid(); }
  4328. inline int Result::status() const {
  4329. return handle_.response ? handle_.response->status : -1;
  4330. }
  4331. inline const Headers &Result::headers() const {
  4332. static const Headers empty_headers;
  4333. return handle_.response ? handle_.response->headers : empty_headers;
  4334. }
  4335. inline std::string Result::get_header_value(const std::string &key,
  4336. const char *def) const {
  4337. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4338. }
  4339. inline bool Result::has_header(const std::string &key) const {
  4340. return handle_.response ? handle_.response->has_header(key) : false;
  4341. }
  4342. inline Error Result::error() const { return handle_.error; }
  4343. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4344. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4345. inline bool Result::next() {
  4346. if (!handle_.is_valid() || finished_) { return false; }
  4347. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4348. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4349. if (n > 0) {
  4350. current_size_ = static_cast<size_t>(n);
  4351. return true;
  4352. }
  4353. current_size_ = 0;
  4354. finished_ = true;
  4355. return false;
  4356. }
  4357. inline const char *Result::data() const { return buffer_.data(); }
  4358. inline size_t Result::size() const { return current_size_; }
  4359. inline std::string Result::read_all() {
  4360. std::string result;
  4361. while (next()) {
  4362. result.append(data(), size());
  4363. }
  4364. return result;
  4365. }
  4366. } // namespace stream
  4367. namespace detail {
  4368. inline SSEParser::SSEParser(EventHandler on_event, IdHandler on_id,
  4369. RetryHandler on_retry, size_t max_event_length)
  4370. : on_event_(std::move(on_event)), on_id_(std::move(on_id)),
  4371. on_retry_(std::move(on_retry)), max_event_length_(max_event_length) {}
  4372. inline bool SSEParser::parse(const char *buf, size_t n) {
  4373. // What is left in the buffer has no line ending
  4374. auto search_pos = buffer_.size();
  4375. buffer_.append(buf, n);
  4376. // A line ends with \r\n, \n or \r per the SSE spec
  4377. size_t line_start = 0;
  4378. size_t eol_pos;
  4379. while ((eol_pos = buffer_.find_first_of("\r\n", search_pos)) !=
  4380. std::string::npos) {
  4381. auto line = buffer_.substr(line_start, eol_pos - line_start);
  4382. line_start = eol_pos + 1;
  4383. search_pos = line_start;
  4384. // The \n of a \r\n may arrive in a later chunk than its \r
  4385. auto is_lf_of_crlf = after_cr_ && line.empty() && buffer_[eol_pos] == '\n';
  4386. after_cr_ = buffer_[eol_pos] == '\r';
  4387. if (is_lf_of_crlf) { continue; }
  4388. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4389. if (first_line_) {
  4390. first_line_ = false;
  4391. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4392. }
  4393. parse_line(line);
  4394. }
  4395. // Keep unprocessed data in buffer
  4396. buffer_.erase(0, line_start);
  4397. return max_event_length_ == 0 ||
  4398. buffer_.size() + msg_.data.size() <= max_event_length_;
  4399. }
  4400. inline void SSEParser::parse_line(const std::string &line) {
  4401. // Blank line signals end of event
  4402. if (line.empty()) {
  4403. // The id counts for Last-Event-ID even for an event that has no data. An
  4404. // empty id clears it.
  4405. if (has_id_ && on_id_) { on_id_(msg_.id); }
  4406. // An event without a data field is not dispatched
  4407. if (has_data_ && on_event_) { on_event_(msg_); }
  4408. msg_.clear();
  4409. has_data_ = false;
  4410. has_id_ = false;
  4411. return;
  4412. }
  4413. // Lines starting with ':' are comments (ignored)
  4414. if (line[0] == ':') { return; }
  4415. // Find the colon separator
  4416. auto colon_pos = line.find(':');
  4417. auto field = line.substr(0, colon_pos);
  4418. std::string value;
  4419. // Value starts after colon, skip optional single space
  4420. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4421. auto value_start = colon_pos + 1;
  4422. if (line[value_start] == ' ') { value_start++; }
  4423. value = line.substr(value_start);
  4424. }
  4425. // Handle known fields
  4426. if (field == "event") {
  4427. // An empty event type is dispatched as "message" per the SSE spec
  4428. msg_.event = value.empty() ? std::string("message") : std::move(value);
  4429. } else if (field == "data") {
  4430. // Multiple data lines are concatenated with newlines
  4431. if (has_data_) { msg_.data += "\n"; }
  4432. msg_.data += value;
  4433. has_data_ = true;
  4434. } else if (field == "id") {
  4435. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4436. // valid (clears the last event ID)
  4437. if (fields::is_field_value(value)) {
  4438. msg_.id = value;
  4439. has_id_ = true;
  4440. }
  4441. } else if (field == "retry") {
  4442. // Parse retry interval in milliseconds
  4443. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4444. if (is_numeric(value)) {
  4445. int v = 0;
  4446. auto res = from_chars(value.data(), value.data() + value.size(), v);
  4447. if (res.ec == std::errc{} && on_retry_) { on_retry_(v); }
  4448. }
  4449. }
  4450. // Unknown fields are ignored per SSE spec
  4451. }
  4452. } // namespace detail
  4453. namespace sse {
  4454. // SSEMessage implementations
  4455. inline SSEMessage::SSEMessage() : event("message") {}
  4456. inline void SSEMessage::clear() {
  4457. event = "message";
  4458. data.clear();
  4459. id.clear();
  4460. }
  4461. // SSEClient implementations
  4462. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4463. : client_(client), path_(path) {}
  4464. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4465. const Headers &headers)
  4466. : client_(client), path_(path), headers_(headers) {}
  4467. inline SSEClient::~SSEClient() { stop(); }
  4468. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4469. on_message_ = std::move(handler);
  4470. return *this;
  4471. }
  4472. inline SSEClient &SSEClient::on_event(const std::string &type,
  4473. MessageHandler handler) {
  4474. event_handlers_[type] = std::move(handler);
  4475. return *this;
  4476. }
  4477. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4478. on_open_ = std::move(handler);
  4479. return *this;
  4480. }
  4481. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4482. on_error_ = std::move(handler);
  4483. return *this;
  4484. }
  4485. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4486. reconnect_interval_ms_ = ms;
  4487. return *this;
  4488. }
  4489. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4490. max_reconnect_attempts_ = n;
  4491. return *this;
  4492. }
  4493. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4494. std::lock_guard<std::mutex> lock(headers_mutex_);
  4495. headers_ = headers;
  4496. return *this;
  4497. }
  4498. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4499. inline std::string SSEClient::last_event_id() const {
  4500. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4501. return last_event_id_;
  4502. }
  4503. inline void SSEClient::start() {
  4504. running_.store(true);
  4505. run_event_loop();
  4506. }
  4507. inline void SSEClient::start_async() {
  4508. running_.store(true);
  4509. async_thread_ = std::thread([this]() { run_event_loop(); });
  4510. }
  4511. inline void SSEClient::stop() {
  4512. running_.store(false);
  4513. client_.stop(); // Cancel any pending operations
  4514. if (async_thread_.joinable()) { async_thread_.join(); }
  4515. }
  4516. inline void SSEClient::run_event_loop() {
  4517. auto reconnect_count = 0;
  4518. while (running_.load()) {
  4519. // Build headers, including Last-Event-ID if we have one
  4520. Headers request_headers;
  4521. {
  4522. std::lock_guard<std::mutex> lock(headers_mutex_);
  4523. request_headers = headers_;
  4524. }
  4525. if (!last_event_id_.empty()) {
  4526. request_headers.emplace("Last-Event-ID", last_event_id_);
  4527. }
  4528. // Open streaming connection. An event stream has no end, so each event is
  4529. // bounded instead of the whole body.
  4530. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4531. handle.body_reader_.payload_max_length = 0;
  4532. // stop() ends a read that is waiting for the next event
  4533. if (handle.stream_) {
  4534. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4535. }
  4536. stream::Result result{std::move(handle)};
  4537. // Connection error handling
  4538. if (!result) {
  4539. connected_.store(false);
  4540. if (on_error_) { on_error_(result.error()); }
  4541. if (!should_reconnect(reconnect_count)) { break; }
  4542. wait_for_reconnect();
  4543. reconnect_count++;
  4544. continue;
  4545. }
  4546. if (result.status() != StatusCode::OK_200) {
  4547. connected_.store(false);
  4548. if (on_error_) { on_error_(Error::Connection); }
  4549. // For certain errors, don't reconnect.
  4550. // Note: 401 is intentionally absent so that handlers can refresh
  4551. // credentials via set_headers() and let the client reconnect.
  4552. if (result.status() == StatusCode::NoContent_204 ||
  4553. result.status() == StatusCode::NotFound_404 ||
  4554. result.status() == StatusCode::Forbidden_403) {
  4555. break;
  4556. }
  4557. if (!should_reconnect(reconnect_count)) { break; }
  4558. wait_for_reconnect();
  4559. reconnect_count++;
  4560. continue;
  4561. }
  4562. // Connection successful
  4563. connected_.store(true);
  4564. reconnect_count = 0;
  4565. if (on_open_) { on_open_(); }
  4566. // Event receiving loop
  4567. detail::SSEParser parser(
  4568. [this](const SSEMessage &msg) { dispatch_event(msg); },
  4569. [this](const std::string &id) {
  4570. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4571. last_event_id_ = id;
  4572. },
  4573. [this](int retry_ms) { reconnect_interval_ms_ = retry_ms; });
  4574. auto event_too_long = false;
  4575. while (running_.load() && result.next()) {
  4576. if (!parser.parse(result.data(), result.size())) {
  4577. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4578. event_too_long = true;
  4579. break;
  4580. }
  4581. }
  4582. // Connection ended
  4583. connected_.store(false);
  4584. // Reconnecting would only get the same event again
  4585. if (!running_.load() || event_too_long) { break; }
  4586. // Check for read errors
  4587. if (result.has_read_error()) {
  4588. if (on_error_) { on_error_(result.read_error()); }
  4589. }
  4590. if (!should_reconnect(reconnect_count)) { break; }
  4591. wait_for_reconnect();
  4592. reconnect_count++;
  4593. }
  4594. connected_.store(false);
  4595. }
  4596. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4597. // Check for specific event type handler first
  4598. auto it = event_handlers_.find(msg.event);
  4599. if (it != event_handlers_.end()) {
  4600. it->second(msg);
  4601. return;
  4602. }
  4603. // Fall back to generic message handler
  4604. if (on_message_) { on_message_(msg); }
  4605. }
  4606. inline bool SSEClient::should_reconnect(int count) const {
  4607. if (!running_.load()) { return false; }
  4608. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4609. return count < max_reconnect_attempts_;
  4610. }
  4611. inline void SSEClient::wait_for_reconnect() {
  4612. // Use small increments to check running_ flag frequently.
  4613. // Always wait at least one increment, so that a zero interval (e.g.
  4614. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4615. const auto step_ms = 100;
  4616. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4617. auto waited = 0;
  4618. while (running_.load() && waited < interval_ms) {
  4619. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4620. waited += step_ms;
  4621. }
  4622. }
  4623. } // namespace sse
  4624. #ifdef CPPHTTPLIB_SSL_ENABLED
  4625. /*
  4626. * TLS abstraction layer - internal function declarations
  4627. * These are implementation details and not part of the public API.
  4628. */
  4629. namespace tls {
  4630. // Client context
  4631. ctx_t create_client_context();
  4632. void free_context(ctx_t ctx);
  4633. bool set_min_version(ctx_t ctx, Version version);
  4634. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4635. bool load_ca_file(ctx_t ctx, const char *file_path);
  4636. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4637. bool load_system_certs(ctx_t ctx);
  4638. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4639. const char *password);
  4640. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4641. const char *key_path, const char *password);
  4642. // Server context
  4643. ctx_t create_server_context();
  4644. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4645. const char *password);
  4646. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4647. const char *key_path, const char *password);
  4648. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4649. void set_verify_client(ctx_t ctx, bool require);
  4650. // Session management
  4651. session_t create_session(ctx_t ctx, socket_t sock);
  4652. void free_session(session_t session);
  4653. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4654. // Handshake (non-blocking capable)
  4655. TlsError connect(session_t session);
  4656. TlsError accept(session_t session);
  4657. // Handshake with timeout (blocking until timeout, or until interrupted)
  4658. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4659. time_t timeout_usec, TlsError *err,
  4660. const std::function<bool()> &interrupted = nullptr);
  4661. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4662. time_t timeout_usec, TlsError *err);
  4663. // I/O (non-blocking capable)
  4664. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4665. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4666. int pending(const_session_t session);
  4667. void shutdown(session_t session, bool graceful);
  4668. // Connection state
  4669. bool is_peer_closed(session_t session, socket_t sock);
  4670. // Certificate verification
  4671. cert_t get_peer_cert(const_session_t session);
  4672. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4673. // do not use them after free_session(), as with get_peer_cert().
  4674. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4675. void free_cert(cert_t cert);
  4676. // Matches the host against the subjectAltName entries only, never the Common
  4677. // Name (RFC 9525).
  4678. bool verify_hostname(cert_t cert, const char *hostname);
  4679. uint64_t hostname_mismatch_code();
  4680. long get_verify_result(const_session_t session);
  4681. // Certificate introspection
  4682. std::string get_cert_subject_cn(cert_t cert);
  4683. std::string get_cert_issuer_name(cert_t cert);
  4684. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4685. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4686. std::string get_cert_serial(cert_t cert);
  4687. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4688. const char *get_sni(const_session_t session);
  4689. // CA store management
  4690. ca_store_t create_ca_store(const char *pem, size_t len);
  4691. void free_ca_store(ca_store_t store);
  4692. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4693. // Free each with free_cert(), and do not use them once the context's CA
  4694. // certificates change.
  4695. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4696. std::vector<std::string> get_ca_names(ctx_t ctx);
  4697. // Dynamic certificate update (for servers)
  4698. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4699. const char *password);
  4700. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4701. // Certificate verification callback
  4702. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4703. long get_verify_error(const_session_t session);
  4704. std::string verify_error_string(long error_code);
  4705. // TlsError information
  4706. uint64_t peek_error();
  4707. uint64_t get_error();
  4708. std::string error_string(uint64_t code);
  4709. } // namespace tls
  4710. #endif // CPPHTTPLIB_SSL_ENABLED
  4711. /*
  4712. * Group 1: detail namespace - Non-SSL utilities
  4713. */
  4714. namespace detail {
  4715. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4716. const void *optval, socklen_t optlen) {
  4717. return setsockopt(sock, level, optname,
  4718. #ifdef _WIN32
  4719. reinterpret_cast<const char *>(optval),
  4720. #else
  4721. optval,
  4722. #endif
  4723. optlen) == 0;
  4724. }
  4725. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4726. time_t sec, time_t usec) {
  4727. #ifdef _WIN32
  4728. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4729. #else
  4730. timeval timeout;
  4731. timeout.tv_sec = static_cast<long>(sec);
  4732. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4733. #endif
  4734. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4735. }
  4736. inline bool is_hex(char c, int &v) {
  4737. if (is_ascii_digit(c)) {
  4738. v = c - '0';
  4739. return true;
  4740. } else if ('A' <= c && c <= 'F') {
  4741. v = c - 'A' + 10;
  4742. return true;
  4743. } else if ('a' <= c && c <= 'f') {
  4744. v = c - 'a' + 10;
  4745. return true;
  4746. }
  4747. return false;
  4748. }
  4749. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4750. int &val) {
  4751. if (i >= s.size()) { return false; }
  4752. val = 0;
  4753. for (; cnt; i++, cnt--) {
  4754. if (!s[i]) { return false; }
  4755. auto v = 0;
  4756. if (is_hex(s[i], v)) {
  4757. val = val * 16 + v;
  4758. } else {
  4759. return false;
  4760. }
  4761. }
  4762. return true;
  4763. }
  4764. inline std::string from_i_to_hex(size_t n) {
  4765. static const auto charset = "0123456789abcdef";
  4766. std::string ret;
  4767. do {
  4768. ret = charset[n & 15] + ret;
  4769. n >>= 4;
  4770. } while (n > 0);
  4771. return ret;
  4772. }
  4773. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4774. // builds and trips -Wtautological-type-limit-compare.
  4775. inline bool fits_in_size_t(uint64_t n) {
  4776. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4777. }
  4778. inline std::string compute_etag(const FileStat &fs,
  4779. const std::string &suffix = std::string()) {
  4780. if (!fs.is_file()) { return std::string(); }
  4781. // If mtime cannot be determined (negative value indicates an error
  4782. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4783. // value like 0 could collide with a real file that legitimately has
  4784. // mtime == 0 (epoch) and lead to misleading validators.
  4785. auto mtime_raw = fs.mtime();
  4786. if (mtime_raw < 0) { return std::string(); }
  4787. auto mtime = static_cast<size_t>(mtime_raw);
  4788. auto size = fs.size();
  4789. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4790. from_i_to_hex(size) + suffix + "\"";
  4791. }
  4792. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4793. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4794. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4795. inline std::string file_mtime_to_http_date(time_t mtime) {
  4796. if (mtime < 0) { return std::string(); }
  4797. struct tm tm_buf;
  4798. #ifdef _WIN32
  4799. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4800. #else
  4801. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4802. #endif
  4803. char buf[64];
  4804. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4805. return std::string();
  4806. }
  4807. return std::string(buf);
  4808. }
  4809. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4810. inline time_t parse_http_date(const std::string &date_str) {
  4811. struct tm tm_buf;
  4812. // Create a classic locale object once for all parsing attempts
  4813. const std::locale classic_locale = std::locale::classic();
  4814. // Try to parse using std::get_time (C++11, cross-platform)
  4815. auto try_parse = [&](const char *fmt) -> bool {
  4816. std::istringstream ss(date_str);
  4817. ss.imbue(classic_locale);
  4818. memset(&tm_buf, 0, sizeof(tm_buf));
  4819. ss >> std::get_time(&tm_buf, fmt);
  4820. return !ss.fail();
  4821. };
  4822. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4823. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4824. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4825. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4826. // asctime format: "Sun Nov 6 08:49:37 1994"
  4827. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4828. return static_cast<time_t>(-1);
  4829. }
  4830. }
  4831. }
  4832. #ifdef _WIN32
  4833. return _mkgmtime(&tm_buf);
  4834. #elif defined _AIX
  4835. return mktime(&tm_buf);
  4836. #else
  4837. return timegm(&tm_buf);
  4838. #endif
  4839. }
  4840. inline bool is_weak_etag(const std::string &s) {
  4841. // Check if the string is a weak ETag (starts with 'W/"')
  4842. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4843. }
  4844. inline bool is_strong_etag(const std::string &s) {
  4845. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4846. // chars)
  4847. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4848. }
  4849. inline size_t to_utf8(int code, char *buff) {
  4850. if (code < 0x0080) {
  4851. buff[0] = static_cast<char>(code & 0x7F);
  4852. return 1;
  4853. } else if (code < 0x0800) {
  4854. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4855. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4856. return 2;
  4857. } else if (code < 0xD800) {
  4858. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4859. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4860. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4861. return 3;
  4862. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4863. return 0;
  4864. } else if (code < 0x10000) {
  4865. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4866. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4867. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4868. return 3;
  4869. } else if (code < 0x110000) {
  4870. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4871. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4872. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4873. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4874. return 4;
  4875. }
  4876. // NOTREACHED
  4877. return 0;
  4878. }
  4879. } // namespace detail
  4880. namespace ws {
  4881. namespace impl {
  4882. inline bool is_valid_utf8(const std::string &s) {
  4883. size_t i = 0;
  4884. auto n = s.size();
  4885. while (i < n) {
  4886. auto c = static_cast<unsigned char>(s[i]);
  4887. size_t len;
  4888. uint32_t cp;
  4889. if (c < 0x80) {
  4890. i++;
  4891. continue;
  4892. } else if ((c & 0xE0) == 0xC0) {
  4893. len = 2;
  4894. cp = c & 0x1F;
  4895. } else if ((c & 0xF0) == 0xE0) {
  4896. len = 3;
  4897. cp = c & 0x0F;
  4898. } else if ((c & 0xF8) == 0xF0) {
  4899. len = 4;
  4900. cp = c & 0x07;
  4901. } else {
  4902. return false;
  4903. }
  4904. if (i + len > n) { return false; }
  4905. for (size_t j = 1; j < len; j++) {
  4906. auto b = static_cast<unsigned char>(s[i + j]);
  4907. if ((b & 0xC0) != 0x80) { return false; }
  4908. cp = (cp << 6) | (b & 0x3F);
  4909. }
  4910. // Overlong encoding check
  4911. if (len == 2 && cp < 0x80) { return false; }
  4912. if (len == 3 && cp < 0x800) { return false; }
  4913. if (len == 4 && cp < 0x10000) { return false; }
  4914. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4915. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4916. if (cp > 0x10FFFF) { return false; }
  4917. i += len;
  4918. }
  4919. return true;
  4920. }
  4921. } // namespace impl
  4922. } // namespace ws
  4923. namespace detail {
  4924. // NOTE: This code came up with the following stackoverflow post:
  4925. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4926. inline std::string base64_encode(const std::string &in) {
  4927. static const auto lookup =
  4928. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4929. std::string out;
  4930. out.reserve(in.size());
  4931. // Unsigned: the accumulator is never masked, so with a signed int the
  4932. // `val << 8` below overflows once enough bytes are folded in (undefined
  4933. // behaviour before C++20). Only the low bits are ever emitted, so the
  4934. // wrap-around of an unsigned accumulator does not affect the output.
  4935. uint32_t val = 0;
  4936. auto valb = -6;
  4937. for (auto c : in) {
  4938. val = (val << 8) + static_cast<uint8_t>(c);
  4939. valb += 8;
  4940. while (valb >= 0) {
  4941. out.push_back(lookup[(val >> valb) & 0x3F]);
  4942. valb -= 6;
  4943. }
  4944. }
  4945. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4946. while (out.size() % 4) {
  4947. out.push_back('=');
  4948. }
  4949. return out;
  4950. }
  4951. inline std::string sha1(const std::string &input) {
  4952. // RFC 3174 SHA-1 implementation
  4953. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4954. return (x << n) | (x >> (32 - n));
  4955. };
  4956. uint32_t h0 = 0x67452301;
  4957. uint32_t h1 = 0xEFCDAB89;
  4958. uint32_t h2 = 0x98BADCFE;
  4959. uint32_t h3 = 0x10325476;
  4960. uint32_t h4 = 0xC3D2E1F0;
  4961. // Pre-processing: adding padding bits
  4962. std::string msg = input;
  4963. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4964. msg.push_back(static_cast<char>(0x80u));
  4965. while (msg.size() % 64 != 56) {
  4966. msg.push_back(0);
  4967. }
  4968. // Append original length in bits as 64-bit big-endian
  4969. for (int i = 56; i >= 0; i -= 8) {
  4970. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4971. }
  4972. // Process each 512-bit chunk
  4973. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4974. uint32_t w[80];
  4975. for (size_t i = 0; i < 16; i++) {
  4976. w[i] =
  4977. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4978. << 24) |
  4979. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4980. << 16) |
  4981. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4982. << 8) |
  4983. (static_cast<uint32_t>(
  4984. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4985. }
  4986. for (int i = 16; i < 80; i++) {
  4987. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4988. }
  4989. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4990. for (int i = 0; i < 80; i++) {
  4991. uint32_t f, k;
  4992. if (i < 20) {
  4993. f = (b & c) | ((~b) & d);
  4994. k = 0x5A827999;
  4995. } else if (i < 40) {
  4996. f = b ^ c ^ d;
  4997. k = 0x6ED9EBA1;
  4998. } else if (i < 60) {
  4999. f = (b & c) | (b & d) | (c & d);
  5000. k = 0x8F1BBCDC;
  5001. } else {
  5002. f = b ^ c ^ d;
  5003. k = 0xCA62C1D6;
  5004. }
  5005. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  5006. e = d;
  5007. d = c;
  5008. c = left_rotate(b, 30);
  5009. b = a;
  5010. a = temp;
  5011. }
  5012. h0 += a;
  5013. h1 += b;
  5014. h2 += c;
  5015. h3 += d;
  5016. h4 += e;
  5017. }
  5018. // Produce the final hash as a 20-byte binary string
  5019. std::string hash(20, '\0');
  5020. for (size_t i = 0; i < 4; i++) {
  5021. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  5022. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  5023. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  5024. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  5025. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  5026. }
  5027. return hash;
  5028. }
  5029. inline std::string websocket_accept_key(const std::string &client_key) {
  5030. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  5031. return base64_encode(sha1(client_key + magic));
  5032. }
  5033. inline bool is_websocket_upgrade(const Request &req) {
  5034. if (req.method != "GET") { return false; }
  5035. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  5036. // list of protocols and asks recipients to match each name
  5037. // case-insensitively, so look for the token rather than compare the whole
  5038. // field value.
  5039. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  5040. // Check Connection: Upgrade
  5041. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  5042. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  5043. // RFC 6455 Section 4.2.1
  5044. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  5045. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  5046. return false;
  5047. }
  5048. static const std::string b64chars =
  5049. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  5050. for (size_t i = 0; i < 22; i++) {
  5051. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  5052. }
  5053. // Check Sec-WebSocket-Version: 13
  5054. auto version = req.get_header_value("Sec-WebSocket-Version");
  5055. if (version != "13") { return false; }
  5056. return true;
  5057. }
  5058. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  5059. inline void fill_random_bytes(unsigned char *out, size_t n) {
  5060. thread_local std::random_device rd;
  5061. size_t filled = 0;
  5062. while (filled < n) {
  5063. auto v = rd();
  5064. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  5065. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  5066. }
  5067. }
  5068. }
  5069. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  5070. const char *data, size_t len, bool fin,
  5071. bool mask) {
  5072. // The header (FIN + opcode, MASK + length, the extended length, the mask
  5073. // key: 14 bytes at most) goes out in one write with the payload's first
  5074. // chunk, so that under TCP_NODELAY a small frame is one segment, not three.
  5075. uint8_t header[14];
  5076. size_t header_len = 0;
  5077. header[header_len++] = static_cast<uint8_t>(
  5078. (fin ? 0x80 : 0x00) | (static_cast<uint8_t>(opcode) & 0x0F));
  5079. uint8_t mask_bit = mask ? 0x80 : 0x00;
  5080. if (len < 126) {
  5081. header[header_len++] = static_cast<uint8_t>(len) | mask_bit;
  5082. } else if (len <= 0xFFFF) {
  5083. header[header_len++] = 126 | mask_bit;
  5084. header[header_len++] = static_cast<uint8_t>((len >> 8) & 0xFF);
  5085. header[header_len++] = static_cast<uint8_t>(len & 0xFF);
  5086. } else {
  5087. header[header_len++] = 127 | mask_bit;
  5088. for (int i = 7; i >= 0; i--) {
  5089. header[header_len++] =
  5090. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  5091. }
  5092. }
  5093. uint8_t mask_key[4] = {0};
  5094. if (mask) {
  5095. fill_random_bytes(mask_key, sizeof(mask_key));
  5096. std::copy(mask_key, mask_key + 4, header + header_len);
  5097. header_len += 4;
  5098. }
  5099. // `n` bytes of the payload from `offset`, masked if they are to be, at `out`
  5100. auto put = [&](char *out, size_t offset, size_t n) {
  5101. for (size_t i = 0; i < n; i++) {
  5102. out[i] = mask ? data[offset + i] ^
  5103. static_cast<char>(mask_key[(offset + i) % 4])
  5104. : data[offset + i];
  5105. }
  5106. };
  5107. const size_t chunk_size = 4096;
  5108. size_t first = (std::min)(len, chunk_size);
  5109. std::vector<char> buf(header_len + first);
  5110. std::copy(header, header + header_len, buf.begin());
  5111. put(buf.data() + header_len, 0, first);
  5112. if (!write_data(strm, buf.data(), buf.size())) { return false; }
  5113. // The rest, masked a chunk at a time, or else as it is
  5114. if (!mask) {
  5115. return first == len || write_data(strm, data + first, len - first);
  5116. }
  5117. for (size_t offset = first; offset < len; offset += chunk_size) {
  5118. size_t n = (std::min)(chunk_size, len - offset);
  5119. put(buf.data(), offset, n);
  5120. if (!write_data(strm, buf.data(), n)) { return false; }
  5121. }
  5122. return true;
  5123. }
  5124. } // namespace detail
  5125. namespace ws {
  5126. namespace impl {
  5127. inline void FrameReader::reset() {
  5128. have_ = 0;
  5129. need_ = 2;
  5130. sized_ = false;
  5131. len_ = 0;
  5132. payload_.clear();
  5133. }
  5134. // Stream::read may return less than asked for -- it hands back whatever its
  5135. // buffer already holds -- so each part of the frame is read in a loop, a byte
  5136. // at a time if that is how it comes. (When read() fails it always records why,
  5137. // so the error belongs to this call and not to an earlier one.)
  5138. inline FrameRead FrameReader::read(Stream &strm, Opcode &opcode,
  5139. std::string &payload, bool &fin,
  5140. bool expect_masked, size_t max_len) {
  5141. // A timeout keeps what was read; anything else ends the frame
  5142. auto stopped = [&]() {
  5143. if (strm.get_error() == Error::Timeout) { return FrameRead::Timeout; }
  5144. reset();
  5145. return FrameRead::Fail;
  5146. };
  5147. auto fail = [&]() {
  5148. reset();
  5149. return FrameRead::Fail;
  5150. };
  5151. while (have_ < need_) {
  5152. auto n = strm.read(reinterpret_cast<char *>(head_) + have_, need_ - have_);
  5153. if (n <= 0) { return stopped(); }
  5154. have_ += static_cast<size_t>(n);
  5155. if (have_ < 2 || need_ > 2) { continue; }
  5156. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  5157. if (head_[0] & 0x70) { return fail(); }
  5158. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  5159. // MUST have a payload length of 125 bytes or less
  5160. auto len7 = head_[1] & 0x7F;
  5161. if ((head_[0] & 0x08) && (!(head_[0] & 0x80) || len7 > 125)) {
  5162. return fail();
  5163. }
  5164. auto masked = (head_[1] & 0x80) != 0;
  5165. if (masked != expect_masked) { return fail(); }
  5166. // The extended length and the mask key follow
  5167. need_ = 2 + (len7 == 126 ? 2 : len7 == 127 ? 8 : 0) + (masked ? 4 : 0);
  5168. }
  5169. if (!sized_) {
  5170. uint64_t len = head_[1] & 0x7F;
  5171. if (len == 126) {
  5172. len = (static_cast<uint64_t>(head_[2]) << 8) | head_[3];
  5173. } else if (len == 127) {
  5174. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  5175. if (head_[2] & 0x80) { return fail(); }
  5176. len = 0;
  5177. for (size_t i = 2; i < 10; i++) {
  5178. len = (len << 8) | head_[i];
  5179. }
  5180. }
  5181. // A max_len of 0 means no limit, as payload_max_length does, and a length
  5182. // size_t cannot hold (32-bit builds) is refused either way.
  5183. if ((max_len > 0 && len > max_len) || !detail::fits_in_size_t(len)) {
  5184. return fail();
  5185. }
  5186. len_ = static_cast<size_t>(len);
  5187. sized_ = true;
  5188. }
  5189. // Grow the payload only as it arrives, since a header alone can announce
  5190. // max_len bytes that never come.
  5191. while (payload_.size() < len_) {
  5192. auto offset = payload_.size();
  5193. auto n = (std::min)(len_ - offset, CPPHTTPLIB_RECV_BUFSIZ);
  5194. payload_.resize(offset + n);
  5195. auto got = strm.read(&payload_[offset], n);
  5196. if (got <= 0) {
  5197. payload_.resize(offset);
  5198. return stopped();
  5199. }
  5200. payload_.resize(offset + static_cast<size_t>(got));
  5201. }
  5202. if (head_[1] & 0x80) {
  5203. const auto *mask_key = head_ + need_ - 4;
  5204. for (size_t i = 0; i < payload_.size(); i++) {
  5205. payload_[i] ^= static_cast<char>(mask_key[i % 4]);
  5206. }
  5207. }
  5208. fin = (head_[0] & 0x80) != 0;
  5209. opcode = static_cast<Opcode>(head_[0] & 0x0F);
  5210. payload = std::move(payload_);
  5211. reset();
  5212. return FrameRead::Ok;
  5213. }
  5214. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  5215. std::string &payload, bool &fin,
  5216. bool expect_masked, size_t max_len) {
  5217. FrameReader reader;
  5218. auto r = reader.read(strm, opcode, payload, fin, expect_masked, max_len);
  5219. return r == FrameRead::Timeout && reader.begun() ? FrameRead::Fail : r;
  5220. }
  5221. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  5222. // be sent followed by a UTF-8 reason.
  5223. inline bool is_valid_close_payload(const std::string &payload) {
  5224. if (payload.empty()) { return true; }
  5225. if (payload.size() < 2) { return false; }
  5226. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  5227. static_cast<uint8_t>(payload[1]);
  5228. auto may_be_sent = (1000 <= code && code <= 1003) ||
  5229. (1007 <= code && code <= 1014) ||
  5230. (3000 <= code && code <= 4999);
  5231. return may_be_sent && is_valid_utf8(payload.substr(2));
  5232. }
  5233. } // namespace impl
  5234. } // namespace ws
  5235. namespace detail {
  5236. // A path a mount point serves: absolute, with no empty segment except a
  5237. // trailing '/', no segment ending in '.' or a space (which covers "." and
  5238. // ".." and names Windows trims into another file's name) and, on Windows, no
  5239. // ':' (which names an NTFS stream, so "a.txt::$DATA" is a.txt), so the file
  5240. // served is the one that req.path names to the handlers that ran before it.
  5241. inline bool is_valid_path(const std::string &path) {
  5242. if (path.empty() || path[0] != '/') { return false; }
  5243. auto beg = size_t{1};
  5244. for (auto i = beg; i <= path.size(); i++) {
  5245. if (i < path.size() && path[i] != '/') {
  5246. if (path[i] == '\0' || path[i] == '\\') { return false; }
  5247. #ifdef _WIN32
  5248. if (path[i] == ':') { return false; }
  5249. #endif
  5250. continue;
  5251. }
  5252. auto len = i - beg;
  5253. if ((len == 0 && i < path.size()) ||
  5254. (len > 0 && (path[i - 1] == '.' || path[i - 1] == ' '))) {
  5255. return false;
  5256. }
  5257. beg = i + 1;
  5258. }
  5259. return true;
  5260. }
  5261. inline bool canonicalize_path(const char *path, std::string &resolved) {
  5262. #if defined(_WIN32)
  5263. // Resolve junctions and symlinks, as realpath() does
  5264. auto wpath = u8string_to_wstring(path);
  5265. if (wpath.empty()) { return false; }
  5266. CREATEFILE2_EXTENDED_PARAMETERS params{};
  5267. params.dwSize = sizeof(params);
  5268. params.dwFileFlags = FILE_FLAG_BACKUP_SEMANTICS; // Needed to open a directory
  5269. auto h = ::CreateFile2(wpath.c_str(), 0,
  5270. FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
  5271. OPEN_EXISTING, &params);
  5272. if (h == INVALID_HANDLE_VALUE) { return false; }
  5273. auto guard = scope_exit([&]() { ::CloseHandle(h); });
  5274. std::wstring wbuf(MAX_PATH, L'\0');
  5275. auto len = ::GetFinalPathNameByHandleW(
  5276. h, &wbuf[0], static_cast<DWORD>(wbuf.size()), FILE_NAME_NORMALIZED);
  5277. if (len >= wbuf.size()) {
  5278. wbuf.resize(len);
  5279. len = ::GetFinalPathNameByHandleW(
  5280. h, &wbuf[0], static_cast<DWORD>(wbuf.size()), FILE_NAME_NORMALIZED);
  5281. }
  5282. if (len == 0 || len >= wbuf.size()) { return false; }
  5283. auto n = ::WideCharToMultiByte(CP_UTF8, 0, wbuf.data(), static_cast<int>(len),
  5284. nullptr, 0, nullptr, nullptr);
  5285. if (n <= 0) { return false; }
  5286. resolved.assign(static_cast<size_t>(n), '\0');
  5287. ::WideCharToMultiByte(CP_UTF8, 0, wbuf.data(), static_cast<int>(len),
  5288. &resolved[0], n, nullptr, nullptr);
  5289. #elif defined(PATH_MAX)
  5290. char buf[PATH_MAX];
  5291. if (realpath(path, buf) == nullptr) { return false; }
  5292. resolved = buf;
  5293. #else
  5294. auto buf = realpath(path, nullptr);
  5295. auto guard = scope_exit([&]() { std::free(buf); });
  5296. if (buf == nullptr) { return false; }
  5297. resolved = buf;
  5298. #endif
  5299. return true;
  5300. }
  5301. inline bool is_path_within_base(const std::string &resolved_path,
  5302. const std::string &resolved_base) {
  5303. #if defined(_WIN32)
  5304. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  5305. resolved_base.size()) == 0;
  5306. #else
  5307. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  5308. resolved_base.size()) == 0;
  5309. #endif
  5310. }
  5311. inline FileStat::FileStat(const std::string &path) {
  5312. #if defined(_WIN32)
  5313. auto wpath = u8string_to_wstring(path.c_str());
  5314. ret_ = _wstat(wpath.c_str(), &st_);
  5315. #else
  5316. ret_ = stat(path.c_str(), &st_);
  5317. #endif
  5318. }
  5319. inline bool FileStat::is_file() const {
  5320. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5321. }
  5322. inline bool FileStat::is_dir() const {
  5323. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5324. }
  5325. inline time_t FileStat::mtime() const {
  5326. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5327. : static_cast<time_t>(-1);
  5328. }
  5329. inline size_t FileStat::size() const {
  5330. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5331. }
  5332. inline std::string encode_path(const std::string &s) {
  5333. std::string result;
  5334. result.reserve(s.size());
  5335. for (size_t i = 0; s[i]; i++) {
  5336. switch (s[i]) {
  5337. case ' ': result += "%20"; break;
  5338. case '+': result += "%2B"; break;
  5339. case '\'': result += "%27"; break;
  5340. case ',': result += "%2C"; break;
  5341. // case ':': result += "%3A"; break; // ok? probably...
  5342. case ';': result += "%3B"; break;
  5343. default:
  5344. auto c = static_cast<uint8_t>(s[i]);
  5345. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5346. // in a request-target as-is.
  5347. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5348. result += '%';
  5349. char hex[4];
  5350. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5351. assert(len == 2);
  5352. result.append(hex, static_cast<size_t>(len));
  5353. } else {
  5354. result += s[i];
  5355. }
  5356. break;
  5357. }
  5358. }
  5359. return result;
  5360. }
  5361. inline std::string file_extension(const std::string &path) {
  5362. auto i = path.size();
  5363. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5364. i--;
  5365. }
  5366. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5367. return std::string();
  5368. }
  5369. return path.substr(i);
  5370. }
  5371. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5372. template <typename T>
  5373. inline bool parse_header(const char *beg, const char *end, T fn);
  5374. template <typename T>
  5375. inline bool parse_header(const char *beg, const char *end, T fn) {
  5376. // Skip trailing spaces and tabs.
  5377. while (beg < end && is_space_or_tab(end[-1])) {
  5378. end--;
  5379. }
  5380. auto p = beg;
  5381. while (p < end && *p != ':') {
  5382. p++;
  5383. }
  5384. auto name = std::string(beg, p);
  5385. if (!detail::fields::is_field_name(name)) { return false; }
  5386. if (p == end) { return false; }
  5387. auto key_end = p;
  5388. if (*p++ != ':') { return false; }
  5389. while (p < end && is_space_or_tab(*p)) {
  5390. p++;
  5391. }
  5392. if (p <= end) {
  5393. auto key_len = key_end - beg;
  5394. if (!key_len) { return false; }
  5395. auto key = std::string(beg, key_end);
  5396. auto val = std::string(p, end);
  5397. if (!detail::fields::is_field_value(val)) { return false; }
  5398. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5399. // percent-decoded by the recipient. Applications that need to interpret a
  5400. // value as a URI component should call httplib::decode_uri_component()
  5401. // (or decode_path_component()) explicitly.
  5402. fn(key, val);
  5403. return true;
  5404. }
  5405. return false;
  5406. }
  5407. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5408. const Headers &src_headers) {
  5409. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5410. // transfer coding is complete when a chunk with a chunk-size of zero is
  5411. // received, possibly followed by a trailer section, and finally terminated by
  5412. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5413. //
  5414. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5415. // doesn't care for the existence of the final CRLF. In other words, it seems
  5416. // to be ok whether the final CRLF exists or not in the chunked data.
  5417. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5418. //
  5419. // According to the reference code in RFC 9112, cpp-httplib now allows
  5420. // chunked transfer coding data without the final CRLF.
  5421. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5422. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5423. "transfer-encoding",
  5424. "content-length",
  5425. "host",
  5426. "authorization",
  5427. "www-authenticate",
  5428. "proxy-authenticate",
  5429. "proxy-authorization",
  5430. "cookie",
  5431. "set-cookie",
  5432. "cache-control",
  5433. "expect",
  5434. "max-forwards",
  5435. "pragma",
  5436. "range",
  5437. "te",
  5438. "age",
  5439. "expires",
  5440. "date",
  5441. "location",
  5442. "retry-after",
  5443. "vary",
  5444. "warning",
  5445. "content-encoding",
  5446. "content-type",
  5447. "content-range",
  5448. "trailer"};
  5449. case_ignore::unordered_set<std::string> declared_trailers;
  5450. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5451. if (!trailer_header.empty()) {
  5452. // split() trims each token and skips empty ones, so the name arrives ready
  5453. // to look up.
  5454. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5455. ',', [&](const char *b, const char *e) {
  5456. // A legitimate message declares only a handful of trailers. Cap the
  5457. // set so a peer cannot grow it without bound: an oversized set only
  5458. // arises from an attempt to force many colliding names into
  5459. // quadratic lookups (case_ignore::hash is unkeyed).
  5460. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5461. return;
  5462. }
  5463. std::string key(b, e);
  5464. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5465. declared_trailers.insert(key);
  5466. }
  5467. });
  5468. }
  5469. size_t trailer_header_count = 0;
  5470. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5471. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5472. // Count every received trailer field, not only the declared ones stored in
  5473. // dest, so undeclared fields cannot keep this loop running past the limit.
  5474. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5475. constexpr auto line_terminator_len = 2;
  5476. auto line_beg = line_reader.ptr();
  5477. auto line_end =
  5478. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5479. if (!parse_header(line_beg, line_end,
  5480. [&](const std::string &key, const std::string &val) {
  5481. if (declared_trailers.find(key) !=
  5482. declared_trailers.end()) {
  5483. dest.emplace(key, val);
  5484. }
  5485. })) {
  5486. return false;
  5487. }
  5488. trailer_header_count++;
  5489. if (!line_reader.getline()) { return false; }
  5490. }
  5491. return true;
  5492. }
  5493. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5494. size_t right) {
  5495. while (b + left < e && is_space_or_tab(b[left])) {
  5496. left++;
  5497. }
  5498. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5499. right--;
  5500. }
  5501. return std::make_pair(left, right);
  5502. }
  5503. inline std::string trim_copy(const std::string &s) {
  5504. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5505. return s.substr(r.first, r.second - r.first);
  5506. }
  5507. inline std::string trim_double_quotes_copy(const std::string &s) {
  5508. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5509. return s.substr(1, s.size() - 2);
  5510. }
  5511. return s;
  5512. }
  5513. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5514. // here, as browsers send any other backslash, such as one in a Windows path,
  5515. // as it is.
  5516. inline std::string unquote_param(const std::string &s) {
  5517. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5518. std::string out;
  5519. for (size_t i = 1; i + 1 < s.size(); i++) {
  5520. if (s[i] == '\\' && i + 2 < s.size() &&
  5521. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5522. i++;
  5523. }
  5524. out += s[i];
  5525. }
  5526. return out;
  5527. }
  5528. inline void
  5529. divide(const char *data, std::size_t size, char d,
  5530. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5531. fn) {
  5532. const auto it = std::find(data, data + size, d);
  5533. const auto found = static_cast<std::size_t>(it != data + size);
  5534. const auto lhs_data = data;
  5535. const auto lhs_size = static_cast<std::size_t>(it - data);
  5536. const auto rhs_data = it + found;
  5537. const auto rhs_size = size - lhs_size - found;
  5538. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5539. }
  5540. inline void
  5541. divide(const std::string &str, char d,
  5542. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5543. fn) {
  5544. divide(str.data(), str.size(), d, std::move(fn));
  5545. }
  5546. inline void split(const char *b, const char *e, char d,
  5547. std::function<void(const char *, const char *)> fn) {
  5548. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5549. }
  5550. inline void split(const char *b, const char *e, char d, size_t m,
  5551. std::function<void(const char *, const char *)> fn) {
  5552. size_t i = 0;
  5553. size_t beg = 0;
  5554. size_t count = 1;
  5555. while (e ? (b + i < e) : (b[i] != '\0')) {
  5556. if (b[i] == d && count < m) {
  5557. auto r = trim(b, e, beg, i);
  5558. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5559. beg = i + 1;
  5560. count++;
  5561. }
  5562. i++;
  5563. }
  5564. if (i) {
  5565. auto r = trim(b, e, beg, i);
  5566. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5567. }
  5568. }
  5569. // Same contract as split(), except that a delimiter inside a quoted-string is
  5570. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5571. // quoted-string, and ';' and '=' are legal characters inside one.
  5572. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5573. std::function<void(const char *, const char *)> fn) {
  5574. size_t i = 0;
  5575. size_t beg = 0;
  5576. size_t count = 1;
  5577. auto in_quotes = false;
  5578. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5579. while (has(i)) {
  5580. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5581. // A quoted-pair, whose second character does not end the string.
  5582. i++;
  5583. } else if (b[i] == '"') {
  5584. in_quotes = !in_quotes;
  5585. } else if (b[i] == d && !in_quotes && count < m) {
  5586. auto r = trim(b, e, beg, i);
  5587. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5588. beg = i + 1;
  5589. count++;
  5590. }
  5591. i++;
  5592. }
  5593. if (i) {
  5594. auto r = trim(b, e, beg, i);
  5595. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5596. }
  5597. }
  5598. inline void split_unquoted(const char *b, const char *e, char d,
  5599. std::function<void(const char *, const char *)> fn) {
  5600. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5601. std::move(fn));
  5602. }
  5603. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5604. // key a token, so the first '=' is the separator even when the value is a
  5605. // quoted-string carrying more of them.
  5606. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5607. std::string &val) {
  5608. divide(
  5609. b, static_cast<std::size_t>(e - b), '=',
  5610. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5611. const auto kr = trim(kb, kb + klen, 0, klen);
  5612. key.assign(kb + kr.first, kb + kr.second);
  5613. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5614. val.assign(vb + vr.first, vb + vr.second);
  5615. });
  5616. }
  5617. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5618. std::function<bool(const char *, const char *)> fn) {
  5619. size_t i = 0;
  5620. size_t beg = 0;
  5621. size_t count = 1;
  5622. while (e ? (b + i < e) : (b[i] != '\0')) {
  5623. if (b[i] == d && count < m) {
  5624. auto r = trim(b, e, beg, i);
  5625. if (r.first < r.second) {
  5626. auto found = fn(&b[r.first], &b[r.second]);
  5627. if (found) { return true; }
  5628. }
  5629. beg = i + 1;
  5630. count++;
  5631. }
  5632. i++;
  5633. }
  5634. if (i) {
  5635. auto r = trim(b, e, beg, i);
  5636. if (r.first < r.second) {
  5637. auto found = fn(&b[r.first], &b[r.second]);
  5638. if (found) { return true; }
  5639. }
  5640. }
  5641. return false;
  5642. }
  5643. inline bool split_find(const char *b, const char *e, char d,
  5644. std::function<bool(const char *, const char *)> fn) {
  5645. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5646. std::move(fn));
  5647. }
  5648. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5649. size_t fixed_buffer_size)
  5650. : strm_(strm), fixed_buffer_(fixed_buffer),
  5651. fixed_buffer_size_(fixed_buffer_size) {}
  5652. inline const char *stream_line_reader::ptr() const {
  5653. if (growable_buffer_.empty()) {
  5654. return fixed_buffer_;
  5655. } else {
  5656. return growable_buffer_.data();
  5657. }
  5658. }
  5659. inline size_t stream_line_reader::size() const {
  5660. if (growable_buffer_.empty()) {
  5661. return fixed_buffer_used_size_;
  5662. } else {
  5663. return growable_buffer_.size();
  5664. }
  5665. }
  5666. inline bool stream_line_reader::end_with_crlf() const {
  5667. auto end = ptr() + size();
  5668. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5669. }
  5670. inline bool stream_line_reader::getline() {
  5671. fixed_buffer_used_size_ = 0;
  5672. growable_buffer_.clear();
  5673. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5674. char prev_byte = 0;
  5675. #endif
  5676. for (size_t i = 0;; i++) {
  5677. // Fast path: whatever the stream has already buffered can be scanned for
  5678. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5679. // call, a bounds check and a one-byte copy per character of the request.
  5680. size_t buffered_size = 0;
  5681. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5682. auto take = buffered_size;
  5683. auto terminated = false;
  5684. for (size_t at = 0; at < buffered_size;) {
  5685. auto nl = static_cast<const char *>(
  5686. memchr(buffered + at, '\n', buffered_size - at));
  5687. if (!nl) { break; }
  5688. auto pos = static_cast<size_t>(nl - buffered);
  5689. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5690. take = pos + 1;
  5691. terminated = true;
  5692. break;
  5693. #else
  5694. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5695. // be the last byte of an earlier chunk, hence prev_byte.
  5696. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5697. take = pos + 1;
  5698. terminated = true;
  5699. break;
  5700. }
  5701. at = pos + 1;
  5702. #endif
  5703. }
  5704. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5705. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5706. prev_byte = buffered[take - 1];
  5707. #endif
  5708. append(buffered, take);
  5709. strm_.consume_buffered(take);
  5710. i += take;
  5711. if (terminated) { return true; }
  5712. continue;
  5713. }
  5714. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5715. // Treat exceptionally long lines as an error to
  5716. // prevent infinite loops/memory exhaustion
  5717. return false;
  5718. }
  5719. char byte;
  5720. auto n = strm_.read(&byte, 1);
  5721. if (n < 0) {
  5722. return false;
  5723. } else if (n == 0) {
  5724. if (i == 0) {
  5725. return false;
  5726. } else {
  5727. break;
  5728. }
  5729. }
  5730. append(byte);
  5731. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5732. if (byte == '\n') { break; }
  5733. #else
  5734. if (prev_byte == '\r' && byte == '\n') { break; }
  5735. prev_byte = byte;
  5736. #endif
  5737. }
  5738. return true;
  5739. }
  5740. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5741. inline void stream_line_reader::append(const char *data, size_t size) {
  5742. // Once the line has outgrown the fixed buffer everything must keep going to
  5743. // the growable one, even if a later chunk would have fit. Without the
  5744. // emptiness check a short append after a long one would land in the fixed
  5745. // buffer, which ptr() and size() no longer look at, and be lost.
  5746. if (growable_buffer_.empty() &&
  5747. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5748. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5749. fixed_buffer_used_size_ += size;
  5750. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5751. } else {
  5752. // Unlike the per-character overload, this can be the very first append of
  5753. // the line, so the fixed buffer may hold nothing and carry no terminator
  5754. // yet. assign() takes an explicit length and does not need one.
  5755. if (growable_buffer_.empty()) {
  5756. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5757. }
  5758. growable_buffer_.append(data, size);
  5759. }
  5760. }
  5761. inline mmap::mmap(const char *path) { open(path); }
  5762. inline mmap::~mmap() { close(); }
  5763. inline bool mmap::open(const char *path) {
  5764. close();
  5765. #if defined(_WIN32)
  5766. auto wpath = u8string_to_wstring(path);
  5767. if (wpath.empty()) { return false; }
  5768. hFile_ =
  5769. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5770. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5771. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5772. LARGE_INTEGER size{};
  5773. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5774. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5775. // See:
  5776. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5777. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5778. size_ = static_cast<size_t>(size.QuadPart);
  5779. hMapping_ =
  5780. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5781. // Special treatment for an empty file...
  5782. if (hMapping_ == NULL && size_ == 0) {
  5783. close();
  5784. is_open_empty_file = true;
  5785. return true;
  5786. }
  5787. if (hMapping_ == NULL) {
  5788. close();
  5789. return false;
  5790. }
  5791. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5792. if (addr_ == nullptr) {
  5793. close();
  5794. return false;
  5795. }
  5796. #else
  5797. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5798. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5799. if (fd_ == -1) { return false; }
  5800. // Only a regular file has a size to serve, unlike a directory or a device.
  5801. struct stat sb;
  5802. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5803. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5804. close();
  5805. return false;
  5806. }
  5807. size_ = static_cast<size_t>(sb.st_size);
  5808. #endif
  5809. return true;
  5810. }
  5811. inline bool mmap::is_open() const {
  5812. #if defined(_WIN32)
  5813. return is_open_empty_file ? true : addr_ != nullptr;
  5814. #else
  5815. return fd_ != -1;
  5816. #endif
  5817. }
  5818. inline size_t mmap::size() const { return size_; }
  5819. inline void mmap::close() {
  5820. #if defined(_WIN32)
  5821. if (addr_) {
  5822. ::UnmapViewOfFile(addr_);
  5823. addr_ = nullptr;
  5824. }
  5825. if (hMapping_) {
  5826. ::CloseHandle(hMapping_);
  5827. hMapping_ = NULL;
  5828. }
  5829. if (hFile_ != INVALID_HANDLE_VALUE) {
  5830. ::CloseHandle(hFile_);
  5831. hFile_ = INVALID_HANDLE_VALUE;
  5832. }
  5833. is_open_empty_file = false;
  5834. #else
  5835. if (fd_ != -1) {
  5836. ::close(fd_);
  5837. fd_ = -1;
  5838. }
  5839. #endif
  5840. size_ = 0;
  5841. }
  5842. inline int close_socket(socket_t sock) noexcept {
  5843. #ifdef _WIN32
  5844. return closesocket(sock);
  5845. #else
  5846. return close(sock);
  5847. #endif
  5848. }
  5849. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5850. ssize_t res = 0;
  5851. while (true) {
  5852. res = fn();
  5853. if (res < 0 && errno == EINTR) {
  5854. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5855. continue;
  5856. }
  5857. break;
  5858. }
  5859. return res;
  5860. }
  5861. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5862. if (offset >= size_) { return 0; }
  5863. len = (std::min)(len, size_ - offset);
  5864. #if defined(_WIN32)
  5865. // Windows does not let a mapped file be truncated.
  5866. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5867. return len;
  5868. #else
  5869. auto n = handle_EINTR(
  5870. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5871. return n > 0 ? static_cast<size_t>(n) : 0;
  5872. #endif
  5873. }
  5874. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5875. return handle_EINTR([&]() {
  5876. return recv(sock,
  5877. #ifdef _WIN32
  5878. static_cast<char *>(ptr), static_cast<int>(size),
  5879. #else
  5880. ptr, size,
  5881. #endif
  5882. flags);
  5883. });
  5884. }
  5885. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5886. int flags) {
  5887. return handle_EINTR([&]() {
  5888. return send(sock,
  5889. #ifdef _WIN32
  5890. static_cast<const char *>(ptr), static_cast<int>(size),
  5891. #else
  5892. ptr, size,
  5893. #endif
  5894. flags);
  5895. });
  5896. }
  5897. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5898. #ifdef _WIN32
  5899. return ::WSAPoll(fds, nfds, timeout);
  5900. #else
  5901. return ::poll(fds, nfds, timeout);
  5902. #endif
  5903. }
  5904. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5905. time_t usec) {
  5906. struct pollfd pfd;
  5907. pfd.fd = sock;
  5908. pfd.events = events;
  5909. pfd.revents = 0;
  5910. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5911. // "return immediately", which callers here rely on to probe a socket.
  5912. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5913. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5914. }
  5915. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5916. return select_impl(sock, POLLIN, sec, usec);
  5917. }
  5918. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5919. return select_impl(sock, POLLOUT, sec, usec);
  5920. }
  5921. // The point sec and usec from now, for select_until(). A negative sec, or one
  5922. // past what the clock reaches, never comes.
  5923. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5924. time_t usec) {
  5925. auto now = std::chrono::steady_clock::now();
  5926. auto never = (std::chrono::steady_clock::time_point::max)();
  5927. if (sec < 0 ||
  5928. sec >= std::chrono::duration_cast<std::chrono::seconds>(never - now)
  5929. .count()) {
  5930. return never;
  5931. }
  5932. return now + std::chrono::seconds(sec) + std::chrono::microseconds(usec);
  5933. }
  5934. // Waits only for the time left until deadline, so that all the waits of one
  5935. // TLS handshake come out of a single timeout. With interrupted, it waits in
  5936. // slices and gives up once interrupted() returns true, as a local shutdown()
  5937. // would not wake the wait on Windows.
  5938. inline ssize_t
  5939. select_until(socket_t sock, short events,
  5940. std::chrono::steady_clock::time_point deadline,
  5941. const std::function<bool()> &interrupted = nullptr) {
  5942. if (!interrupted) {
  5943. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5944. return select_impl(sock, events, -1, 0);
  5945. }
  5946. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5947. deadline - std::chrono::steady_clock::now())
  5948. .count();
  5949. if (left <= 0) { return 0; }
  5950. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5951. static_cast<time_t>(left % 1000000));
  5952. }
  5953. const auto slice = std::chrono::microseconds(100000);
  5954. while (!interrupted()) {
  5955. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5956. deadline - std::chrono::steady_clock::now());
  5957. auto last = left < slice;
  5958. // poll() takes whole milliseconds, so round the last wait up to keep it
  5959. // from ending before the deadline.
  5960. auto wait_usec = last ? (std::max)((left.count() + 999) / 1000 * 1000,
  5961. static_cast<decltype(left.count())>(0))
  5962. : slice.count();
  5963. auto ret = select_impl(sock, events, 0, static_cast<time_t>(wait_usec));
  5964. if (ret != 0 || last) { return ret; }
  5965. }
  5966. return 0;
  5967. }
  5968. // select_impl(), but waits in slices and gives up once interrupted() returns
  5969. // true
  5970. inline ssize_t select_interruptible(socket_t sock, short events, time_t sec,
  5971. time_t usec,
  5972. const std::function<bool()> &interrupted) {
  5973. if (!interrupted) { return select_impl(sock, events, sec, usec); }
  5974. return select_until(sock, events, deadline_after(sec, usec), interrupted);
  5975. }
  5976. inline ssize_t
  5977. select_read_interruptible(socket_t sock, time_t sec, time_t usec,
  5978. const std::function<bool()> &interrupted) {
  5979. return select_interruptible(sock, POLLIN, sec, usec, interrupted);
  5980. }
  5981. // Waits for a connect in progress, which ends as Error::Canceled once
  5982. // interrupted() returns true
  5983. inline Error
  5984. wait_until_socket_is_ready(socket_t sock, time_t sec, time_t usec,
  5985. const std::function<bool()> &interrupted = nullptr) {
  5986. auto ret =
  5987. select_interruptible(sock, POLLIN | POLLOUT, sec, usec, interrupted);
  5988. if (ret == 0) {
  5989. return interrupted && interrupted() ? Error::Canceled
  5990. : Error::ConnectionTimeout;
  5991. }
  5992. if (ret < 0) { return Error::Connection; }
  5993. // A failed connect reports its error here, whatever events poll() returned
  5994. auto error = 0;
  5995. socklen_t len = sizeof(error);
  5996. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5997. reinterpret_cast<char *>(&error), &len);
  5998. return res >= 0 && !error ? Error::Success : Error::Connection;
  5999. }
  6000. inline bool is_socket_alive(socket_t sock) {
  6001. const auto val = detail::select_read(sock, 0, 0);
  6002. if (val == 0) {
  6003. return true;
  6004. } else if (val < 0 && errno == EBADF) {
  6005. return false;
  6006. }
  6007. char buf[1];
  6008. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  6009. }
  6010. class SocketStream final : public Stream {
  6011. public:
  6012. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  6013. time_t write_timeout_sec, time_t write_timeout_usec,
  6014. time_t max_timeout_msec = 0,
  6015. std::chrono::time_point<std::chrono::steady_clock> start_time =
  6016. (std::chrono::steady_clock::time_point::min)());
  6017. ~SocketStream() override;
  6018. bool is_readable() const override;
  6019. bool wait_readable() const override;
  6020. bool wait_writable() const override;
  6021. bool is_peer_alive() const override;
  6022. ssize_t read(char *ptr, size_t size) override;
  6023. ssize_t write(const char *ptr, size_t size) override;
  6024. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  6025. void get_local_ip_and_port(std::string &ip, int &port) const override;
  6026. socket_t socket() const override;
  6027. time_t duration() const override;
  6028. void set_read_timeout(time_t sec, time_t usec = 0) override;
  6029. void set_max_timeout(time_t msec) override;
  6030. void set_read_interrupt(std::function<bool()> interrupted) override;
  6031. const char *buffered_data(size_t &size) const override;
  6032. void consume_buffered(size_t size) override;
  6033. // The caller has just seen this socket become readable. Lets the next read
  6034. // skip its own readiness wait, which would otherwise ask the kernel a
  6035. // question that was answered a moment ago. Consumed by that read.
  6036. void set_readable_hint() { readable_hint_ = true; }
  6037. // Frees the read buffer of an idle stream until its next read. Nothing may
  6038. // be buffered.
  6039. void release_buffer();
  6040. private:
  6041. bool ensure_readable();
  6042. socket_t sock_;
  6043. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  6044. // thread while a read is in flight -- that is the point of it, for a caller
  6045. // holding one connection and wanting control back to send on it.
  6046. std::atomic<time_t> read_timeout_sec_;
  6047. std::atomic<time_t> read_timeout_usec_;
  6048. time_t write_timeout_sec_;
  6049. time_t write_timeout_usec_;
  6050. time_t max_timeout_msec_;
  6051. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  6052. std::function<bool()> read_interrupted_;
  6053. std::vector<char> read_buff_;
  6054. size_t read_buff_off_ = 0;
  6055. size_t read_buff_content_size_ = 0;
  6056. bool readable_hint_ = false;
  6057. static const size_t read_buff_size_ = 1024l * 4;
  6058. };
  6059. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  6060. time_t keep_alive_timeout_sec) {
  6061. using namespace std::chrono;
  6062. const auto interval_usec =
  6063. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  6064. // Avoid expensive `steady_clock::now()` call for the first time
  6065. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  6066. const auto start = steady_clock::now() - microseconds{interval_usec};
  6067. const auto timeout = seconds{keep_alive_timeout_sec};
  6068. while (true) {
  6069. if (svr_sock == INVALID_SOCKET) {
  6070. break; // Server socket is closed
  6071. }
  6072. auto val = select_read(sock, 0, interval_usec);
  6073. if (val < 0) {
  6074. break; // Ssocket error
  6075. } else if (val == 0) {
  6076. if (steady_clock::now() - start > timeout) {
  6077. break; // Timeout
  6078. }
  6079. } else {
  6080. return true; // Ready for read
  6081. }
  6082. }
  6083. return false;
  6084. }
  6085. // Serves the requests of one connection while they come. A client may
  6086. // pipeline its requests (RFC 9112 9.3.2), so reading one request can pull the
  6087. // start of the next one into the stream's buffer; that request must be served
  6088. // without waiting for the socket to become readable again, since its bytes are
  6089. // no longer on the socket. Otherwise `wait_for_next_request` waits for the
  6090. // socket, and returning false ends the loop. `served` counts the requests
  6091. // served on this connection so far.
  6092. template <typename S, typename W, typename T>
  6093. inline bool process_server_socket_core(S &strm, size_t &served,
  6094. size_t keep_alive_max_count,
  6095. W wait_for_next_request, T callback) {
  6096. auto ret = false;
  6097. // A keep_alive_max_count of 0 sets no limit.
  6098. for (; keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  6099. if (!strm.is_readable()) {
  6100. if (!wait_for_next_request()) { break; }
  6101. strm.set_readable_hint();
  6102. }
  6103. auto close_connection = served + 1 == keep_alive_max_count;
  6104. auto connection_closed = false;
  6105. ret = callback(strm, close_connection, connection_closed);
  6106. if (!ret || connection_closed) { break; }
  6107. }
  6108. return ret;
  6109. }
  6110. template <typename T>
  6111. inline bool
  6112. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  6113. size_t keep_alive_max_count,
  6114. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  6115. time_t read_timeout_usec, time_t write_timeout_sec,
  6116. time_t write_timeout_usec, T callback) {
  6117. // One stream per connection: its read buffer can already hold the start of
  6118. // the next, pipelined request.
  6119. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  6120. write_timeout_sec, write_timeout_usec);
  6121. size_t served = 0;
  6122. return process_server_socket_core(
  6123. strm, served, keep_alive_max_count,
  6124. [&]() { return keep_alive(svr_sock, sock, keep_alive_timeout_sec); },
  6125. callback);
  6126. }
  6127. inline bool process_client_socket(
  6128. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  6129. time_t write_timeout_sec, time_t write_timeout_usec,
  6130. time_t max_timeout_msec,
  6131. std::chrono::time_point<std::chrono::steady_clock> start_time,
  6132. std::function<bool(Stream &)> callback) {
  6133. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  6134. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  6135. start_time);
  6136. return callback(strm);
  6137. }
  6138. inline int shutdown_socket(socket_t sock) noexcept {
  6139. #ifdef _WIN32
  6140. return shutdown(sock, SD_BOTH);
  6141. #else
  6142. return shutdown(sock, SHUT_RDWR);
  6143. #endif
  6144. }
  6145. // Half-closes the write side and drains any in-flight/queued bytes before
  6146. // the final shutdown+close. Closing with unread data in the receive queue
  6147. // (or bytes arriving after the receive side is closed) makes the stack send
  6148. // an abortive RST instead of a graceful FIN, which can make the peer see the
  6149. // response as a failed read even though it was fully written. With a
  6150. // `wait_msec` of 0, it reads once, without waiting.
  6151. inline void drain_and_close_socket(socket_t sock,
  6152. time_t wait_msec = 100) noexcept {
  6153. #ifdef _WIN32
  6154. shutdown(sock, SD_SEND);
  6155. #else
  6156. shutdown(sock, SHUT_WR);
  6157. #endif
  6158. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6159. size_t total = 0;
  6160. const auto deadline = std::chrono::steady_clock::now() +
  6161. std::chrono::milliseconds(wait_msec); // bound #1
  6162. auto usec_left = [&]() {
  6163. const auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  6164. deadline - std::chrono::steady_clock::now())
  6165. .count();
  6166. return static_cast<time_t>(
  6167. (std::max)(left, std::chrono::microseconds::rep(0)));
  6168. };
  6169. do {
  6170. if (select_read(sock, 0, usec_left()) <= 0) { break; }
  6171. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  6172. if (n <= 0) { break; }
  6173. total += static_cast<size_t>(n);
  6174. } while (usec_left() > 0 && total < size_t(1024u * 1024u)); // bound #2
  6175. shutdown_socket(sock);
  6176. close_socket(sock);
  6177. }
  6178. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  6179. if (s.size() > 1 && s[0] == '\0') {
  6180. auto ret = s;
  6181. ret[0] = '@';
  6182. return ret;
  6183. }
  6184. return s;
  6185. }
  6186. inline std::string
  6187. unescape_abstract_namespace_unix_domain(const std::string &s) {
  6188. if (s.size() > 1 && s[0] == '@') {
  6189. auto ret = s;
  6190. ret[0] = '\0';
  6191. return ret;
  6192. }
  6193. return s;
  6194. }
  6195. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  6196. const struct addrinfo *hints,
  6197. struct addrinfo **res, time_t timeout_sec) {
  6198. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  6199. if (timeout_sec <= 0) {
  6200. // No timeout specified, use standard getaddrinfo
  6201. return getaddrinfo(node, service, hints, res);
  6202. }
  6203. #ifdef _WIN32
  6204. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  6205. OVERLAPPED overlapped = {};
  6206. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  6207. if (!event) { return EAI_FAIL; }
  6208. overlapped.hEvent = event;
  6209. PADDRINFOEXW result_addrinfo = nullptr;
  6210. HANDLE cancel_handle = nullptr;
  6211. ADDRINFOEXW hints_ex = {};
  6212. if (hints) {
  6213. hints_ex.ai_flags = hints->ai_flags;
  6214. hints_ex.ai_family = hints->ai_family;
  6215. hints_ex.ai_socktype = hints->ai_socktype;
  6216. hints_ex.ai_protocol = hints->ai_protocol;
  6217. }
  6218. auto wnode = u8string_to_wstring(node);
  6219. auto wservice = u8string_to_wstring(service);
  6220. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  6221. hints ? &hints_ex : nullptr, &result_addrinfo,
  6222. nullptr, &overlapped, nullptr, &cancel_handle);
  6223. if (ret == WSA_IO_PENDING) {
  6224. auto wait_result =
  6225. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  6226. if (wait_result == WAIT_TIMEOUT) {
  6227. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  6228. ::CloseHandle(event);
  6229. return EAI_AGAIN;
  6230. }
  6231. DWORD bytes_returned;
  6232. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  6233. &bytes_returned, FALSE)) {
  6234. ::CloseHandle(event);
  6235. return ::WSAGetLastError();
  6236. }
  6237. }
  6238. ::CloseHandle(event);
  6239. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  6240. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  6241. return 0;
  6242. }
  6243. return ret;
  6244. #elif TARGET_OS_MAC && defined(__clang__)
  6245. if (!node) { return EAI_NONAME; }
  6246. // macOS implementation using CFHost API for asynchronous DNS resolution
  6247. CFStringRef hostname_ref = CFStringCreateWithCString(
  6248. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  6249. if (!hostname_ref) { return EAI_MEMORY; }
  6250. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  6251. CFRelease(hostname_ref);
  6252. if (!host_ref) { return EAI_MEMORY; }
  6253. // Set up context for callback
  6254. struct CFHostContext {
  6255. bool completed = false;
  6256. bool success = false;
  6257. CFArrayRef addresses = nullptr;
  6258. std::mutex mutex;
  6259. std::condition_variable cv;
  6260. } context;
  6261. CFHostClientContext client_context;
  6262. memset(&client_context, 0, sizeof(client_context));
  6263. client_context.info = &context;
  6264. // Set callback
  6265. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  6266. const CFStreamError *error, void *info) {
  6267. auto ctx = static_cast<CFHostContext *>(info);
  6268. std::lock_guard<std::mutex> lock(ctx->mutex);
  6269. if (error && error->error != 0) {
  6270. ctx->success = false;
  6271. } else {
  6272. Boolean hasBeenResolved;
  6273. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  6274. if (ctx->addresses && hasBeenResolved) {
  6275. CFRetain(ctx->addresses);
  6276. ctx->success = true;
  6277. } else {
  6278. ctx->success = false;
  6279. }
  6280. }
  6281. ctx->completed = true;
  6282. ctx->cv.notify_one();
  6283. };
  6284. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  6285. CFRelease(host_ref);
  6286. return EAI_SYSTEM;
  6287. }
  6288. // Schedule on run loop
  6289. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  6290. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6291. // Start resolution
  6292. CFStreamError stream_error;
  6293. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  6294. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6295. CFRelease(host_ref);
  6296. return EAI_FAIL;
  6297. }
  6298. // Wait for completion with timeout
  6299. auto timeout_time =
  6300. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  6301. bool timed_out = false;
  6302. {
  6303. std::unique_lock<std::mutex> lock(context.mutex);
  6304. while (!context.completed) {
  6305. auto now = std::chrono::steady_clock::now();
  6306. if (now >= timeout_time) {
  6307. timed_out = true;
  6308. break;
  6309. }
  6310. // Run the runloop for a short time
  6311. lock.unlock();
  6312. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  6313. lock.lock();
  6314. }
  6315. }
  6316. // Clean up
  6317. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6318. CFHostSetClient(host_ref, nullptr, nullptr);
  6319. if (timed_out || !context.completed) {
  6320. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  6321. CFRelease(host_ref);
  6322. return EAI_AGAIN;
  6323. }
  6324. if (!context.success || !context.addresses) {
  6325. CFRelease(host_ref);
  6326. return EAI_NODATA;
  6327. }
  6328. // Convert CFArray to addrinfo
  6329. CFIndex count = CFArrayGetCount(context.addresses);
  6330. if (count == 0) {
  6331. CFRelease(context.addresses);
  6332. CFRelease(host_ref);
  6333. return EAI_NODATA;
  6334. }
  6335. struct addrinfo *result_addrinfo = nullptr;
  6336. struct addrinfo **current = &result_addrinfo;
  6337. for (CFIndex i = 0; i < count; i++) {
  6338. CFDataRef addr_data =
  6339. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6340. if (!addr_data) continue;
  6341. const struct sockaddr *sockaddr_ptr =
  6342. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6343. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6344. // Allocate addrinfo structure
  6345. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6346. if (!*current) {
  6347. freeaddrinfo(result_addrinfo);
  6348. CFRelease(context.addresses);
  6349. CFRelease(host_ref);
  6350. return EAI_MEMORY;
  6351. }
  6352. memset(*current, 0, sizeof(struct addrinfo));
  6353. // Set up addrinfo fields
  6354. (*current)->ai_family = sockaddr_ptr->sa_family;
  6355. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6356. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6357. (*current)->ai_addrlen = sockaddr_len;
  6358. // Copy sockaddr
  6359. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6360. if (!(*current)->ai_addr) {
  6361. freeaddrinfo(result_addrinfo);
  6362. CFRelease(context.addresses);
  6363. CFRelease(host_ref);
  6364. return EAI_MEMORY;
  6365. }
  6366. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6367. // Set port if service is specified
  6368. if (service && *service) {
  6369. int port = 0;
  6370. if (parse_port(service, strlen(service), port)) {
  6371. if (sockaddr_ptr->sa_family == AF_INET) {
  6372. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6373. ->sin_port = htons(static_cast<uint16_t>(port));
  6374. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6375. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6376. ->sin6_port = htons(static_cast<uint16_t>(port));
  6377. }
  6378. }
  6379. }
  6380. current = &((*current)->ai_next);
  6381. }
  6382. CFRelease(context.addresses);
  6383. CFRelease(host_ref);
  6384. *res = result_addrinfo;
  6385. return 0;
  6386. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6387. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6388. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6389. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6390. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6391. // the resolver worker still references the stack-local gaicb. The cancel
  6392. // path therefore waits (gai_suspend with no timeout) for the worker to
  6393. // actually finish before letting the stack frame go. The trade-off is that
  6394. // a wedged DNS server can hold this thread for the system resolver timeout
  6395. // (~30s by default) past the caller's connection timeout.
  6396. struct gaicb request{};
  6397. struct gaicb *requests[1] = {&request};
  6398. struct sigevent sevp{};
  6399. struct timespec timeout{timeout_sec, 0};
  6400. request.ar_name = node;
  6401. request.ar_service = service;
  6402. request.ar_request = hints;
  6403. sevp.sigev_notify = SIGEV_NONE;
  6404. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6405. if (rc != 0) { return rc; }
  6406. auto cleanup = scope_exit([&] {
  6407. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6408. });
  6409. int wait_result = gai_suspend(requests, 1, &timeout);
  6410. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6411. int gai_result = gai_error(&request);
  6412. if (gai_result == 0) {
  6413. *res = request.ar_result;
  6414. request.ar_result = nullptr;
  6415. return 0;
  6416. }
  6417. return gai_result;
  6418. }
  6419. gai_cancel(&request);
  6420. while (gai_error(&request) == EAI_INPROGRESS) {
  6421. gai_suspend(requests, 1, nullptr);
  6422. }
  6423. return wait_result;
  6424. #else
  6425. // Fallback implementation using thread-based timeout for other Unix systems.
  6426. struct GetAddrInfoState {
  6427. ~GetAddrInfoState() {
  6428. if (info) { freeaddrinfo(info); }
  6429. }
  6430. std::mutex mutex;
  6431. std::condition_variable result_cv;
  6432. bool completed = false;
  6433. int result = EAI_SYSTEM;
  6434. std::string node;
  6435. std::string service;
  6436. struct addrinfo hints;
  6437. struct addrinfo *info = nullptr;
  6438. };
  6439. // Allocate on the heap, so the resolver thread can keep using the data.
  6440. auto state = std::make_shared<GetAddrInfoState>();
  6441. if (node) { state->node = node; }
  6442. state->service = service;
  6443. state->hints = *hints;
  6444. std::thread resolve_thread([state]() {
  6445. auto thread_result =
  6446. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6447. &state->info);
  6448. std::lock_guard<std::mutex> lock(state->mutex);
  6449. state->result = thread_result;
  6450. state->completed = true;
  6451. state->result_cv.notify_one();
  6452. });
  6453. // Wait for completion or timeout
  6454. std::unique_lock<std::mutex> lock(state->mutex);
  6455. auto finished =
  6456. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6457. [&] { return state->completed; });
  6458. if (finished) {
  6459. // Operation completed within timeout
  6460. resolve_thread.join();
  6461. *res = state->info;
  6462. state->info = nullptr; // Pass ownership to caller
  6463. return state->result;
  6464. } else {
  6465. // Timeout occurred
  6466. resolve_thread.detach(); // Let the thread finish in background
  6467. return EAI_AGAIN; // Return timeout error
  6468. }
  6469. #endif
  6470. #else
  6471. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6472. return getaddrinfo(node, service, hints, res);
  6473. #endif
  6474. }
  6475. template <typename BindOrConnect>
  6476. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6477. int address_family, int socket_flags, bool tcp_nodelay,
  6478. bool ipv6_v6only, SocketOptions socket_options,
  6479. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6480. // Get address info
  6481. const char *node = nullptr;
  6482. struct addrinfo hints;
  6483. struct addrinfo *result;
  6484. memset(&hints, 0, sizeof(struct addrinfo));
  6485. hints.ai_socktype = SOCK_STREAM;
  6486. hints.ai_protocol = IPPROTO_IP;
  6487. if (!ip.empty()) {
  6488. node = ip.c_str();
  6489. // Ask getaddrinfo to convert IP in c-string to address
  6490. hints.ai_family = AF_UNSPEC;
  6491. hints.ai_flags = AI_NUMERICHOST;
  6492. } else {
  6493. if (!host.empty()) { node = host.c_str(); }
  6494. hints.ai_family = address_family;
  6495. hints.ai_flags = socket_flags;
  6496. }
  6497. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6498. if (hints.ai_family == AF_UNIX) {
  6499. const auto addrlen = host.length();
  6500. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6501. #ifdef SOCK_CLOEXEC
  6502. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6503. hints.ai_protocol);
  6504. #else
  6505. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6506. #endif
  6507. if (sock != INVALID_SOCKET) {
  6508. sockaddr_un addr{};
  6509. addr.sun_family = AF_UNIX;
  6510. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6511. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6512. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6513. hints.ai_addrlen = static_cast<socklen_t>(
  6514. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6515. #ifndef SOCK_CLOEXEC
  6516. #ifndef _WIN32
  6517. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6518. #endif
  6519. #endif
  6520. if (socket_options) { socket_options(sock); }
  6521. #ifdef _WIN32
  6522. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6523. // remove the option.
  6524. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6525. #endif
  6526. bool dummy;
  6527. if (!bind_or_connect(sock, hints, dummy)) {
  6528. close_socket(sock);
  6529. sock = INVALID_SOCKET;
  6530. }
  6531. }
  6532. return sock;
  6533. }
  6534. #endif
  6535. auto service = std::to_string(port);
  6536. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6537. timeout_sec)) {
  6538. #if defined __linux__ && !defined __ANDROID__
  6539. res_init();
  6540. #endif
  6541. return INVALID_SOCKET;
  6542. }
  6543. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6544. for (auto rp = result; rp; rp = rp->ai_next) {
  6545. // Create a socket
  6546. #ifdef _WIN32
  6547. auto sock =
  6548. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6549. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6550. /**
  6551. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6552. * and above the socket creation fails on older Windows Systems.
  6553. *
  6554. * Let's try to create a socket the old way in this case.
  6555. *
  6556. * Reference:
  6557. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6558. *
  6559. * WSA_FLAG_NO_HANDLE_INHERIT:
  6560. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6561. * SP1, and later
  6562. *
  6563. */
  6564. if (sock == INVALID_SOCKET) {
  6565. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6566. }
  6567. #else
  6568. #ifdef SOCK_CLOEXEC
  6569. auto sock =
  6570. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6571. #else
  6572. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6573. #endif
  6574. #endif
  6575. if (sock == INVALID_SOCKET) { continue; }
  6576. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6577. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6578. close_socket(sock);
  6579. continue;
  6580. }
  6581. #endif
  6582. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6583. if (rp->ai_family == AF_INET6) {
  6584. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6585. }
  6586. if (socket_options) { socket_options(sock); }
  6587. // bind or connect
  6588. auto quit = false;
  6589. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6590. close_socket(sock);
  6591. if (quit) { break; }
  6592. }
  6593. return INVALID_SOCKET;
  6594. }
  6595. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6596. #ifdef _WIN32
  6597. auto flags = nonblocking ? 1UL : 0UL;
  6598. ioctlsocket(sock, FIONBIO, &flags);
  6599. #else
  6600. auto flags = fcntl(sock, F_GETFL, 0);
  6601. fcntl(sock, F_SETFL,
  6602. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6603. #endif
  6604. }
  6605. inline bool is_connection_error() {
  6606. #ifdef _WIN32
  6607. return WSAGetLastError() != WSAEWOULDBLOCK;
  6608. #else
  6609. return errno != EINPROGRESS;
  6610. #endif
  6611. }
  6612. // accept() failed because the process or the network stack is temporarily out
  6613. // of resources. The listening socket is still usable, so back off briefly and
  6614. // try again.
  6615. inline bool is_accept_resource_error() {
  6616. #ifdef _WIN32
  6617. auto err = WSAGetLastError();
  6618. return err == WSAEMFILE || err == WSAENOBUFS;
  6619. #else
  6620. auto err = errno;
  6621. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6622. #endif
  6623. }
  6624. // accept() failed for a reason that says nothing about the listening socket:
  6625. // the pending connection went away before it could be accepted, or the call
  6626. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6627. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6628. // connection that way.
  6629. inline bool is_accept_transient_error() {
  6630. #ifdef _WIN32
  6631. auto err = WSAGetLastError();
  6632. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6633. err == WSAECONNABORTED;
  6634. #else
  6635. auto err = errno;
  6636. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6637. err == ECONNABORTED;
  6638. #endif
  6639. }
  6640. inline socket_t accept_socket(socket_t svr_sock) {
  6641. #if defined _WIN32
  6642. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  6643. // OVERLAPPED
  6644. return WSAAccept(svr_sock, nullptr, nullptr, nullptr, 0);
  6645. #elif defined SOCK_CLOEXEC
  6646. return accept4(svr_sock, nullptr, nullptr, SOCK_CLOEXEC);
  6647. #else
  6648. return accept(svr_sock, nullptr, nullptr);
  6649. #endif
  6650. }
  6651. inline bool is_would_block_error() {
  6652. #ifdef _WIN32
  6653. return WSAGetLastError() == WSAEWOULDBLOCK;
  6654. #else
  6655. return errno == EAGAIN || errno == EWOULDBLOCK;
  6656. #endif
  6657. }
  6658. inline bool create_socket_pair(socket_t sv[2]) {
  6659. #ifdef _WIN32
  6660. auto listener = create_socket(
  6661. std::string(), "127.0.0.1", 0, AF_INET, 0, false, false, nullptr,
  6662. [](socket_t sock, struct addrinfo &ai, bool &) {
  6663. return ::bind(sock, ai.ai_addr, static_cast<int>(ai.ai_addrlen)) == 0 &&
  6664. ::listen(sock, 1) == 0;
  6665. });
  6666. if (listener == INVALID_SOCKET) { return false; }
  6667. socket_t a = INVALID_SOCKET;
  6668. socket_t b = INVALID_SOCKET;
  6669. sockaddr_in addr{};
  6670. auto addr_len = static_cast<int>(sizeof(addr));
  6671. if (::getsockname(listener, reinterpret_cast<sockaddr *>(&addr), &addr_len) ==
  6672. 0) {
  6673. a = create_socket(std::string(), "127.0.0.1", ntohs(addr.sin_port), AF_INET,
  6674. 0, true, false, nullptr,
  6675. [](socket_t sock, struct addrinfo &ai, bool &) {
  6676. return ::connect(sock, ai.ai_addr,
  6677. static_cast<int>(ai.ai_addrlen)) == 0;
  6678. });
  6679. // Unlike accept(), this keeps the listener's no-inherit flag.
  6680. if (a != INVALID_SOCKET) {
  6681. b = WSAAccept(listener, nullptr, nullptr, nullptr, 0);
  6682. }
  6683. }
  6684. close_socket(listener);
  6685. // Any local process could connect while the listener was open, so make sure
  6686. // that the connection we accepted is the one we made.
  6687. if (b != INVALID_SOCKET) {
  6688. sockaddr_in local{}, peer{};
  6689. auto local_len = static_cast<int>(sizeof(local));
  6690. auto peer_len = static_cast<int>(sizeof(peer));
  6691. if (::getsockname(a, reinterpret_cast<sockaddr *>(&local), &local_len) !=
  6692. 0 ||
  6693. ::getpeername(b, reinterpret_cast<sockaddr *>(&peer), &peer_len) != 0 ||
  6694. local.sin_port != peer.sin_port ||
  6695. local.sin_addr.s_addr != peer.sin_addr.s_addr) {
  6696. close_socket(b);
  6697. b = INVALID_SOCKET;
  6698. }
  6699. }
  6700. if (b == INVALID_SOCKET) {
  6701. if (a != INVALID_SOCKET) { close_socket(a); }
  6702. return false;
  6703. }
  6704. sv[0] = a;
  6705. sv[1] = b;
  6706. return true;
  6707. #else
  6708. #ifdef SOCK_CLOEXEC
  6709. return ::socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sv) == 0;
  6710. #else
  6711. if (::socketpair(AF_UNIX, SOCK_STREAM, 0, sv) != 0) { return false; }
  6712. fcntl(sv[0], F_SETFD, FD_CLOEXEC);
  6713. fcntl(sv[1], F_SETFD, FD_CLOEXEC);
  6714. return true;
  6715. #endif
  6716. #endif
  6717. }
  6718. inline PollerWaker::~PollerWaker() {
  6719. if (pair_fd_ != INVALID_SOCKET) { close_socket(pair_fd_); }
  6720. if (fd_ != INVALID_SOCKET) { close_socket(fd_); }
  6721. }
  6722. inline bool PollerWaker::open() {
  6723. // wake() must not block its caller, and drain() must not block the poller.
  6724. #ifdef __linux__
  6725. fd_ = eventfd(0, EFD_NONBLOCK | EFD_CLOEXEC);
  6726. return fd_ != INVALID_SOCKET;
  6727. #else
  6728. socket_t sv[2];
  6729. if (!create_socket_pair(sv)) { return false; }
  6730. fd_ = sv[0];
  6731. pair_fd_ = sv[1];
  6732. set_nonblocking(fd_, true);
  6733. set_nonblocking(pair_fd_, true);
  6734. return true;
  6735. #endif
  6736. }
  6737. inline void PollerWaker::wake() noexcept {
  6738. if (pending_.exchange(true)) { return; }
  6739. #ifdef __linux__
  6740. const uint64_t one = 1;
  6741. auto r = write(fd_, &one, sizeof(one));
  6742. (void)r;
  6743. #else
  6744. const char c = 1;
  6745. send_socket(pair_fd_, &c, 1, CPPHTTPLIB_SEND_FLAGS);
  6746. #endif
  6747. }
  6748. inline void PollerWaker::drain() noexcept {
  6749. // While pending_ is set, at most one wake is unread, and one read takes it.
  6750. #ifdef __linux__
  6751. uint64_t count;
  6752. auto r = read(fd_, &count, sizeof(count));
  6753. (void)r;
  6754. #else
  6755. char buf[64];
  6756. read_socket(fd_, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  6757. #endif
  6758. // Only after the read: cleared before it, a wake() in between would be read
  6759. // here and leave pending_ set with nothing to read. One skipped during the
  6760. // read is fine, as the caller checks what it was woken for afterwards.
  6761. pending_ = false;
  6762. }
  6763. inline std::unique_ptr<Poller> PollPoller::create() {
  6764. std::unique_ptr<PollPoller> poller(new PollPoller());
  6765. if (!poller->waker_.open()) { return nullptr; }
  6766. struct pollfd pfd;
  6767. pfd.fd = poller->waker_.fd();
  6768. pfd.events = POLLIN;
  6769. pfd.revents = 0;
  6770. poller->fds_.push_back(pfd);
  6771. poller->tokens_.push_back(0);
  6772. return std::unique_ptr<Poller>(poller.release());
  6773. }
  6774. inline bool PollPoller::arm(socket_t fd, Token token) {
  6775. assert(index_.find(fd) == index_.end());
  6776. struct pollfd pfd;
  6777. pfd.fd = fd;
  6778. pfd.events = POLLIN;
  6779. pfd.revents = 0;
  6780. index_[fd] = fds_.size();
  6781. fds_.push_back(pfd);
  6782. tokens_.push_back(token);
  6783. return true;
  6784. }
  6785. inline void PollPoller::disarm(socket_t fd) {
  6786. auto it = index_.find(fd);
  6787. if (it != index_.end()) { remove_at(it->second); }
  6788. }
  6789. // Fills the hole with the last entry, so that arm() and disarm() are O(1).
  6790. inline void PollPoller::remove_at(size_t index) {
  6791. assert(index > 0 && index < fds_.size());
  6792. auto last = fds_.size() - 1;
  6793. index_.erase(fds_[index].fd);
  6794. if (index != last) {
  6795. fds_[index] = fds_[last];
  6796. tokens_[index] = tokens_[last];
  6797. index_[fds_[index].fd] = index;
  6798. }
  6799. fds_.pop_back();
  6800. tokens_.pop_back();
  6801. }
  6802. inline bool PollPoller::wait(int timeout_ms, std::vector<Token> &ready) {
  6803. ready.clear();
  6804. auto n = handle_EINTR([&]() {
  6805. return poll_wrapper(fds_.data(), static_cast<nfds_t>(fds_.size()),
  6806. timeout_ms);
  6807. });
  6808. if (n <= 0) { return false; }
  6809. auto woken = fds_[0].revents != 0;
  6810. if (woken) {
  6811. n--;
  6812. waker_.drain();
  6813. }
  6814. // Walk backwards: remove_at() moves the last entry, already seen, into the
  6815. // freed slot.
  6816. for (auto i = fds_.size(); n > 0 && i-- > 1;) {
  6817. auto revents = fds_[i].revents;
  6818. if (revents == 0) { continue; }
  6819. n--;
  6820. assert(!(revents & POLLNVAL)); // closed while armed
  6821. if (!(revents & POLLNVAL)) { ready.push_back(tokens_[i]); }
  6822. remove_at(i);
  6823. }
  6824. return woken;
  6825. }
  6826. #ifdef __linux__
  6827. inline std::unique_ptr<Poller> EpollPoller::create() {
  6828. std::unique_ptr<EpollPoller> poller(new EpollPoller());
  6829. poller->epfd_ = epoll_create1(EPOLL_CLOEXEC);
  6830. if (poller->epfd_ < 0 || !poller->waker_.open()) { return nullptr; }
  6831. epoll_event ev{};
  6832. ev.events = EPOLLIN; // level-triggered: it stays readable until drained
  6833. ev.data.u64 = poller->waker_.token();
  6834. if (epoll_ctl(poller->epfd_, EPOLL_CTL_ADD, poller->waker_.fd(), &ev) != 0) {
  6835. return nullptr;
  6836. }
  6837. poller->events_.resize(256);
  6838. return std::unique_ptr<Poller>(poller.release());
  6839. }
  6840. inline EpollPoller::~EpollPoller() {
  6841. if (epfd_ >= 0) { close(epfd_); }
  6842. }
  6843. inline bool EpollPoller::arm(socket_t fd, Token token) {
  6844. epoll_event ev{};
  6845. ev.events = EPOLLIN | EPOLLONESHOT;
  6846. ev.data.u64 = token;
  6847. // A delivered descriptor stays registered, only disabled, so modify it.
  6848. // One that was closed in between, or never armed, has to be added.
  6849. return epoll_ctl(epfd_, EPOLL_CTL_MOD, fd, &ev) == 0 ||
  6850. (errno == ENOENT && epoll_ctl(epfd_, EPOLL_CTL_ADD, fd, &ev) == 0);
  6851. }
  6852. inline void EpollPoller::disarm(socket_t fd) {
  6853. epoll_ctl(epfd_, EPOLL_CTL_DEL, fd, nullptr);
  6854. }
  6855. inline bool EpollPoller::wait(int timeout_ms, std::vector<Token> &ready) {
  6856. ready.clear();
  6857. auto n = handle_EINTR([&]() {
  6858. return epoll_wait(epfd_, events_.data(), static_cast<int>(events_.size()),
  6859. timeout_ms);
  6860. });
  6861. auto woken = false;
  6862. for (auto i = 0; i < n; i++) {
  6863. auto token = static_cast<Token>(events_[static_cast<size_t>(i)].data.u64);
  6864. if (token == waker_.token()) {
  6865. woken = true;
  6866. waker_.drain();
  6867. } else {
  6868. ready.push_back(token);
  6869. }
  6870. }
  6871. return woken;
  6872. }
  6873. #endif
  6874. #ifdef CPPHTTPLIB_KQUEUE_POLLER
  6875. inline std::unique_ptr<Poller> KqueuePoller::create() {
  6876. std::unique_ptr<KqueuePoller> poller(new KqueuePoller());
  6877. poller->kq_ = kqueue();
  6878. if (poller->kq_ < 0) { return nullptr; }
  6879. fcntl(poller->kq_, F_SETFD, FD_CLOEXEC);
  6880. if (!poller->waker_.open()) { return nullptr; }
  6881. // Level-triggered: it stays readable until drained.
  6882. struct kevent ev;
  6883. EV_SET(&ev, poller->waker_.fd(), EVFILT_READ, EV_ADD, 0, 0,
  6884. reinterpret_cast<void *>(poller->waker_.token()));
  6885. if (kevent(poller->kq_, &ev, 1, nullptr, 0, nullptr) != 0) { return nullptr; }
  6886. poller->events_.resize(256);
  6887. return std::unique_ptr<Poller>(poller.release());
  6888. }
  6889. inline KqueuePoller::~KqueuePoller() {
  6890. if (kq_ >= 0) { close(kq_); }
  6891. }
  6892. inline bool KqueuePoller::arm(socket_t fd, Token token) {
  6893. // EV_ONESHOT deletes the event once it is delivered.
  6894. struct kevent ev;
  6895. EV_SET(&ev, fd, EVFILT_READ, EV_ADD | EV_ONESHOT, 0, 0,
  6896. reinterpret_cast<void *>(token));
  6897. return kevent(kq_, &ev, 1, nullptr, 0, nullptr) == 0;
  6898. }
  6899. inline void KqueuePoller::disarm(socket_t fd) {
  6900. struct kevent ev;
  6901. EV_SET(&ev, fd, EVFILT_READ, EV_DELETE, 0, 0, nullptr);
  6902. kevent(kq_, &ev, 1, nullptr, 0, nullptr);
  6903. }
  6904. inline bool KqueuePoller::wait(int timeout_ms, std::vector<Token> &ready) {
  6905. ready.clear();
  6906. struct timespec ts;
  6907. ts.tv_sec = timeout_ms / 1000;
  6908. ts.tv_nsec = static_cast<long>(timeout_ms % 1000) * 1000000;
  6909. auto n = handle_EINTR([&]() {
  6910. return kevent(kq_, nullptr, 0, events_.data(),
  6911. static_cast<int>(events_.size()),
  6912. timeout_ms < 0 ? nullptr : &ts);
  6913. });
  6914. auto woken = false;
  6915. for (auto i = 0; i < n; i++) {
  6916. auto token = reinterpret_cast<Token>(events_[static_cast<size_t>(i)].udata);
  6917. if (token == waker_.token()) {
  6918. woken = true;
  6919. waker_.drain();
  6920. } else {
  6921. ready.push_back(token);
  6922. }
  6923. }
  6924. return woken;
  6925. }
  6926. #endif
  6927. inline std::unique_ptr<Poller> make_poller() {
  6928. #if defined(__linux__)
  6929. auto poller = EpollPoller::create();
  6930. if (poller) { return poller; }
  6931. #elif defined(CPPHTTPLIB_KQUEUE_POLLER)
  6932. auto poller = KqueuePoller::create();
  6933. if (poller) { return poller; }
  6934. #endif
  6935. return PollPoller::create();
  6936. }
  6937. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6938. struct addrinfo hints;
  6939. struct addrinfo *result;
  6940. memset(&hints, 0, sizeof(struct addrinfo));
  6941. hints.ai_family = AF_UNSPEC;
  6942. hints.ai_socktype = SOCK_STREAM;
  6943. hints.ai_protocol = 0;
  6944. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6945. return false;
  6946. }
  6947. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6948. auto ret = false;
  6949. for (auto rp = result; rp; rp = rp->ai_next) {
  6950. const auto &ai = *rp;
  6951. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6952. ret = true;
  6953. break;
  6954. }
  6955. }
  6956. return ret;
  6957. }
  6958. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6959. #define USE_IF2IP
  6960. #endif
  6961. #ifdef USE_IF2IP
  6962. inline std::string if2ip(int address_family, const std::string &ifn) {
  6963. struct ifaddrs *ifap;
  6964. getifaddrs(&ifap);
  6965. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6966. std::string addr_candidate;
  6967. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6968. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6969. (AF_UNSPEC == address_family ||
  6970. ifa->ifa_addr->sa_family == address_family)) {
  6971. if (ifa->ifa_addr->sa_family == AF_INET) {
  6972. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6973. char buf[INET_ADDRSTRLEN];
  6974. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6975. return std::string(buf, INET_ADDRSTRLEN);
  6976. }
  6977. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6978. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6979. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6980. char buf[INET6_ADDRSTRLEN] = {};
  6981. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6982. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6983. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6984. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6985. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6986. } else {
  6987. return std::string(buf, INET6_ADDRSTRLEN);
  6988. }
  6989. }
  6990. }
  6991. }
  6992. }
  6993. }
  6994. return addr_candidate;
  6995. }
  6996. #endif
  6997. inline socket_t
  6998. create_client_socket(const std::string &host, const std::string &ip, int port,
  6999. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  7000. SocketOptions socket_options,
  7001. time_t connection_timeout_sec,
  7002. time_t connection_timeout_usec, time_t read_timeout_sec,
  7003. time_t read_timeout_usec, time_t write_timeout_sec,
  7004. time_t write_timeout_usec, const std::string &intf,
  7005. Error &error, const std::function<bool()> &interrupted) {
  7006. auto sock = create_socket(
  7007. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  7008. std::move(socket_options),
  7009. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  7010. if (!intf.empty()) {
  7011. #ifdef USE_IF2IP
  7012. auto ip_from_if = if2ip(address_family, intf);
  7013. if (ip_from_if.empty()) { ip_from_if = intf; }
  7014. if (!bind_ip_address(sock2, ip_from_if)) {
  7015. error = Error::BindIPAddress;
  7016. return false;
  7017. }
  7018. #endif
  7019. }
  7020. set_nonblocking(sock2, true);
  7021. auto ret =
  7022. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  7023. if (ret < 0) {
  7024. if (is_connection_error()) {
  7025. error = Error::Connection;
  7026. return false;
  7027. }
  7028. error =
  7029. wait_until_socket_is_ready(sock2, connection_timeout_sec,
  7030. connection_timeout_usec, interrupted);
  7031. if (error != Error::Success) {
  7032. if (error == Error::ConnectionTimeout || error == Error::Canceled) {
  7033. quit = true;
  7034. }
  7035. return false;
  7036. }
  7037. }
  7038. set_nonblocking(sock2, false);
  7039. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  7040. read_timeout_usec);
  7041. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  7042. write_timeout_usec);
  7043. error = Error::Success;
  7044. return true;
  7045. },
  7046. connection_timeout_sec); // Pass DNS timeout
  7047. if (sock != INVALID_SOCKET) {
  7048. error = Error::Success;
  7049. } else {
  7050. if (error == Error::Success) { error = Error::Connection; }
  7051. }
  7052. return sock;
  7053. }
  7054. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  7055. socklen_t addr_len, std::string &ip, int &port) {
  7056. if (addr.ss_family == AF_INET) {
  7057. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  7058. } else if (addr.ss_family == AF_INET6) {
  7059. port =
  7060. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  7061. } else {
  7062. return false;
  7063. }
  7064. std::array<char, NI_MAXHOST> ipstr{};
  7065. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  7066. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  7067. 0, NI_NUMERICHOST)) {
  7068. return false;
  7069. }
  7070. ip = ipstr.data();
  7071. return true;
  7072. }
  7073. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  7074. struct sockaddr_storage addr;
  7075. socklen_t addr_len = sizeof(addr);
  7076. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  7077. &addr_len)) {
  7078. get_ip_and_port(addr, addr_len, ip, port);
  7079. }
  7080. }
  7081. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  7082. struct sockaddr_storage addr;
  7083. socklen_t addr_len = sizeof(addr);
  7084. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  7085. &addr_len)) {
  7086. #ifndef _WIN32
  7087. if (addr.ss_family == AF_UNIX) {
  7088. #if defined(__linux__)
  7089. struct ucred ucred;
  7090. socklen_t len = sizeof(ucred);
  7091. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  7092. port = ucred.pid;
  7093. }
  7094. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  7095. pid_t pid;
  7096. socklen_t len = sizeof(pid);
  7097. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  7098. port = pid;
  7099. }
  7100. #endif
  7101. return;
  7102. }
  7103. #endif
  7104. get_ip_and_port(addr, addr_len, ip, port);
  7105. }
  7106. }
  7107. inline std::string
  7108. find_content_type(const std::string &path,
  7109. const std::map<std::string, std::string> &user_data,
  7110. const std::string &default_content_type) {
  7111. // Extensions are matched regardless of case, as web servers do
  7112. auto ext = case_ignore::to_lower(file_extension(path));
  7113. auto it = user_data.find(ext);
  7114. if (it != user_data.end()) { return it->second; }
  7115. static const struct {
  7116. const char *ext;
  7117. const char *type;
  7118. } types[] = {
  7119. {"css", "text/css"},
  7120. {"csv", "text/csv"},
  7121. {"htm", "text/html"},
  7122. {"html", "text/html"},
  7123. {"js", "text/javascript"},
  7124. {"mjs", "text/javascript"},
  7125. {"txt", "text/plain"},
  7126. {"vtt", "text/vtt"},
  7127. {"apng", "image/apng"},
  7128. {"avif", "image/avif"},
  7129. {"bmp", "image/bmp"},
  7130. {"gif", "image/gif"},
  7131. {"png", "image/png"},
  7132. {"svg", "image/svg+xml"},
  7133. {"webp", "image/webp"},
  7134. {"ico", "image/x-icon"},
  7135. {"tif", "image/tiff"},
  7136. {"tiff", "image/tiff"},
  7137. {"jpg", "image/jpeg"},
  7138. {"jpeg", "image/jpeg"},
  7139. {"mp4", "video/mp4"},
  7140. {"mpeg", "video/mpeg"},
  7141. {"webm", "video/webm"},
  7142. {"mp3", "audio/mp3"},
  7143. {"mpga", "audio/mpeg"},
  7144. {"weba", "audio/webm"},
  7145. {"wav", "audio/wave"},
  7146. {"otf", "font/otf"},
  7147. {"ttf", "font/ttf"},
  7148. {"woff", "font/woff"},
  7149. {"woff2", "font/woff2"},
  7150. {"7z", "application/x-7z-compressed"},
  7151. {"atom", "application/atom+xml"},
  7152. {"pdf", "application/pdf"},
  7153. {"json", "application/json"},
  7154. {"rss", "application/rss+xml"},
  7155. {"tar", "application/x-tar"},
  7156. {"xht", "application/xhtml+xml"},
  7157. {"xhtml", "application/xhtml+xml"},
  7158. {"xslt", "application/xslt+xml"},
  7159. {"xml", "application/xml"},
  7160. {"gz", "application/gzip"},
  7161. {"zip", "application/zip"},
  7162. {"wasm", "application/wasm"},
  7163. };
  7164. for (const auto &t : types) {
  7165. if (ext == t.ext) { return t.type; }
  7166. }
  7167. return default_content_type;
  7168. }
  7169. inline std::string
  7170. extract_media_type(const std::string &content_type,
  7171. std::map<std::string, std::string> *params = nullptr) {
  7172. // Extract type/subtype from Content-Type value (RFC 2045)
  7173. // e.g. "application/json; charset=utf-8" -> "application/json"
  7174. auto media_type = content_type;
  7175. auto semicolon_pos = media_type.find(';');
  7176. if (semicolon_pos != std::string::npos) {
  7177. auto param_str = media_type.substr(semicolon_pos + 1);
  7178. media_type = media_type.substr(0, semicolon_pos);
  7179. if (params) {
  7180. // Parse parameters: key=value pairs separated by ';'
  7181. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  7182. [&](const char *b, const char *e) {
  7183. std::string key;
  7184. std::string val;
  7185. divide_param_pair(b, e, key, val);
  7186. // Parameter names are case-insensitive (RFC 9110
  7187. // §5.6.6)
  7188. if (!key.empty()) {
  7189. params->emplace(case_ignore::to_lower(trim_copy(key)),
  7190. unquote_param(val));
  7191. }
  7192. });
  7193. }
  7194. }
  7195. // Trim whitespace from media type
  7196. return trim_copy(media_type);
  7197. }
  7198. inline bool can_compress_content_type(const std::string &content_type) {
  7199. // Media types are case-insensitive (RFC 9110 §8.3.1)
  7200. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  7201. static const char *const compressible[] = {
  7202. "image/svg+xml",
  7203. "application/javascript",
  7204. "application/x-javascript",
  7205. "application/json",
  7206. "application/ld+json",
  7207. "application/xml",
  7208. "application/xhtml+xml",
  7209. "application/rss+xml",
  7210. "application/atom+xml",
  7211. "application/xslt+xml",
  7212. "application/protobuf",
  7213. };
  7214. for (auto type : compressible) {
  7215. if (mime_type == type) { return true; }
  7216. }
  7217. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  7218. }
  7219. inline bool parse_quality(const char *b, const char *e, std::string &token,
  7220. double &quality) {
  7221. quality = 1.0;
  7222. token.clear();
  7223. // Split on first ';': left = token name, right = parameters
  7224. const char *params_b = nullptr;
  7225. std::size_t params_len = 0;
  7226. divide(
  7227. b, static_cast<std::size_t>(e - b), ';',
  7228. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  7229. auto r = trim(lb, lb + llen, 0, llen);
  7230. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  7231. params_b = rb;
  7232. params_len = rlen;
  7233. });
  7234. if (token.empty()) { return false; }
  7235. if (params_len == 0) { return true; }
  7236. // Scan parameters for q= (stops on first match)
  7237. bool invalid = false;
  7238. split_find(params_b, params_b + params_len, ';',
  7239. (std::numeric_limits<size_t>::max)(),
  7240. [&](const char *pb, const char *pe) -> bool {
  7241. // Match exactly "q=" or "Q=" (not "query=" etc.)
  7242. auto len = static_cast<size_t>(pe - pb);
  7243. if (len < 2) { return false; }
  7244. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  7245. return false;
  7246. }
  7247. // Trim the value portion
  7248. auto r = trim(pb, pe, 2, len);
  7249. if (r.first >= r.second) {
  7250. invalid = true;
  7251. return true;
  7252. }
  7253. double v = 0.0;
  7254. auto res = from_chars(pb + r.first, pb + r.second, v);
  7255. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  7256. v < 0.0 || v > 1.0) {
  7257. invalid = true;
  7258. return true;
  7259. }
  7260. quality = v;
  7261. return true;
  7262. });
  7263. return !invalid;
  7264. }
  7265. inline EncodingType encoding_type(const Request &req,
  7266. const std::string &content_type) {
  7267. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  7268. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  7269. if (s.empty()) { return EncodingType::None; }
  7270. // Single-pass: iterate tokens and track the best supported encoding.
  7271. // Server preference breaks ties (br > gzip > zstd).
  7272. EncodingType best = EncodingType::None;
  7273. double best_q = 0.0; // q=0 means "not acceptable"
  7274. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  7275. auto priority = [](EncodingType t) -> int {
  7276. switch (t) {
  7277. case EncodingType::Brotli: return 0;
  7278. case EncodingType::Gzip: return 1;
  7279. case EncodingType::Zstd: return 2;
  7280. default: return 3;
  7281. }
  7282. };
  7283. std::string name;
  7284. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7285. double quality = 1.0;
  7286. if (!parse_quality(b, e, name, quality)) { return; }
  7287. if (quality <= 0.0) { return; }
  7288. EncodingType type = EncodingType::None;
  7289. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7290. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  7291. #endif
  7292. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7293. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  7294. type = EncodingType::Gzip;
  7295. }
  7296. #endif
  7297. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7298. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  7299. type = EncodingType::Zstd;
  7300. }
  7301. #endif
  7302. if (type == EncodingType::None) { return; }
  7303. // Higher q-value wins; for equal q, server preference breaks ties
  7304. if (quality > best_q ||
  7305. (quality == best_q && priority(type) < priority(best))) {
  7306. best_q = quality;
  7307. best = type;
  7308. }
  7309. });
  7310. return best;
  7311. }
  7312. // `content_type` is taken separately because a file-backed response has not
  7313. // been given one yet when its coding has to be decided.
  7314. inline EncodingType encoding_type(const Request &req, const Response &res,
  7315. const std::string &content_type) {
  7316. // The response already names a content coding of its own: a handler serving
  7317. // a body it encoded itself (pre-compressed static assets, say), or a mount
  7318. // point whose headers name the coding its files are stored in. Applying one
  7319. // on top of that would double-encode the body and append a second
  7320. // `Content-Encoding` field line.
  7321. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  7322. return encoding_type(req, content_type);
  7323. }
  7324. inline EncodingType encoding_type(const Request &req, const Response &res) {
  7325. return encoding_type(req, res, res.get_header_value("Content-Type"));
  7326. }
  7327. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  7328. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7329. if (type == EncodingType::Gzip) {
  7330. return detail::make_unique<gzip_compressor>();
  7331. }
  7332. #endif
  7333. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7334. if (type == EncodingType::Brotli) {
  7335. return detail::make_unique<brotli_compressor>();
  7336. }
  7337. #endif
  7338. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7339. if (type == EncodingType::Zstd) {
  7340. return detail::make_unique<zstd_compressor>();
  7341. }
  7342. #endif
  7343. (void)type;
  7344. return nullptr;
  7345. }
  7346. inline const char *encoding_name(EncodingType type) {
  7347. switch (type) {
  7348. case EncodingType::Gzip: return "gzip";
  7349. case EncodingType::Brotli: return "br";
  7350. case EncodingType::Zstd: return "zstd";
  7351. default: return "";
  7352. }
  7353. }
  7354. inline bool nocompressor::compress(const char *data, size_t data_length,
  7355. bool /*last*/, Callback callback) {
  7356. if (!data_length) { return true; }
  7357. return callback(data, data_length);
  7358. }
  7359. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7360. inline gzip_compressor::gzip_compressor() {
  7361. std::memset(&strm_, 0, sizeof(strm_));
  7362. strm_.zalloc = Z_NULL;
  7363. strm_.zfree = Z_NULL;
  7364. strm_.opaque = Z_NULL;
  7365. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  7366. Z_DEFAULT_STRATEGY) == Z_OK;
  7367. }
  7368. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  7369. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  7370. bool last, Callback callback) {
  7371. assert(is_valid_);
  7372. do {
  7373. constexpr size_t max_avail_in =
  7374. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  7375. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  7376. (std::min)(data_length, max_avail_in));
  7377. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  7378. data_length -= strm_.avail_in;
  7379. data += strm_.avail_in;
  7380. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  7381. auto ret = Z_OK;
  7382. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7383. do {
  7384. strm_.avail_out = static_cast<uInt>(buff.size());
  7385. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  7386. ret = deflate(&strm_, flush);
  7387. if (ret == Z_STREAM_ERROR) { return false; }
  7388. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  7389. return false;
  7390. }
  7391. } while (strm_.avail_out == 0);
  7392. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  7393. (flush == Z_NO_FLUSH && ret == Z_OK));
  7394. assert(strm_.avail_in == 0);
  7395. } while (data_length > 0);
  7396. return true;
  7397. }
  7398. inline gzip_decompressor::gzip_decompressor() {
  7399. std::memset(&strm_, 0, sizeof(strm_));
  7400. strm_.zalloc = Z_NULL;
  7401. strm_.zfree = Z_NULL;
  7402. strm_.opaque = Z_NULL;
  7403. // 15 is the value of wbits, which should be at the maximum possible value
  7404. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  7405. // that the stream type should be automatically detected either gzip or
  7406. // deflate.
  7407. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  7408. }
  7409. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  7410. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  7411. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  7412. Callback callback) {
  7413. assert(is_valid_);
  7414. auto ret = Z_OK;
  7415. do {
  7416. constexpr size_t max_avail_in =
  7417. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  7418. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  7419. (std::min)(data_length, max_avail_in));
  7420. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  7421. data_length -= strm_.avail_in;
  7422. data += strm_.avail_in;
  7423. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7424. while (strm_.avail_in > 0 && ret == Z_OK) {
  7425. strm_.avail_out = static_cast<uInt>(buff.size());
  7426. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  7427. ret = inflate(&strm_, Z_NO_FLUSH);
  7428. assert(ret != Z_STREAM_ERROR);
  7429. switch (ret) {
  7430. case Z_NEED_DICT:
  7431. case Z_DATA_ERROR:
  7432. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  7433. }
  7434. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  7435. return false;
  7436. }
  7437. }
  7438. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  7439. } while (data_length > 0);
  7440. return true;
  7441. }
  7442. #endif
  7443. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7444. inline brotli_compressor::brotli_compressor() {
  7445. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  7446. }
  7447. inline brotli_compressor::~brotli_compressor() {
  7448. BrotliEncoderDestroyInstance(state_);
  7449. }
  7450. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  7451. bool last, Callback callback) {
  7452. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7453. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  7454. auto available_in = data_length;
  7455. auto next_in = reinterpret_cast<const uint8_t *>(data);
  7456. for (;;) {
  7457. if (last) {
  7458. if (BrotliEncoderIsFinished(state_)) { break; }
  7459. } else {
  7460. if (!available_in) { break; }
  7461. }
  7462. auto available_out = buff.size();
  7463. auto next_out = buff.data();
  7464. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  7465. &available_out, &next_out, nullptr)) {
  7466. return false;
  7467. }
  7468. auto output_bytes = buff.size() - available_out;
  7469. if (output_bytes) {
  7470. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  7471. }
  7472. }
  7473. return true;
  7474. }
  7475. inline brotli_decompressor::brotli_decompressor() {
  7476. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  7477. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  7478. : BROTLI_DECODER_RESULT_ERROR;
  7479. }
  7480. inline brotli_decompressor::~brotli_decompressor() {
  7481. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  7482. }
  7483. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  7484. inline bool brotli_decompressor::decompress(const char *data,
  7485. size_t data_length,
  7486. Callback callback) {
  7487. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  7488. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  7489. return 0;
  7490. }
  7491. auto next_in = reinterpret_cast<const uint8_t *>(data);
  7492. size_t avail_in = data_length;
  7493. size_t total_out;
  7494. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  7495. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7496. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  7497. char *next_out = buff.data();
  7498. size_t avail_out = buff.size();
  7499. decoder_r = BrotliDecoderDecompressStream(
  7500. decoder_s, &avail_in, &next_in, &avail_out,
  7501. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  7502. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  7503. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  7504. }
  7505. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  7506. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  7507. }
  7508. #endif
  7509. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7510. inline zstd_compressor::zstd_compressor() {
  7511. ctx_ = ZSTD_createCCtx();
  7512. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  7513. }
  7514. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  7515. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  7516. bool last, Callback callback) {
  7517. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7518. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  7519. ZSTD_inBuffer input = {data, data_length, 0};
  7520. bool finished;
  7521. do {
  7522. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  7523. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  7524. if (ZSTD_isError(remaining)) { return false; }
  7525. if (!callback(buff.data(), output.pos)) { return false; }
  7526. finished = last ? (remaining == 0) : (input.pos == input.size);
  7527. } while (!finished);
  7528. return true;
  7529. }
  7530. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  7531. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  7532. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  7533. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  7534. Callback callback) {
  7535. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7536. ZSTD_inBuffer input = {data, data_length, 0};
  7537. while (input.pos < input.size) {
  7538. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  7539. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  7540. if (ZSTD_isError(remaining)) { return false; }
  7541. if (!callback(buff.data(), output.pos)) { return false; }
  7542. }
  7543. return true;
  7544. }
  7545. #endif
  7546. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  7547. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  7548. // unknown coding, and its payload would be handed back still compressed.
  7549. inline bool is_zlib_encoding(const std::string &encoding) {
  7550. return case_ignore::equal(encoding, "gzip") ||
  7551. case_ignore::equal(encoding, "deflate");
  7552. }
  7553. inline bool is_brotli_encoding(const std::string &encoding) {
  7554. return case_ignore::equal(encoding, "br");
  7555. }
  7556. inline bool is_zstd_encoding(const std::string &encoding) {
  7557. return case_ignore::equal(encoding, "zstd");
  7558. }
  7559. // Returns true if the content coding is one cpp-httplib is able to decompress
  7560. // when the corresponding support is compiled in.
  7561. inline bool is_known_content_encoding(const std::string &encoding) {
  7562. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  7563. is_zstd_encoding(encoding);
  7564. }
  7565. inline std::unique_ptr<decompressor>
  7566. create_decompressor(const std::string &encoding) {
  7567. std::unique_ptr<decompressor> decompressor;
  7568. if (is_zlib_encoding(encoding)) {
  7569. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7570. decompressor = detail::make_unique<gzip_decompressor>();
  7571. #endif
  7572. } else if (is_brotli_encoding(encoding)) {
  7573. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7574. decompressor = detail::make_unique<brotli_decompressor>();
  7575. #endif
  7576. } else if (is_zstd_encoding(encoding)) {
  7577. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7578. decompressor = detail::make_unique<zstd_decompressor>();
  7579. #endif
  7580. }
  7581. return decompressor;
  7582. }
  7583. // Returns the best available compressor and its Content-Encoding name.
  7584. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  7585. inline std::pair<std::unique_ptr<compressor>, const char *>
  7586. create_compressor() {
  7587. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7588. return {detail::make_unique<brotli_compressor>(), "br"};
  7589. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  7590. return {detail::make_unique<gzip_compressor>(), "gzip"};
  7591. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  7592. return {detail::make_unique<zstd_compressor>(), "zstd"};
  7593. #else
  7594. return {nullptr, nullptr};
  7595. #endif
  7596. }
  7597. inline bool is_prohibited_header_name(const std::string &name) {
  7598. // Field names are case-insensitive (RFC 9110 §5.1)
  7599. return case_ignore::equal(name, "REMOTE_ADDR") ||
  7600. case_ignore::equal(name, "REMOTE_PORT") ||
  7601. case_ignore::equal(name, "LOCAL_ADDR") ||
  7602. case_ignore::equal(name, "LOCAL_PORT");
  7603. }
  7604. inline bool has_header(const Headers &headers, const std::string &key) {
  7605. if (is_prohibited_header_name(key)) { return false; }
  7606. return headers.find(key) != headers.end();
  7607. }
  7608. inline const char *get_header_value(const Headers &headers,
  7609. const std::string &key, const char *def,
  7610. size_t id) {
  7611. if (is_prohibited_header_name(key)) {
  7612. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  7613. std::string msg = "Prohibited header name '" + key + "' is specified.";
  7614. throw std::invalid_argument(msg);
  7615. #else
  7616. return "";
  7617. #endif
  7618. }
  7619. auto rng = headers.equal_range(key);
  7620. auto it = bounded_next(rng.first, id, rng.second);
  7621. if (it != rng.second) { return it->second.c_str(); }
  7622. return def;
  7623. }
  7624. inline size_t get_header_value_count(const Headers &headers,
  7625. const std::string &key) {
  7626. return headers.count(key);
  7627. }
  7628. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  7629. // list may be sent as several field lines, and the combined field value is
  7630. // those values joined by commas in the order they were received. Callers that
  7631. // parse such a list must work on the combined value; reading only the first
  7632. // occurrence silently drops whatever the later field lines carry.
  7633. inline std::string get_combined_header_value(const Headers &headers,
  7634. const std::string &key) {
  7635. std::string combined;
  7636. auto rng = headers.equal_range(key);
  7637. for (auto it = rng.first; it != rng.second; ++it) {
  7638. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7639. // elements, so an empty field line must not contribute a bare comma to the
  7640. // combined value.
  7641. if (it->second.empty()) { continue; }
  7642. if (!combined.empty()) { combined += ", "; }
  7643. combined += it->second;
  7644. }
  7645. return combined;
  7646. }
  7647. inline bool has_header_token(const Headers &headers, const std::string &key,
  7648. const std::string &token) {
  7649. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7650. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7651. // several lines. Match complete tokens rather than searching the raw value,
  7652. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7653. auto rng = headers.equal_range(key);
  7654. for (auto it = rng.first; it != rng.second; ++it) {
  7655. const auto &value = it->second;
  7656. if (split_find(value.data(), value.data() + value.size(), ',',
  7657. [&](const char *b, const char *e) {
  7658. return case_ignore::equal(std::string(b, e), token);
  7659. })) {
  7660. return true;
  7661. }
  7662. }
  7663. return false;
  7664. }
  7665. template <typename Map>
  7666. inline typename Map::mapped_type
  7667. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7668. auto rng = m.equal_range(key);
  7669. auto it = bounded_next(rng.first, id, rng.second);
  7670. if (it != rng.second) { return it->second; }
  7671. return typename Map::mapped_type();
  7672. }
  7673. inline void set_header(Headers &headers, const std::string &key,
  7674. const std::string &val) {
  7675. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7676. }
  7677. // Drops the fields set_header() would refuse, from headers an application can
  7678. // fill directly: CR/LF in one would split the message.
  7679. inline void erase_invalid_fields(Headers &headers) {
  7680. for (auto it = headers.begin(); it != headers.end();) {
  7681. if (fields::is_field_valid(it->first, it->second)) {
  7682. ++it;
  7683. } else {
  7684. it = headers.erase(it);
  7685. }
  7686. }
  7687. }
  7688. inline bool read_headers(Stream &strm, Headers &headers) {
  7689. const auto bufsiz = 2048;
  7690. char buf[bufsiz];
  7691. stream_line_reader line_reader(strm, buf, bufsiz);
  7692. size_t header_count = 0;
  7693. for (;;) {
  7694. if (!line_reader.getline()) { return false; }
  7695. // Check if the line ends with CRLF.
  7696. auto line_terminator_len = 2;
  7697. if (line_reader.end_with_crlf()) {
  7698. // Blank line indicates end of headers.
  7699. if (line_reader.size() == 2) { break; }
  7700. } else {
  7701. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7702. // Blank line indicates end of headers.
  7703. if (line_reader.size() == 1) { break; }
  7704. line_terminator_len = 1;
  7705. #else
  7706. continue; // Skip invalid line.
  7707. #endif
  7708. }
  7709. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7710. // Check header count limit
  7711. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7712. // Exclude line terminator
  7713. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7714. if (!parse_header(line_reader.ptr(), end,
  7715. [&](const std::string &key, const std::string &val) {
  7716. headers.emplace(key, val);
  7717. })) {
  7718. return false;
  7719. }
  7720. header_count++;
  7721. }
  7722. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7723. // headers that have different values to prevent request smuggling.
  7724. auto cl_range = headers.equal_range("Content-Length");
  7725. if (cl_range.first != cl_range.second) {
  7726. const auto &first_val = cl_range.first->second;
  7727. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7728. if (it->second != first_val) { return false; }
  7729. }
  7730. }
  7731. return true;
  7732. }
  7733. // Parsed by hand: std::regex_match recurses once per character of the reason
  7734. // phrase, which a server can make as long as a whole line.
  7735. inline bool parse_status_line(const char *line, std::string &version,
  7736. int &status, std::string &reason) {
  7737. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7738. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7739. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7740. !is_ascii_digit(line[11])) {
  7741. return false;
  7742. }
  7743. auto p = line + 12;
  7744. auto reason_begin = p;
  7745. if (*p == ' ') {
  7746. reason_begin = ++p;
  7747. p += std::strcspn(p, "\r\n");
  7748. }
  7749. auto reason_end = p;
  7750. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7751. if (*p == '\r') { p++; }
  7752. #else
  7753. if (*p++ != '\r') { return false; }
  7754. #endif
  7755. if (*p++ != '\n' || *p != '\0') { return false; }
  7756. version.assign(line, 8);
  7757. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7758. reason.assign(reason_begin, reason_end);
  7759. return true;
  7760. }
  7761. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7762. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7763. struct WebSocketUpgradeResponse {
  7764. Error error = Error::Success;
  7765. int status = -1;
  7766. Headers headers;
  7767. std::string selected_subprotocol;
  7768. };
  7769. // Reads a response's status line and headers, leaving any body unread. An
  7770. // unparsable status line is no stream error; it just leaves `status` as is.
  7771. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7772. const auto bufsiz = 2048;
  7773. char buf[bufsiz];
  7774. stream_line_reader line_reader(strm, buf, bufsiz);
  7775. if (!line_reader.getline()) { return false; }
  7776. std::string version;
  7777. std::string reason;
  7778. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7779. return true;
  7780. }
  7781. return read_headers(strm, headers);
  7782. }
  7783. inline bool
  7784. read_websocket_upgrade_response(Stream &strm,
  7785. const std::string &expected_accept,
  7786. const std::string &offered_subprotocols,
  7787. WebSocketUpgradeResponse &upgrade) {
  7788. // The headers of a rejection are kept so the caller can see why the server
  7789. // refused the upgrade.
  7790. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7791. upgrade.error = Error::Read;
  7792. return false;
  7793. }
  7794. const auto &headers = upgrade.headers;
  7795. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7796. upgrade.error = Error::WebSocketHandshake;
  7797. return false;
  7798. }
  7799. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7800. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7801. upgrade.error = Error::WebSocketHandshake;
  7802. return false;
  7803. }
  7804. // Verify Connection: Upgrade
  7805. if (!has_header_token(headers, "Connection", "upgrade")) {
  7806. upgrade.error = Error::WebSocketHandshake;
  7807. return false;
  7808. }
  7809. // Verify Sec-WebSocket-Accept header value
  7810. auto it = headers.find("Sec-WebSocket-Accept");
  7811. if (it == headers.end() || it->second != expected_accept) {
  7812. upgrade.error = Error::WebSocketHandshake;
  7813. return false;
  7814. }
  7815. // Extract negotiated subprotocol
  7816. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7817. if (proto_it != headers.end()) {
  7818. upgrade.selected_subprotocol = proto_it->second;
  7819. }
  7820. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7821. if (!upgrade.selected_subprotocol.empty()) {
  7822. auto was_offered = false;
  7823. split(offered_subprotocols.data(),
  7824. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7825. [&](const char *b, const char *e) {
  7826. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7827. was_offered = true;
  7828. }
  7829. });
  7830. if (!was_offered) {
  7831. upgrade.error = Error::WebSocketHandshake;
  7832. return false;
  7833. }
  7834. }
  7835. return true;
  7836. }
  7837. enum class ReadContentResult {
  7838. Success, // Successfully read the content
  7839. PayloadTooLarge, // The content exceeds the specified payload limit
  7840. Error // An error occurred while reading the content
  7841. };
  7842. inline ReadContentResult read_content_with_length(
  7843. Stream &strm, size_t len, DownloadProgress progress,
  7844. ContentReceiverWithProgress out,
  7845. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7846. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7847. detail::BodyReader br;
  7848. br.stream = &strm;
  7849. br.has_content_length = true;
  7850. br.content_length = len;
  7851. br.payload_max_length = payload_max_length;
  7852. br.chunked = false;
  7853. br.bytes_read = 0;
  7854. br.last_error = Error::Success;
  7855. size_t r = 0;
  7856. while (r < len) {
  7857. auto read_len = static_cast<size_t>(len - r);
  7858. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7859. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7860. if (n <= 0) {
  7861. // Check if it was a payload size error
  7862. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7863. return ReadContentResult::PayloadTooLarge;
  7864. }
  7865. return ReadContentResult::Error;
  7866. }
  7867. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7868. return ReadContentResult::Error;
  7869. }
  7870. r += static_cast<size_t>(n);
  7871. if (progress) {
  7872. if (!progress(r, len)) { return ReadContentResult::Error; }
  7873. }
  7874. }
  7875. return ReadContentResult::Success;
  7876. }
  7877. inline ReadContentResult
  7878. read_content_without_length(Stream &strm, size_t payload_max_length,
  7879. ContentReceiverWithProgress out) {
  7880. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7881. size_t r = 0;
  7882. for (;;) {
  7883. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7884. if (n == 0) { return ReadContentResult::Success; }
  7885. if (n < 0) { return ReadContentResult::Error; }
  7886. // Check if adding this data would exceed the payload limit
  7887. if (payload_max_length > 0 &&
  7888. (r > payload_max_length ||
  7889. payload_max_length - r < static_cast<size_t>(n))) {
  7890. return ReadContentResult::PayloadTooLarge;
  7891. }
  7892. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7893. return ReadContentResult::Error;
  7894. }
  7895. r += static_cast<size_t>(n);
  7896. }
  7897. return ReadContentResult::Success;
  7898. }
  7899. template <typename T>
  7900. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7901. size_t payload_max_length,
  7902. ContentReceiverWithProgress out) {
  7903. detail::ChunkedDecoder dec(strm);
  7904. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7905. size_t total_len = 0;
  7906. for (;;) {
  7907. size_t chunk_offset = 0;
  7908. size_t chunk_total = 0;
  7909. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7910. if (n < 0) { return ReadContentResult::Error; }
  7911. if (n == 0) {
  7912. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7913. return ReadContentResult::Error;
  7914. }
  7915. return ReadContentResult::Success;
  7916. }
  7917. if (payload_max_length > 0 &&
  7918. (total_len > payload_max_length ||
  7919. payload_max_length - total_len < static_cast<size_t>(n))) {
  7920. return ReadContentResult::PayloadTooLarge;
  7921. }
  7922. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7923. return ReadContentResult::Error;
  7924. }
  7925. total_len += static_cast<size_t>(n);
  7926. }
  7927. }
  7928. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7929. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7930. // is the final transfer coding. A single field value may list several
  7931. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7932. // several Transfer-Encoding lines, which combine into one comma-separated
  7933. // list in the order the lines were received. Headers preserves that order,
  7934. // so the final coding is the last token of the last line. Match it
  7935. // case-insensitively rather than comparing the whole value against
  7936. // "chunked".
  7937. //
  7938. // Security: reading a chunked message as unframed leaves its body in the
  7939. // socket, where a keep-alive connection parses it as a smuggled request.
  7940. // Server::process_request() answers 400 and closes when the final coding is
  7941. // not chunked, so a request whose framing cannot be determined never
  7942. // reaches the "no body" path.
  7943. auto rng = headers.equal_range("Transfer-Encoding");
  7944. if (rng.first == rng.second) { return false; }
  7945. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7946. // combined list ending in nothing rather than inheriting the line before it.
  7947. std::string last_coding;
  7948. for (auto it = rng.first; it != rng.second; ++it) {
  7949. const auto &value = it->second;
  7950. last_coding.clear();
  7951. split(value.data(), value.data() + value.size(), ',',
  7952. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7953. }
  7954. return case_ignore::equal(last_coding, "chunked");
  7955. }
  7956. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7957. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7958. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7959. return msg.has_header("Transfer-Encoding") &&
  7960. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7961. }
  7962. inline bool has_conflicting_content_length(const Headers &headers) {
  7963. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7964. // Content-Length is framed ambiguously. The body readers here delimit it by
  7965. // the transfer coding and drop Content-Length, while an intermediary may do
  7966. // the reverse, so the two disagree on where the body ends and a reused
  7967. // connection is desynchronised (request/response smuggling). Content-Length:
  7968. // 0 is tolerated for compatibility with existing peers.
  7969. return has_header(headers, "Transfer-Encoding") &&
  7970. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7971. }
  7972. template <typename T, typename U>
  7973. bool prepare_content_receiver(T &x, int &status,
  7974. ContentReceiverWithProgress receiver,
  7975. bool decompress, size_t payload_max_length,
  7976. bool &exceed_payload_max_length, U callback) {
  7977. if (decompress) {
  7978. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7979. std::unique_ptr<decompressor> decompressor;
  7980. if (!encoding.empty()) {
  7981. // A coding we know about but were not built with is an error. An
  7982. // unrecognized coding (including "identity") is left alone and the
  7983. // payload is passed through as-is, since some servers misuse the header,
  7984. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7985. decompressor = detail::create_decompressor(encoding);
  7986. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7987. status = StatusCode::UnsupportedMediaType_415;
  7988. return false;
  7989. }
  7990. }
  7991. if (decompressor) {
  7992. if (decompressor->is_valid()) {
  7993. size_t decompressed_size = 0;
  7994. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7995. size_t off, size_t len) {
  7996. return decompressor->decompress(
  7997. buf, n, [&](const char *buf2, size_t n2) {
  7998. // Guard against zip-bomb: check
  7999. // decompressed size against limit.
  8000. if (payload_max_length > 0 &&
  8001. (decompressed_size >= payload_max_length ||
  8002. n2 > payload_max_length - decompressed_size)) {
  8003. exceed_payload_max_length = true;
  8004. return false;
  8005. }
  8006. decompressed_size += n2;
  8007. return receiver(buf2, n2, off, len);
  8008. });
  8009. };
  8010. return callback(std::move(out));
  8011. } else {
  8012. status = StatusCode::InternalServerError_500;
  8013. return false;
  8014. }
  8015. }
  8016. }
  8017. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  8018. size_t len) {
  8019. return receiver(buf, n, off, len);
  8020. };
  8021. return callback(std::move(out));
  8022. }
  8023. template <typename T>
  8024. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  8025. DownloadProgress progress,
  8026. ContentReceiverWithProgress receiver, bool decompress) {
  8027. bool exceed_payload_max_length = false;
  8028. return prepare_content_receiver(
  8029. x, status, std::move(receiver), decompress, payload_max_length,
  8030. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  8031. auto ret = true;
  8032. // Note: exceed_payload_max_length may also be set by the decompressor
  8033. // wrapper in prepare_content_receiver when the decompressed payload
  8034. // size exceeds the limit.
  8035. if (is_chunked_transfer_encoding(x.headers)) {
  8036. auto result = read_content_chunked(strm, x, payload_max_length, out);
  8037. if (result == ReadContentResult::Success) {
  8038. ret = true;
  8039. } else if (result == ReadContentResult::PayloadTooLarge) {
  8040. exceed_payload_max_length = true;
  8041. ret = false;
  8042. } else {
  8043. ret = false;
  8044. }
  8045. } else if (!has_header(x.headers, "Content-Length")) {
  8046. auto result =
  8047. read_content_without_length(strm, payload_max_length, out);
  8048. if (result == ReadContentResult::Success) {
  8049. ret = true;
  8050. } else if (result == ReadContentResult::PayloadTooLarge) {
  8051. exceed_payload_max_length = true;
  8052. ret = false;
  8053. } else {
  8054. ret = false;
  8055. }
  8056. } else {
  8057. auto is_invalid_value = false;
  8058. auto len = get_header_value_u64(x.headers, "Content-Length",
  8059. (std::numeric_limits<size_t>::max)(),
  8060. 0, is_invalid_value);
  8061. if (is_invalid_value) {
  8062. ret = false;
  8063. } else if (len > 0) {
  8064. auto result = read_content_with_length(
  8065. strm, len, std::move(progress), out, payload_max_length);
  8066. ret = (result == ReadContentResult::Success);
  8067. if (result == ReadContentResult::PayloadTooLarge) {
  8068. exceed_payload_max_length = true;
  8069. }
  8070. }
  8071. }
  8072. if (!ret) {
  8073. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  8074. : StatusCode::BadRequest_400;
  8075. }
  8076. return ret;
  8077. });
  8078. }
  8079. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  8080. const std::string &path) {
  8081. // Neither the method nor the request target may carry CR/LF, SP or other
  8082. // control octets; otherwise a value smuggled into either splits the request
  8083. // line and injects headers or a whole request.
  8084. if (!fields::is_token(method)) { return -1; }
  8085. if (!fields::is_request_target(path)) { return -1; }
  8086. std::string s = method;
  8087. s += ' ';
  8088. s += path;
  8089. s += " HTTP/1.1\r\n";
  8090. return strm.write(s.data(), s.size());
  8091. }
  8092. inline ssize_t write_response_line(Stream &strm, int status) {
  8093. std::string s = "HTTP/1.1 ";
  8094. s += std::to_string(status);
  8095. s += ' ';
  8096. s += httplib::status_message(status);
  8097. s += "\r\n";
  8098. return strm.write(s.data(), s.size());
  8099. }
  8100. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  8101. ssize_t write_len = 0;
  8102. for (const auto &x : headers) {
  8103. std::string s;
  8104. s = x.first;
  8105. s += ": ";
  8106. s += x.second;
  8107. s += "\r\n";
  8108. auto len = strm.write(s.data(), s.size());
  8109. if (len < 0) { return len; }
  8110. write_len += len;
  8111. }
  8112. auto len = strm.write("\r\n");
  8113. if (len < 0) { return len; }
  8114. write_len += len;
  8115. return write_len;
  8116. }
  8117. inline bool write_data(Stream &strm, const char *d, size_t l) {
  8118. size_t offset = 0;
  8119. while (offset < l) {
  8120. auto length = strm.write(d + offset, l - offset);
  8121. if (length < 0) { return false; }
  8122. offset += static_cast<size_t>(length);
  8123. }
  8124. return true;
  8125. }
  8126. template <typename T>
  8127. inline bool write_content_with_progress(Stream &strm,
  8128. const ContentProvider &content_provider,
  8129. size_t offset, size_t length,
  8130. T is_shutting_down,
  8131. const UploadProgress &upload_progress,
  8132. Error &error) {
  8133. size_t end_offset = offset + length;
  8134. size_t start_offset = offset;
  8135. auto ok = true;
  8136. auto finished = false;
  8137. DataSink data_sink;
  8138. data_sink.write = [&](const char *d, size_t l) -> bool {
  8139. if (ok) {
  8140. // Bytes past `length` would follow the framed body, where the peer reads
  8141. // them as the next message. Write only what fits and fail the rest.
  8142. if (l > end_offset - offset) {
  8143. l = end_offset - offset;
  8144. ok = false;
  8145. }
  8146. if (write_data(strm, d, l)) {
  8147. offset += l;
  8148. if (upload_progress && length > 0) {
  8149. size_t current_written = offset - start_offset;
  8150. if (!upload_progress(current_written, length)) {
  8151. ok = false;
  8152. return false;
  8153. }
  8154. }
  8155. } else {
  8156. ok = false;
  8157. }
  8158. }
  8159. return ok;
  8160. };
  8161. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  8162. // The body is framed by `length`, so a provider that reports itself done
  8163. // early has truncated it. Record that and let the short-body check below
  8164. // fail the write, rather than calling the provider again forever.
  8165. data_sink.done = [&]() { finished = true; };
  8166. while (offset < end_offset && !finished && !is_shutting_down()) {
  8167. auto last_offset = offset;
  8168. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  8169. error = Error::Write;
  8170. return false;
  8171. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  8172. error = Error::Canceled;
  8173. return false;
  8174. } else if (!ok) {
  8175. error = Error::Write;
  8176. return false;
  8177. }
  8178. // A provider that reports success without writing anything and without
  8179. // reporting itself done gets handed the same offset and length again on
  8180. // the next pass, so it would spin here for as long as the peer stays
  8181. // connected. Treat making no progress as a short body, like done() early.
  8182. if (!finished && offset == last_offset) {
  8183. error = Error::Write;
  8184. return false;
  8185. }
  8186. }
  8187. if (offset < end_offset) { // done() called early, or is_shutting_down()
  8188. error = Error::Write;
  8189. return false;
  8190. }
  8191. error = Error::Success;
  8192. return true;
  8193. }
  8194. template <typename T>
  8195. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  8196. size_t offset, size_t length, T is_shutting_down,
  8197. Error &error) {
  8198. return write_content_with_progress<T>(strm, content_provider, offset, length,
  8199. is_shutting_down, nullptr, error);
  8200. }
  8201. template <typename T>
  8202. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  8203. size_t offset, size_t length,
  8204. const T &is_shutting_down) {
  8205. auto error = Error::Success;
  8206. return write_content(strm, content_provider, offset, length, is_shutting_down,
  8207. error);
  8208. }
  8209. template <typename T>
  8210. inline bool
  8211. write_content_without_length(Stream &strm,
  8212. const ContentProvider &content_provider,
  8213. const T &is_shutting_down) {
  8214. size_t offset = 0;
  8215. auto data_available = true;
  8216. auto ok = true;
  8217. DataSink data_sink;
  8218. data_sink.write = [&](const char *d, size_t l) -> bool {
  8219. if (ok) {
  8220. offset += l;
  8221. if (!write_data(strm, d, l)) { ok = false; }
  8222. }
  8223. return ok;
  8224. };
  8225. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  8226. data_sink.done = [&](void) { data_available = false; };
  8227. while (data_available && !is_shutting_down()) {
  8228. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  8229. return false;
  8230. } else if (!content_provider(offset, 0, data_sink)) {
  8231. return false;
  8232. } else if (!ok) {
  8233. return false;
  8234. }
  8235. }
  8236. return !data_available; // true only if done() was called, false if shutting
  8237. // down
  8238. }
  8239. // Runs a known-length content provider to completion and compresses what it
  8240. // writes into `out`, chunk by chunk, without holding the identity form.
  8241. inline bool compress_content_provider(const ContentProvider &content_provider,
  8242. size_t length, compressor &cmp,
  8243. std::string &out) {
  8244. size_t offset = 0;
  8245. auto ok = true;
  8246. auto finished = false;
  8247. DataSink data_sink;
  8248. auto append = [&](const char *data, size_t data_len) {
  8249. out.append(data, data_len);
  8250. return true;
  8251. };
  8252. data_sink.write = [&](const char *d, size_t l) -> bool {
  8253. if (!ok) { return false; }
  8254. offset += l;
  8255. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  8256. return ok;
  8257. };
  8258. // The body is framed by `length`, so a provider that reports itself done
  8259. // early has truncated it; the short-body check below turns that into a
  8260. // failure rather than calling the provider again forever.
  8261. data_sink.done = [&]() { finished = true; };
  8262. while (offset < length && !finished) {
  8263. auto prev_offset = offset;
  8264. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  8265. return false;
  8266. }
  8267. // No Stream to block on here, so a provider that keeps returning true
  8268. // without writing would spin. Treat a pass that made no progress as a
  8269. // failure.
  8270. if (offset == prev_offset) { return false; }
  8271. }
  8272. if (offset != length) { return false; }
  8273. return cmp.compress(nullptr, 0, true, append);
  8274. }
  8275. // Serves `m` as the response body. `set_content_provider()` clears the coding
  8276. // and the file flag, so recording them has to come after; keeping all of it
  8277. // here means a third file-serving path cannot get that order wrong.
  8278. inline void set_file_content_provider(Response &res,
  8279. const std::shared_ptr<mmap> &m,
  8280. const std::string &content_type,
  8281. EncodingType encoding) {
  8282. // One read and one write move up to this much of the file at a time.
  8283. auto buf = std::make_shared<std::vector<char>>(
  8284. (std::min)(m->size(), size_t(256 * 1024)));
  8285. res.set_content_provider(
  8286. m->size(), content_type,
  8287. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  8288. // Never read past the file, which ends the response early if it has
  8289. // shrunk since it was opened.
  8290. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  8291. if (n == 0) { return false; }
  8292. sink.write(buf->data(), n);
  8293. return true;
  8294. });
  8295. res.is_file_content_provider_ = true;
  8296. res.content_coding_ = encoding;
  8297. }
  8298. template <typename T, typename U>
  8299. inline bool
  8300. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  8301. const T &is_shutting_down, U &compressor, Error &error) {
  8302. size_t offset = 0;
  8303. auto data_available = true;
  8304. auto ok = true;
  8305. DataSink data_sink;
  8306. data_sink.write = [&](const char *d, size_t l) -> bool {
  8307. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  8308. // to hand over is ordinary (an empty buffer popped off a queue), and a
  8309. // zero-length chunk is the terminator, so it must not be emitted here.
  8310. if (ok && l > 0) {
  8311. offset += l;
  8312. std::string payload;
  8313. if (compressor.compress(d, l, false,
  8314. [&](const char *data, size_t data_len) {
  8315. payload.append(data, data_len);
  8316. return true;
  8317. })) {
  8318. if (!payload.empty()) {
  8319. // Emit chunked response header and footer for each chunk
  8320. auto chunk =
  8321. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  8322. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  8323. }
  8324. } else {
  8325. ok = false;
  8326. }
  8327. }
  8328. return ok;
  8329. };
  8330. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  8331. auto done_with_trailer = [&](const Headers *trailer) {
  8332. if (!ok) { return; }
  8333. data_available = false;
  8334. std::string payload;
  8335. if (!compressor.compress(nullptr, 0, true,
  8336. [&](const char *data, size_t data_len) {
  8337. payload.append(data, data_len);
  8338. return true;
  8339. })) {
  8340. ok = false;
  8341. return;
  8342. }
  8343. if (!payload.empty()) {
  8344. // Emit chunked response header and footer for each chunk
  8345. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  8346. if (!write_data(strm, chunk.data(), chunk.size())) {
  8347. ok = false;
  8348. return;
  8349. }
  8350. }
  8351. constexpr const char done_marker[] = "0\r\n";
  8352. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  8353. // Trailer
  8354. if (trailer) {
  8355. for (const auto &kv : *trailer) {
  8356. // Skip fields with invalid names or values to prevent response
  8357. // splitting via CR/LF injection, matching set_header().
  8358. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  8359. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  8360. if (!write_data(strm, field_line.data(), field_line.size())) {
  8361. ok = false;
  8362. }
  8363. }
  8364. }
  8365. constexpr const char crlf[] = "\r\n";
  8366. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  8367. };
  8368. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  8369. data_sink.done_with_trailer = [&](const Headers &trailer) {
  8370. done_with_trailer(&trailer);
  8371. };
  8372. while (data_available && !is_shutting_down()) {
  8373. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  8374. error = Error::Write;
  8375. return false;
  8376. } else if (!content_provider(offset, 0, data_sink)) {
  8377. error = Error::Canceled;
  8378. return false;
  8379. } else if (!ok) {
  8380. error = Error::Write;
  8381. return false;
  8382. }
  8383. }
  8384. if (data_available) { // exited due to is_shutting_down(), not done()
  8385. error = Error::Write;
  8386. return false;
  8387. }
  8388. error = Error::Success;
  8389. return true;
  8390. }
  8391. template <typename T, typename U>
  8392. inline bool write_content_chunked(Stream &strm,
  8393. const ContentProvider &content_provider,
  8394. const T &is_shutting_down, U &compressor) {
  8395. auto error = Error::Success;
  8396. return write_content_chunked(strm, content_provider, is_shutting_down,
  8397. compressor, error);
  8398. }
  8399. template <typename T>
  8400. inline bool redirect(T &cli, Request &req, Response &res,
  8401. const std::string &path, const std::string &location,
  8402. Error &error) {
  8403. Request new_req = req;
  8404. new_req.path = path;
  8405. new_req.params.clear();
  8406. new_req.redirect_count_ -= 1;
  8407. if (res.status == StatusCode::SeeOther_303 &&
  8408. (req.method != "GET" && req.method != "HEAD")) {
  8409. new_req.method = "GET";
  8410. new_req.body.clear();
  8411. new_req.headers.clear();
  8412. new_req.content_length_ = 0;
  8413. new_req.content_provider_ = nullptr;
  8414. new_req.is_chunked_content_provider_ = false;
  8415. }
  8416. Response new_res;
  8417. auto ret = cli.send(new_req, new_res, error);
  8418. if (ret) {
  8419. req = std::move(new_req);
  8420. res = std::move(new_res);
  8421. if (res.location.empty()) { res.location = location; }
  8422. }
  8423. return ret;
  8424. }
  8425. inline std::string params_to_query_str(const Params &params) {
  8426. std::string query;
  8427. for (auto it = params.begin(); it != params.end(); ++it) {
  8428. if (it != params.begin()) { query += '&'; }
  8429. query += encode_query_component(it->first);
  8430. query += '=';
  8431. query += encode_query_component(it->second);
  8432. }
  8433. return query;
  8434. }
  8435. // Splits one "key=value" span of a query string at its first '='. A span with
  8436. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  8437. // "?flag" keeps its name.
  8438. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  8439. std::string &val) {
  8440. divide(b, static_cast<std::size_t>(e - b), '=',
  8441. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  8442. std::size_t rhs_size) {
  8443. key.assign(lhs_data, lhs_size);
  8444. val.assign(rhs_data, rhs_size);
  8445. });
  8446. }
  8447. inline void parse_query_text(const char *data, std::size_t size,
  8448. Params &params) {
  8449. std::set<std::string> cache;
  8450. split(data, data + size, '&', [&](const char *b, const char *e) {
  8451. std::string kv(b, e);
  8452. if (cache.find(kv) != cache.end()) { return; }
  8453. cache.insert(std::move(kv));
  8454. std::string key;
  8455. std::string val;
  8456. divide_query_pair(b, e, key, val);
  8457. if (!key.empty()) {
  8458. params.emplace(decode_query_component(key), decode_query_component(val));
  8459. }
  8460. });
  8461. }
  8462. inline void parse_query_text(const std::string &s, Params &params) {
  8463. parse_query_text(s.data(), s.size(), params);
  8464. }
  8465. // Normalize a query string by decoding and re-encoding each key/value pair
  8466. // while preserving the original parameter order. This avoids double-encoding
  8467. // and ensures consistent encoding. It works on the raw string rather than
  8468. // parsing into Params and re-serializing, because that round trip cannot
  8469. // reproduce the input: params_to_query_str() always emits '=', so a bare
  8470. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  8471. // duplicated pairs.
  8472. inline std::string normalize_query_string(const std::string &query) {
  8473. std::string result;
  8474. split(query.data(), query.data() + query.size(), '&',
  8475. [&](const char *b, const char *e) {
  8476. std::string key;
  8477. std::string val;
  8478. divide_query_pair(b, e, key, val);
  8479. if (!key.empty()) {
  8480. auto dec_key = decode_query_component(key);
  8481. auto dec_val = decode_query_component(val);
  8482. if (!result.empty()) { result += '&'; }
  8483. result += encode_query_component(dec_key);
  8484. if (!val.empty() || std::find(b, e, '=') != e) {
  8485. result += '=';
  8486. result += encode_query_component(dec_val);
  8487. }
  8488. }
  8489. });
  8490. return result;
  8491. }
  8492. // The query of a client's path: what follows '?', up to the fragment.
  8493. inline std::string query_of(const std::string &path) {
  8494. auto fragment_pos = path.find('#');
  8495. auto query_pos = path.find('?');
  8496. return query_pos < fragment_pos
  8497. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  8498. : std::string();
  8499. }
  8500. // Build the request target that goes on the wire from a caller-supplied path.
  8501. // Shared by the buffered send path and the streaming API so that both put the
  8502. // same bytes in the request line for the same input.
  8503. inline std::string encode_request_target(const std::string &uri,
  8504. bool path_encode) {
  8505. // The fragment stays with the client (RFC 9110 §7.1).
  8506. auto target = uri.substr(0, uri.find('#'));
  8507. // `substr(0, npos)` yields the whole string, which is what the no-query
  8508. // case needs.
  8509. auto query_pos = target.find('?');
  8510. auto path_part = target.substr(0, query_pos);
  8511. std::string query_part;
  8512. if (query_pos != std::string::npos) {
  8513. query_part = target.substr(query_pos + 1);
  8514. }
  8515. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  8516. if (!query_part.empty()) {
  8517. // When path encoding is disabled the caller has supplied an already-encoded
  8518. // target and expects the exact bytes to be sent on the wire, so skip
  8519. // normalization for the query too. Normalizing would decode-then-re-encode
  8520. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  8521. // which a strict RFC 3986 server decodes back as `+`, not a space).
  8522. if (path_encode) {
  8523. auto normalized = normalize_query_string(query_part);
  8524. if (!normalized.empty()) {
  8525. result += '?';
  8526. result += normalized;
  8527. }
  8528. } else {
  8529. result += '?';
  8530. result += query_part;
  8531. }
  8532. }
  8533. return result;
  8534. }
  8535. inline bool parse_multipart_boundary(const std::string &content_type,
  8536. std::string &boundary) {
  8537. std::map<std::string, std::string> params;
  8538. extract_media_type(content_type, &params);
  8539. auto it = params.find("boundary");
  8540. if (it == params.end()) { return false; }
  8541. boundary = it->second;
  8542. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  8543. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  8544. // bytes costs a nearly full comparison at nearly every position: the
  8545. // boundary's length multiplies the worst-case cost of scanning a body.
  8546. return !boundary.empty() && boundary.size() <= 70;
  8547. }
  8548. inline void parse_disposition_params(const std::string &s, Params &params) {
  8549. std::set<std::string> cache;
  8550. split_unquoted(
  8551. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  8552. std::string kv(b, e);
  8553. if (cache.find(kv) != cache.end()) { return; }
  8554. cache.insert(kv);
  8555. std::string key;
  8556. std::string val;
  8557. divide_param_pair(b, e, key, val);
  8558. if (!key.empty()) {
  8559. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  8560. }
  8561. });
  8562. }
  8563. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8564. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  8565. #else
  8566. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  8567. #endif
  8568. auto is_valid = [](const std::string &str) {
  8569. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  8570. };
  8571. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  8572. const auto pos = static_cast<size_t>(6);
  8573. const auto len = static_cast<size_t>(s.size() - 6);
  8574. auto all_valid_ranges = true;
  8575. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  8576. if (!all_valid_ranges) { return; }
  8577. const auto it = std::find(b, e, '-');
  8578. if (it == e) {
  8579. all_valid_ranges = false;
  8580. return;
  8581. }
  8582. const auto lhs = std::string(b, it);
  8583. const auto rhs = std::string(it + 1, e);
  8584. if (!is_valid(lhs) || !is_valid(rhs)) {
  8585. all_valid_ranges = false;
  8586. return;
  8587. }
  8588. ssize_t first = -1;
  8589. if (!lhs.empty()) {
  8590. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  8591. // would turn the range into a suffix range.
  8592. auto res =
  8593. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  8594. if (res.ec != std::errc{}) {
  8595. all_valid_ranges = false;
  8596. return;
  8597. }
  8598. }
  8599. ssize_t last = -1;
  8600. if (!rhs.empty()) {
  8601. // An overflowing last-byte-pos is past any content length, so keeping
  8602. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  8603. ssize_t v;
  8604. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  8605. if (res.ec == std::errc{}) { last = v; }
  8606. }
  8607. if ((first == -1 && last == -1) ||
  8608. (first != -1 && last != -1 && first > last)) {
  8609. all_valid_ranges = false;
  8610. return;
  8611. }
  8612. ranges.emplace_back(first, last);
  8613. });
  8614. return all_valid_ranges && !ranges.empty();
  8615. }
  8616. return false;
  8617. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8618. }
  8619. #else
  8620. } catch (...) { return false; }
  8621. #endif
  8622. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  8623. inline std::string remove_quoted_strings(const std::string &s) {
  8624. std::string out;
  8625. auto in_quotes = false;
  8626. for (size_t i = 0; i < s.size(); i++) {
  8627. if (s[i] == '"') {
  8628. in_quotes = !in_quotes;
  8629. } else if (!in_quotes) {
  8630. out += s[i];
  8631. } else if (s[i] == '\\') {
  8632. i++;
  8633. }
  8634. }
  8635. return out;
  8636. }
  8637. inline bool parse_accept_header(const std::string &s,
  8638. std::vector<std::string> &content_types) {
  8639. // Parameter values are not used here, so a quoted-string is dropped rather
  8640. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8641. if (s.find('"') != std::string::npos) {
  8642. return parse_accept_header(remove_quoted_strings(s), content_types);
  8643. }
  8644. content_types.clear();
  8645. // Empty string is considered valid (no preference)
  8646. if (s.empty()) { return true; }
  8647. struct AcceptEntry {
  8648. std::string media_type;
  8649. double quality;
  8650. int order;
  8651. };
  8652. std::vector<AcceptEntry> entries;
  8653. int order = 0;
  8654. bool has_invalid_entry = false;
  8655. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8656. // has to parse and ignore empty list elements, so a leading, trailing or
  8657. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8658. // split() skips them, and the header length limit bounds how many a sender
  8659. // can send, so ignoring all of them cannot be used as a denial-of-service
  8660. // vector.
  8661. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8662. std::string entry(b, e);
  8663. entry = trim_copy(entry);
  8664. AcceptEntry accept_entry;
  8665. accept_entry.order = order++;
  8666. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8667. accept_entry.media_type, accept_entry.quality)) {
  8668. has_invalid_entry = true;
  8669. return;
  8670. }
  8671. // Remove additional parameters from media type
  8672. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8673. // Basic validation of media type format
  8674. if (accept_entry.media_type.empty()) {
  8675. has_invalid_entry = true;
  8676. return;
  8677. }
  8678. // Check for basic media type format (should contain '/' or be '*')
  8679. if (accept_entry.media_type != "*" &&
  8680. accept_entry.media_type.find('/') == std::string::npos) {
  8681. has_invalid_entry = true;
  8682. return;
  8683. }
  8684. entries.push_back(std::move(accept_entry));
  8685. });
  8686. // Return false if any invalid entry was found
  8687. if (has_invalid_entry) { return false; }
  8688. // Sort by quality (descending), then by original order (ascending)
  8689. std::sort(entries.begin(), entries.end(),
  8690. [](const AcceptEntry &a, const AcceptEntry &b) {
  8691. if (a.quality != b.quality) {
  8692. return a.quality > b.quality; // Higher quality first
  8693. }
  8694. return a.order < b.order; // Earlier order first for same quality
  8695. });
  8696. // Extract sorted media types
  8697. content_types.reserve(entries.size());
  8698. for (auto &entry : entries) {
  8699. content_types.push_back(std::move(entry.media_type));
  8700. }
  8701. return true;
  8702. }
  8703. class FormDataParser {
  8704. public:
  8705. FormDataParser() = default;
  8706. void set_boundary(std::string &&boundary) {
  8707. boundary_ = std::move(boundary);
  8708. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8709. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8710. }
  8711. bool is_valid() const { return is_valid_; }
  8712. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8713. const ContentReceiver &content_callback) {
  8714. // Once the close delimiter has been seen the rest of the body is epilogue
  8715. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8716. // spread across reads is not copied in only to be erased right away.
  8717. if (state_ == 5) { return true; }
  8718. buf_append(buf, n);
  8719. while (buf_size() > 0) {
  8720. switch (state_) {
  8721. case 0: { // Initial boundary
  8722. auto pos = buf_find(dash_boundary_crlf_);
  8723. if (pos == buf_size()) {
  8724. // Not found yet: keep only a possible partial boundary at the tail so
  8725. // that a body which never contains the boundary cannot grow the
  8726. // buffer (and get rescanned from the start) without bound.
  8727. auto keep = dash_boundary_crlf_.size() - 1;
  8728. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8729. return true;
  8730. }
  8731. buf_erase(pos + dash_boundary_crlf_.size());
  8732. state_ = 1;
  8733. break;
  8734. }
  8735. case 1: { // New entry
  8736. clear_file_info();
  8737. header_searched_ = 0;
  8738. state_ = 2;
  8739. break;
  8740. }
  8741. case 2: { // Headers
  8742. // Resume where the last call stopped looking, so that a line arriving
  8743. // a few bytes at a time is not searched from its start each time.
  8744. auto pos = buf_find(crlf_, header_searched_);
  8745. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8746. while (pos < buf_size()) {
  8747. // Empty line
  8748. if (pos == 0) {
  8749. if (!header_callback(file_)) {
  8750. is_valid_ = false;
  8751. return false;
  8752. }
  8753. buf_erase(crlf_.size());
  8754. state_ = 3;
  8755. break;
  8756. }
  8757. // Check header count limit
  8758. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8759. is_valid_ = false;
  8760. return false;
  8761. }
  8762. header_count_++;
  8763. const auto header = buf_head(pos);
  8764. if (!parse_header(header.data(), header.data() + header.size(),
  8765. [&](const std::string &, const std::string &) {})) {
  8766. is_valid_ = false;
  8767. return false;
  8768. }
  8769. // Parse and emplace space trimmed headers into a map
  8770. if (!parse_header(
  8771. header.data(), header.data() + header.size(),
  8772. [&](const std::string &key, const std::string &val) {
  8773. file_.headers.emplace(key, val);
  8774. })) {
  8775. is_valid_ = false;
  8776. return false;
  8777. }
  8778. constexpr const char header_content_type[] = "Content-Type:";
  8779. if (start_with_case_ignore(header, header_content_type)) {
  8780. file_.content_type =
  8781. trim_copy(header.substr(str_len(header_content_type)));
  8782. } else {
  8783. std::string disposition_params;
  8784. if (parse_content_disposition(header, disposition_params)) {
  8785. Params params;
  8786. parse_disposition_params(disposition_params, params);
  8787. auto it = params.find("name");
  8788. if (it != params.end()) {
  8789. file_.name = it->second;
  8790. } else {
  8791. is_valid_ = false;
  8792. return false;
  8793. }
  8794. it = params.find("filename");
  8795. if (it != params.end()) { file_.filename = it->second; }
  8796. it = params.find("filename*");
  8797. if (it != params.end()) {
  8798. // RFC 5987: only UTF-8 encoding is allowed
  8799. const auto &val = it->second;
  8800. constexpr const char utf8_prefix[] = "UTF-8''";
  8801. constexpr size_t prefix_len = str_len(utf8_prefix);
  8802. if (val.size() > prefix_len &&
  8803. start_with_case_ignore(val, utf8_prefix)) {
  8804. file_.filename = decode_path_component(
  8805. val.substr(prefix_len)); // override...
  8806. } else {
  8807. is_valid_ = false;
  8808. return false;
  8809. }
  8810. }
  8811. }
  8812. }
  8813. buf_erase(pos + crlf_.size());
  8814. pos = buf_find(crlf_);
  8815. }
  8816. if (state_ != 3) {
  8817. // The CR of the CRLF may be the last byte so far.
  8818. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8819. return true;
  8820. }
  8821. break;
  8822. }
  8823. case 3: { // Body
  8824. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8825. auto pos = buf_find(crlf_dash_boundary_);
  8826. if (pos < buf_size()) {
  8827. if (!content_callback(buf_data(), pos)) {
  8828. is_valid_ = false;
  8829. return false;
  8830. }
  8831. buf_erase(pos + crlf_dash_boundary_.size());
  8832. state_ = 4;
  8833. } else {
  8834. auto len = buf_size() - crlf_dash_boundary_.size();
  8835. if (len > 0) {
  8836. if (!content_callback(buf_data(), len)) {
  8837. is_valid_ = false;
  8838. return false;
  8839. }
  8840. buf_erase(len);
  8841. }
  8842. return true;
  8843. }
  8844. break;
  8845. }
  8846. case 4: { // Boundary
  8847. if (crlf_.size() > buf_size()) { return true; }
  8848. if (buf_start_with(crlf_)) {
  8849. buf_erase(crlf_.size());
  8850. state_ = 1;
  8851. } else if (buf_start_with(dash_)) {
  8852. buf_erase(dash_.size());
  8853. is_valid_ = true;
  8854. state_ = 5;
  8855. } else {
  8856. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8857. // accepted after a boundary; RFC 2046 allows transport-padding in
  8858. // between, but this parser has never supported it. Either way the
  8859. // body is already destined to be rejected, so fail now instead of
  8860. // buffering the rest of it. Both are two bytes, so the check above
  8861. // already guarantees enough buffered data to decide.
  8862. is_valid_ = false;
  8863. return false;
  8864. }
  8865. break;
  8866. }
  8867. case 5: { // Epilogue
  8868. buf_erase(buf_size());
  8869. break;
  8870. }
  8871. }
  8872. }
  8873. return true;
  8874. }
  8875. private:
  8876. void clear_file_info() {
  8877. file_.name.clear();
  8878. file_.filename.clear();
  8879. file_.content_type.clear();
  8880. file_.headers.clear();
  8881. header_count_ = 0;
  8882. }
  8883. bool start_with_case_ignore(const std::string &a, const char *b,
  8884. size_t offset = 0) const {
  8885. const auto b_len = strlen(b);
  8886. if (a.size() < offset + b_len) { return false; }
  8887. for (size_t i = 0; i < b_len; i++) {
  8888. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8889. return false;
  8890. }
  8891. }
  8892. return true;
  8893. }
  8894. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8895. // Returns true if header matches, with the params portion in `params_out`.
  8896. bool parse_content_disposition(const std::string &header,
  8897. std::string &params_out) const {
  8898. constexpr const char prefix[] = "Content-Disposition:";
  8899. constexpr size_t prefix_len = str_len(prefix);
  8900. if (!start_with_case_ignore(header, prefix)) { return false; }
  8901. // Skip whitespace after "Content-Disposition:"
  8902. auto pos = prefix_len;
  8903. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8904. pos++;
  8905. }
  8906. // Match "form-data;" (case-insensitive)
  8907. constexpr const char form_data[] = "form-data;";
  8908. constexpr size_t form_data_len = str_len(form_data);
  8909. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8910. pos += form_data_len;
  8911. // Skip whitespace after "form-data;"
  8912. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8913. pos++;
  8914. }
  8915. params_out = header.substr(pos);
  8916. return true;
  8917. }
  8918. const std::string dash_ = "--";
  8919. const std::string crlf_ = "\r\n";
  8920. std::string boundary_;
  8921. std::string dash_boundary_crlf_;
  8922. std::string crlf_dash_boundary_;
  8923. size_t state_ = 0;
  8924. bool is_valid_ = false;
  8925. FormData file_;
  8926. size_t header_count_ = 0;
  8927. size_t header_searched_ = 0;
  8928. // Buffer
  8929. bool start_with(const std::string &a, size_t spos, size_t epos,
  8930. const std::string &b) const {
  8931. if (epos - spos < b.size()) { return false; }
  8932. for (size_t i = 0; i < b.size(); i++) {
  8933. if (a[i + spos] != b[i]) { return false; }
  8934. }
  8935. return true;
  8936. }
  8937. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8938. const char *buf_data() const { return &buf_[buf_spos_]; }
  8939. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8940. bool buf_start_with(const std::string &s) const {
  8941. return start_with(buf_, buf_spos_, buf_epos_, s);
  8942. }
  8943. size_t buf_find(const std::string &s, size_t from = 0) const {
  8944. auto c = s.front();
  8945. size_t off = buf_spos_ + from;
  8946. while (off < buf_epos_) {
  8947. auto pos = off;
  8948. while (true) {
  8949. if (pos == buf_epos_) { return buf_size(); }
  8950. if (buf_[pos] == c) { break; }
  8951. pos++;
  8952. }
  8953. auto remaining_size = buf_epos_ - pos;
  8954. if (s.size() > remaining_size) { return buf_size(); }
  8955. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8956. off = pos + 1;
  8957. }
  8958. return buf_size();
  8959. }
  8960. void buf_append(const char *data, size_t n) {
  8961. auto remaining_size = buf_size();
  8962. if (remaining_size > 0 && buf_spos_ > 0) {
  8963. for (size_t i = 0; i < remaining_size; i++) {
  8964. buf_[i] = buf_[buf_spos_ + i];
  8965. }
  8966. }
  8967. buf_spos_ = 0;
  8968. buf_epos_ = remaining_size;
  8969. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8970. for (size_t i = 0; i < n; i++) {
  8971. buf_[buf_epos_ + i] = data[i];
  8972. }
  8973. buf_epos_ += n;
  8974. }
  8975. void buf_erase(size_t size) { buf_spos_ += size; }
  8976. std::string buf_;
  8977. size_t buf_spos_ = 0;
  8978. size_t buf_epos_ = 0;
  8979. };
  8980. inline std::string random_string(size_t length) {
  8981. constexpr const char data[] =
  8982. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8983. std::string result(length, '\0');
  8984. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8985. for (auto &c : result) {
  8986. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8987. }
  8988. return result;
  8989. }
  8990. inline std::string make_multipart_data_boundary() {
  8991. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8992. }
  8993. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8994. auto valid = true;
  8995. for (size_t i = 0; i < boundary.size(); i++) {
  8996. auto c = boundary[i];
  8997. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8998. valid = false;
  8999. break;
  9000. }
  9001. }
  9002. return valid;
  9003. }
  9004. // Escape a multipart field name/filename following the WHATWG HTML standard
  9005. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  9006. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  9007. // With quoted = false, only CR and LF are escaped; this is for header values
  9008. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  9009. inline std::string escape_multipart_field(const std::string &s,
  9010. bool quoted = true) {
  9011. std::string result;
  9012. result.reserve(s.size());
  9013. for (auto c : s) {
  9014. switch (c) {
  9015. case '"':
  9016. if (quoted) {
  9017. result += "%22";
  9018. } else {
  9019. result += c;
  9020. }
  9021. break;
  9022. case '\\':
  9023. // A lone backslash would escape the character after it (RFC 9110
  9024. // 5.6.4).
  9025. if (quoted) { result += '\\'; }
  9026. result += c;
  9027. break;
  9028. case '\r': result += "%0D"; break;
  9029. case '\n': result += "%0A"; break;
  9030. default: result += c; break;
  9031. }
  9032. }
  9033. return result;
  9034. }
  9035. template <typename T>
  9036. inline std::string
  9037. serialize_multipart_formdata_item_begin(const T &item,
  9038. const std::string &boundary) {
  9039. std::string body = "--" + boundary + "\r\n";
  9040. body += "Content-Disposition: form-data; name=\"" +
  9041. escape_multipart_field(item.name) + "\"";
  9042. if (!item.filename.empty()) {
  9043. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  9044. }
  9045. body += "\r\n";
  9046. if (!item.content_type.empty()) {
  9047. body +=
  9048. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  9049. "\r\n";
  9050. }
  9051. body += "\r\n";
  9052. return body;
  9053. }
  9054. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  9055. inline std::string
  9056. serialize_multipart_formdata_finish(const std::string &boundary) {
  9057. return "--" + boundary + "--\r\n";
  9058. }
  9059. inline std::string
  9060. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  9061. return "multipart/form-data; boundary=" + boundary;
  9062. }
  9063. inline std::string
  9064. serialize_multipart_formdata(const UploadFormDataItems &items,
  9065. const std::string &boundary, bool finish = true) {
  9066. std::string body;
  9067. for (const auto &item : items) {
  9068. body += serialize_multipart_formdata_item_begin(item, boundary);
  9069. body += item.content + serialize_multipart_formdata_item_end();
  9070. }
  9071. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  9072. return body;
  9073. }
  9074. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  9075. const std::string &boundary) {
  9076. size_t total = 0;
  9077. for (const auto &item : items) {
  9078. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  9079. total += item.content.size();
  9080. total += serialize_multipart_formdata_item_end().size();
  9081. }
  9082. total += serialize_multipart_formdata_finish(boundary).size();
  9083. return total;
  9084. }
  9085. struct MultipartSegment {
  9086. const char *data;
  9087. size_t size;
  9088. };
  9089. // NOTE: items must outlive the returned ContentProvider
  9090. // (safe for synchronous use inside Post/Put/Patch)
  9091. inline ContentProvider
  9092. make_multipart_content_provider(const UploadFormDataItems &items,
  9093. const std::string &boundary) {
  9094. // Own the per-item header strings and the finish string
  9095. std::vector<std::string> owned;
  9096. owned.reserve(items.size() + 1);
  9097. for (const auto &item : items)
  9098. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  9099. owned.push_back(serialize_multipart_formdata_finish(boundary));
  9100. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  9101. std::vector<MultipartSegment> segs;
  9102. segs.reserve(items.size() * 3 + 1);
  9103. static const char crlf[] = "\r\n";
  9104. for (size_t i = 0; i < items.size(); i++) {
  9105. segs.push_back({owned[i].data(), owned[i].size()});
  9106. segs.push_back({items[i].content.data(), items[i].content.size()});
  9107. segs.push_back({crlf, 2});
  9108. }
  9109. segs.push_back({owned.back().data(), owned.back().size()});
  9110. struct MultipartState {
  9111. std::vector<std::string> owned;
  9112. std::vector<MultipartSegment> segs;
  9113. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  9114. };
  9115. auto state = std::make_shared<MultipartState>();
  9116. state->owned = std::move(owned);
  9117. // `segs` holds raw pointers into owned strings; std::string move preserves
  9118. // the data pointer, so these pointers remain valid after the move above.
  9119. state->segs = std::move(segs);
  9120. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  9121. // Buffer multiple small segments into fewer, larger writes to avoid
  9122. // excessive TCP packets when there are many form data items (#2410)
  9123. auto &buf = state->buf;
  9124. auto buf_size = buf.size();
  9125. size_t buf_len = 0;
  9126. size_t remaining = length;
  9127. // Find the first segment containing 'offset'
  9128. size_t pos = 0;
  9129. size_t seg_idx = 0;
  9130. for (; seg_idx < state->segs.size(); seg_idx++) {
  9131. const auto &seg = state->segs[seg_idx];
  9132. if (seg.size > 0 && offset - pos < seg.size) { break; }
  9133. pos += seg.size;
  9134. }
  9135. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  9136. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  9137. const auto &seg = state->segs[seg_idx];
  9138. size_t available = seg.size - seg_offset;
  9139. size_t to_copy = (std::min)(available, remaining);
  9140. const char *src = seg.data + seg_offset;
  9141. seg_offset = 0; // only the first segment has a non-zero offset
  9142. while (to_copy > 0) {
  9143. size_t space = buf_size - buf_len;
  9144. size_t chunk = (std::min)(to_copy, space);
  9145. std::memcpy(buf.data() + buf_len, src, chunk);
  9146. buf_len += chunk;
  9147. src += chunk;
  9148. to_copy -= chunk;
  9149. remaining -= chunk;
  9150. if (buf_len == buf_size) {
  9151. if (!sink.write(buf.data(), buf_len)) { return false; }
  9152. buf_len = 0;
  9153. }
  9154. }
  9155. }
  9156. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  9157. return true;
  9158. };
  9159. }
  9160. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  9161. if (ranges.size() <= 1) return;
  9162. // Sort ranges by start position
  9163. std::sort(ranges.begin(), ranges.end(),
  9164. [](const Range &a, const Range &b) { return a.first < b.first; });
  9165. Ranges coalesced;
  9166. coalesced.reserve(ranges.size());
  9167. for (auto &r : ranges) {
  9168. auto first_pos = r.first;
  9169. auto last_pos = r.second;
  9170. // Handle special cases like in range_error
  9171. if (first_pos == -1 && last_pos == -1) {
  9172. first_pos = 0;
  9173. last_pos = static_cast<ssize_t>(content_length);
  9174. }
  9175. if (first_pos == -1) {
  9176. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  9177. last_pos = static_cast<ssize_t>(content_length) - 1;
  9178. }
  9179. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  9180. last_pos = static_cast<ssize_t>(content_length) - 1;
  9181. }
  9182. // Skip invalid ranges
  9183. if (!(0 <= first_pos && first_pos <= last_pos &&
  9184. last_pos < static_cast<ssize_t>(content_length))) {
  9185. continue;
  9186. }
  9187. // Coalesce with previous range if overlapping or adjacent (but not
  9188. // identical)
  9189. if (!coalesced.empty()) {
  9190. auto &prev = coalesced.back();
  9191. // Check if current range overlaps or is adjacent to previous range
  9192. // but don't coalesce identical ranges (allow duplicates)
  9193. if (first_pos <= prev.second + 1 &&
  9194. !(first_pos == prev.first && last_pos == prev.second)) {
  9195. // Extend the previous range
  9196. prev.second = (std::max)(prev.second, last_pos);
  9197. continue;
  9198. }
  9199. }
  9200. // Add new range
  9201. coalesced.emplace_back(first_pos, last_pos);
  9202. }
  9203. ranges = std::move(coalesced);
  9204. }
  9205. inline bool range_error(Request &req, Response &res) {
  9206. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  9207. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  9208. req.ranges.clear();
  9209. if (res.status == StatusCode::PartialContent_206) {
  9210. res.status = StatusCode::OK_200;
  9211. }
  9212. return false;
  9213. }
  9214. ssize_t content_len = static_cast<ssize_t>(
  9215. res.content_length_ ? res.content_length_ : res.body.size());
  9216. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  9217. size_t overwrapping_count = 0;
  9218. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  9219. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  9220. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  9221. // Too many ranges
  9222. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  9223. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  9224. return true;
  9225. }
  9226. for (auto &r : req.ranges) {
  9227. auto &first_pos = r.first;
  9228. auto &last_pos = r.second;
  9229. if (first_pos == -1 && last_pos == -1) {
  9230. first_pos = 0;
  9231. last_pos = content_len;
  9232. }
  9233. // RFC 9110 14.1.2: a suffix-length longer than the representation
  9234. // selects the entire representation.
  9235. if (first_pos == -1) {
  9236. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  9237. last_pos = content_len - 1;
  9238. }
  9239. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  9240. // A client can limit the number of bytes requested without knowing the
  9241. // size of the selected representation. If the last-pos value is absent,
  9242. // or if the value is greater than or equal to the current length of the
  9243. // representation data, the byte range is interpreted as the remainder of
  9244. // the representation (i.e., the server replaces the value of last-pos
  9245. // with a value that is one less than the current length of the selected
  9246. // representation).
  9247. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  9248. if (last_pos == -1 || last_pos >= content_len) {
  9249. last_pos = content_len - 1;
  9250. }
  9251. // Range must be within content length
  9252. if (!(0 <= first_pos && first_pos <= last_pos &&
  9253. last_pos <= content_len - 1)) {
  9254. return true;
  9255. }
  9256. // Request must not have more than two overlapping ranges
  9257. for (const auto &processed_range : processed_ranges) {
  9258. if (!(last_pos < processed_range.first ||
  9259. first_pos > processed_range.second)) {
  9260. overwrapping_count++;
  9261. if (overwrapping_count > 2) { return true; }
  9262. break; // Only count once per range
  9263. }
  9264. }
  9265. processed_ranges.emplace_back(first_pos, last_pos);
  9266. }
  9267. // After validation, coalesce overlapping ranges as per RFC 9110
  9268. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  9269. }
  9270. return false;
  9271. }
  9272. inline std::pair<size_t, size_t>
  9273. get_range_offset_and_length(Range r, size_t content_length) {
  9274. assert(r.first != -1 && r.second != -1);
  9275. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  9276. assert(r.first <= r.second &&
  9277. r.second < static_cast<ssize_t>(content_length));
  9278. (void)(content_length);
  9279. return std::make_pair(static_cast<size_t>(r.first),
  9280. static_cast<size_t>(r.second - r.first) + 1);
  9281. }
  9282. inline std::string make_content_range_header_field(
  9283. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  9284. auto st = offset_and_length.first;
  9285. auto ed = st + offset_and_length.second - 1;
  9286. std::string field = "bytes ";
  9287. field += std::to_string(st);
  9288. field += '-';
  9289. field += std::to_string(ed);
  9290. field += '/';
  9291. field += std::to_string(content_length);
  9292. return field;
  9293. }
  9294. template <typename SToken, typename CToken, typename Content>
  9295. bool process_multipart_ranges_data(const Request &req,
  9296. const std::string &boundary,
  9297. const std::string &content_type,
  9298. size_t content_length, SToken stoken,
  9299. CToken ctoken, Content content) {
  9300. for (size_t i = 0; i < req.ranges.size(); i++) {
  9301. ctoken("--");
  9302. stoken(boundary);
  9303. ctoken("\r\n");
  9304. if (!content_type.empty()) {
  9305. ctoken("Content-Type: ");
  9306. stoken(content_type);
  9307. ctoken("\r\n");
  9308. }
  9309. auto offset_and_length =
  9310. get_range_offset_and_length(req.ranges[i], content_length);
  9311. ctoken("Content-Range: ");
  9312. stoken(make_content_range_header_field(offset_and_length, content_length));
  9313. ctoken("\r\n");
  9314. ctoken("\r\n");
  9315. if (!content(offset_and_length.first, offset_and_length.second)) {
  9316. return false;
  9317. }
  9318. ctoken("\r\n");
  9319. }
  9320. ctoken("--");
  9321. stoken(boundary);
  9322. ctoken("--");
  9323. return true;
  9324. }
  9325. inline void make_multipart_ranges_data(const Request &req, Response &res,
  9326. const std::string &boundary,
  9327. const std::string &content_type,
  9328. size_t content_length,
  9329. std::string &data) {
  9330. process_multipart_ranges_data(
  9331. req, boundary, content_type, content_length,
  9332. [&](const std::string &token) { data += token; },
  9333. [&](const std::string &token) { data += token; },
  9334. [&](size_t offset, size_t length) {
  9335. assert(offset + length <= content_length);
  9336. data += res.body.substr(offset, length);
  9337. return true;
  9338. });
  9339. }
  9340. inline size_t get_multipart_ranges_data_length(const Request &req,
  9341. const std::string &boundary,
  9342. const std::string &content_type,
  9343. size_t content_length) {
  9344. size_t data_length = 0;
  9345. process_multipart_ranges_data(
  9346. req, boundary, content_type, content_length,
  9347. [&](const std::string &token) { data_length += token.size(); },
  9348. [&](const std::string &token) { data_length += token.size(); },
  9349. [&](size_t /*offset*/, size_t length) {
  9350. data_length += length;
  9351. return true;
  9352. });
  9353. return data_length;
  9354. }
  9355. template <typename T>
  9356. inline bool
  9357. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  9358. const std::string &boundary,
  9359. const std::string &content_type,
  9360. size_t content_length, const T &is_shutting_down) {
  9361. return process_multipart_ranges_data(
  9362. req, boundary, content_type, content_length,
  9363. [&](const std::string &token) { strm.write(token); },
  9364. [&](const std::string &token) { strm.write(token); },
  9365. [&](size_t offset, size_t length) {
  9366. return write_content(strm, res.content_provider_, offset, length,
  9367. is_shutting_down);
  9368. });
  9369. }
  9370. inline bool has_framed_body(const Request &req) {
  9371. return is_chunked_transfer_encoding(req.headers) ||
  9372. req.get_header_value_u64("Content-Length") > 0;
  9373. }
  9374. inline bool expect_content(const Request &req) {
  9375. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  9376. req.method == "DELETE") {
  9377. return true;
  9378. }
  9379. return has_framed_body(req);
  9380. }
  9381. #ifdef _WIN32
  9382. class WSInit {
  9383. public:
  9384. WSInit() {
  9385. WSADATA wsaData;
  9386. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  9387. }
  9388. ~WSInit() {
  9389. if (is_valid_) WSACleanup();
  9390. }
  9391. bool is_valid_ = false;
  9392. };
  9393. static WSInit wsinit_;
  9394. #endif
  9395. inline std::string unescape_quoted_pairs(const std::string &s) {
  9396. std::string out;
  9397. out.reserve(s.size());
  9398. for (size_t i = 0; i < s.size(); i++) {
  9399. if (s[i] == '\\' && i + 1 < s.size()) {
  9400. out += s[++i];
  9401. } else {
  9402. out += s[i];
  9403. }
  9404. }
  9405. return out;
  9406. }
  9407. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  9408. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  9409. // quoted-pair, so the recipient recovers the original value.
  9410. inline std::string escape_quoted_pairs(const std::string &s) {
  9411. std::string out;
  9412. out.reserve(s.size());
  9413. for (auto c : s) {
  9414. if (c == '\\' || c == '"') { out += '\\'; }
  9415. out += c;
  9416. }
  9417. return out;
  9418. }
  9419. // RFC 9110 Section 11.6.1 defines a challenge list as
  9420. // WWW-Authenticate = #challenge
  9421. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  9422. // auth-param = token BWS "=" BWS ( token / quoted-string )
  9423. // so a server may offer several schemes, each with its own comma-separated
  9424. // auth-param list, in either order and either as separate field lines or
  9425. // packed into one. Splitting on every comma would break apart a challenge's
  9426. // own param list; splitting only on the first space would miss a Digest
  9427. // challenge that isn't first. Split on commas that aren't inside a
  9428. // quoted-string instead (split_unquoted), then track which scheme each
  9429. // resulting segment belongs to: a segment whose text before "=" contains
  9430. // whitespace (or that has no "=" at all) starts a new challenge named by its
  9431. // leading token.
  9432. inline bool parse_www_authenticate(const Response &res,
  9433. std::map<std::string, std::string> &auth,
  9434. bool is_proxy) {
  9435. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  9436. auto combined = get_combined_header_value(res.headers, auth_key);
  9437. if (combined.empty()) { return false; }
  9438. auto found_digest = false;
  9439. auto in_digest_challenge = false;
  9440. split_unquoted(
  9441. combined.data(), combined.data() + combined.size(), ',',
  9442. [&](const char *b, const char *e) {
  9443. std::string segment(b, e);
  9444. auto eq_pos = segment.find('=');
  9445. // BWS is allowed on both sides of "=", so the text naming the key (or,
  9446. // for the first segment of a challenge, "<scheme> <key>") must be
  9447. // trimmed before its boundaries are inspected.
  9448. auto key_part = trim_copy(
  9449. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  9450. auto space_pos = key_part.find_last_of(" \t");
  9451. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  9452. // "<scheme>[ <key>]" starts a new challenge.
  9453. auto scheme_end =
  9454. space_pos == std::string::npos ? key_part.size() : space_pos;
  9455. // RFC 7616 Section 3.7: a server may offer more than one Digest
  9456. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  9457. // from one challenge is never paired with another's algorithm.
  9458. in_digest_challenge =
  9459. !found_digest &&
  9460. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  9461. if (in_digest_challenge) { found_digest = true; }
  9462. if (space_pos == std::string::npos) {
  9463. // Bare scheme (or a token68), no auth-param on this segment.
  9464. return;
  9465. }
  9466. key_part = key_part.substr(space_pos + 1);
  9467. }
  9468. if (!in_digest_challenge) { return; }
  9469. auto val = trim_copy(segment.substr(eq_pos + 1));
  9470. auto unquoted = trim_double_quotes_copy(val);
  9471. if (unquoted.size() != val.size()) {
  9472. unquoted = unescape_quoted_pairs(unquoted);
  9473. }
  9474. auth[std::move(key_part)] = std::move(unquoted);
  9475. });
  9476. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  9477. // make_digest_authentication_header() dereferences both unconditionally, so
  9478. // a challenge missing either can't produce a usable Authorization header.
  9479. // Treat it the same as no Digest challenge at all.
  9480. return found_digest && auth.find("realm") != auth.end() &&
  9481. auth.find("nonce") != auth.end();
  9482. }
  9483. class ContentProviderAdapter {
  9484. public:
  9485. explicit ContentProviderAdapter(
  9486. ContentProviderWithoutLength &&content_provider)
  9487. : content_provider_(std::move(content_provider)) {}
  9488. bool operator()(size_t offset, size_t, DataSink &sink) {
  9489. return content_provider_(offset, sink);
  9490. }
  9491. private:
  9492. ContentProviderWithoutLength content_provider_;
  9493. };
  9494. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  9495. namespace fields {
  9496. inline bool is_token_char(char c) {
  9497. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  9498. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  9499. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  9500. }
  9501. inline bool is_token(const std::string &s) {
  9502. if (s.empty()) { return false; }
  9503. for (auto c : s) {
  9504. if (!is_token_char(c)) { return false; }
  9505. }
  9506. return true;
  9507. }
  9508. inline bool is_field_name(const std::string &s) { return is_token(s); }
  9509. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  9510. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  9511. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  9512. inline bool is_field_content(const std::string &s) {
  9513. if (s.empty()) { return true; }
  9514. if (s.size() == 1) {
  9515. return is_field_vchar(s[0]);
  9516. } else if (s.size() == 2) {
  9517. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  9518. } else {
  9519. size_t i = 0;
  9520. if (!is_field_vchar(s[i])) { return false; }
  9521. i++;
  9522. while (i < s.size() - 1) {
  9523. auto c = s[i++];
  9524. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  9525. } else {
  9526. return false;
  9527. }
  9528. }
  9529. return is_field_vchar(s[i]);
  9530. }
  9531. }
  9532. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  9533. inline bool is_field_valid(const std::string &name, const std::string &value) {
  9534. return is_field_name(name) && is_field_value(value);
  9535. }
  9536. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  9537. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  9538. inline bool is_request_target(const std::string &s) {
  9539. return std::all_of(s.begin(), s.end(), is_field_vchar);
  9540. }
  9541. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  9542. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  9543. inline bool is_host(const std::string &s) {
  9544. return std::all_of(s.begin(), s.end(), [](char c) {
  9545. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  9546. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9547. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9548. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  9549. });
  9550. }
  9551. } // namespace fields
  9552. // Built in memory first, like ClientImpl::write_request, so a rejected header
  9553. // never leaves a partial request on the wire.
  9554. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  9555. BufferStream bstrm;
  9556. if (write_request_line(bstrm, req.method, req.path) < 0) {
  9557. error = Error::Write;
  9558. return false;
  9559. }
  9560. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  9561. return false;
  9562. }
  9563. const auto &data = bstrm.get_buffer();
  9564. if (!write_data(strm, data.data(), data.size())) {
  9565. error = Error::Write;
  9566. return false;
  9567. }
  9568. return true;
  9569. }
  9570. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  9571. WebSocketUpgradeResponse &upgrade) {
  9572. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  9573. std::string key_bytes(16, '\0');
  9574. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  9575. key_bytes.size());
  9576. auto client_key = base64_encode(key_bytes);
  9577. req.headers.erase("Upgrade");
  9578. req.headers.erase("Connection");
  9579. req.headers.erase("Sec-WebSocket-Key");
  9580. req.headers.erase("Sec-WebSocket-Version");
  9581. req.headers.emplace("Upgrade", "websocket");
  9582. req.headers.emplace("Connection", "Upgrade");
  9583. req.headers.emplace("Sec-WebSocket-Key", client_key);
  9584. req.headers.emplace("Sec-WebSocket-Version", "13");
  9585. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  9586. // Verify 101 response and Sec-WebSocket-Accept header
  9587. auto expected_accept = websocket_accept_key(client_key);
  9588. auto offered_subprotocols =
  9589. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  9590. return read_websocket_upgrade_response(strm, expected_accept,
  9591. offered_subprotocols, upgrade);
  9592. }
  9593. inline bool is_ip_address(const std::string &host) {
  9594. struct in_addr addr4;
  9595. struct in6_addr addr6;
  9596. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  9597. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  9598. }
  9599. // One spelling for an IPv6 address, and the IPv4 one for an IPv4-mapped IPv6
  9600. // address, which is how a dual-stack socket reports an IPv4 peer. Anything
  9601. // else, including an address with a zone ID, is returned as it is.
  9602. inline std::string canonical_ip(const std::string &addr) {
  9603. struct in6_addr addr6;
  9604. if (addr.find('%') != std::string::npos ||
  9605. inet_pton(AF_INET6, addr.c_str(), &addr6) != 1) {
  9606. return addr;
  9607. }
  9608. char buf[INET6_ADDRSTRLEN];
  9609. if (IN6_IS_ADDR_V4MAPPED(&addr6)) {
  9610. return inet_ntop(AF_INET, &addr6.s6_addr[12], buf, sizeof(buf)) ? buf
  9611. : addr;
  9612. }
  9613. return inet_ntop(AF_INET6, &addr6, buf, sizeof(buf)) ? buf : addr;
  9614. }
  9615. // `trusted_proxies` holds canonical_ip() spellings.
  9616. inline bool is_trusted_proxy(const std::string &addr,
  9617. const std::vector<std::string> &trusted_proxies) {
  9618. if (trusted_proxies.empty()) { return false; }
  9619. return std::find(trusted_proxies.begin(), trusted_proxies.end(),
  9620. canonical_ip(addr)) != trusted_proxies.end();
  9621. }
  9622. // Resolve where a client should connect for `host`, honoring a user-supplied
  9623. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  9624. // supplying the Host header and SNI; only the connection target changes.
  9625. //
  9626. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  9627. // path. Anything else goes to `connect_host`, which create_socket resolves as
  9628. // a name, or uses as the socket path when the address family is AF_UNIX. An
  9629. // absent or empty mapping leaves `host` as the connection target; without the
  9630. // empty check the value would reach getaddrinfo as a null node and silently
  9631. // resolve to loopback.
  9632. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  9633. const std::string &host, std::string &connect_host,
  9634. std::string &ip) {
  9635. connect_host = host;
  9636. ip.clear();
  9637. auto it = addr_map.find(host);
  9638. if (it == addr_map.end() || it->second.empty()) { return; }
  9639. if (is_ip_address(it->second)) {
  9640. ip = it->second;
  9641. } else {
  9642. connect_host = it->second;
  9643. }
  9644. }
  9645. } // namespace detail
  9646. /*
  9647. * Group 2: detail namespace - SSL common utilities
  9648. */
  9649. #ifdef CPPHTTPLIB_SSL_ENABLED
  9650. namespace detail {
  9651. class SSLSocketStream final : public Stream {
  9652. public:
  9653. SSLSocketStream(
  9654. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9655. time_t read_timeout_usec, time_t write_timeout_sec,
  9656. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9657. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9658. (std::chrono::steady_clock::time_point::min)());
  9659. ~SSLSocketStream() override;
  9660. bool is_readable() const override;
  9661. bool wait_readable() const override;
  9662. bool wait_writable() const override;
  9663. bool is_peer_alive() const override;
  9664. ssize_t read(char *ptr, size_t size) override;
  9665. ssize_t write(const char *ptr, size_t size) override;
  9666. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9667. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9668. socket_t socket() const override;
  9669. time_t duration() const override;
  9670. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9671. void set_max_timeout(time_t msec) override;
  9672. void set_read_interrupt(std::function<bool()> interrupted) override;
  9673. // See SocketStream::set_readable_hint().
  9674. void set_readable_hint() { readable_hint_ = true; }
  9675. // The error from the last read() or write() that failed in the TLS layer,
  9676. // with code Success if none did
  9677. const tls::TlsError &tls_error() const { return tls_error_; }
  9678. private:
  9679. bool ensure_readable();
  9680. socket_t sock_;
  9681. tls::session_t session_;
  9682. time_t read_timeout_sec_;
  9683. time_t read_timeout_usec_;
  9684. time_t write_timeout_sec_;
  9685. time_t write_timeout_usec_;
  9686. time_t max_timeout_msec_;
  9687. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9688. std::function<bool()> read_interrupted_;
  9689. bool readable_hint_ = false;
  9690. tls::TlsError tls_error_;
  9691. };
  9692. // A TLS stream for WebSocket connections, where the receive path and the
  9693. // send path (application send() plus the heartbeat ping thread) run on
  9694. // different threads. A single TLS session must never be entered
  9695. // concurrently, so every call into the session is serialized by one mutex.
  9696. //
  9697. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9698. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9699. // call under the lock, then waits for readiness with select() outside the
  9700. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9701. // blocked waiting for data never stalls a concurrent sender.
  9702. //
  9703. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9704. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9705. class WebSocketSSLStream final : public Stream {
  9706. public:
  9707. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9708. time_t read_timeout_sec, time_t read_timeout_usec,
  9709. time_t write_timeout_sec, time_t write_timeout_usec);
  9710. ~WebSocketSSLStream() override;
  9711. bool is_readable() const override;
  9712. bool wait_readable() const override;
  9713. bool wait_writable() const override;
  9714. ssize_t read(char *ptr, size_t size) override;
  9715. ssize_t write(const char *ptr, size_t size) override;
  9716. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9717. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9718. socket_t socket() const override;
  9719. time_t duration() const override;
  9720. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9721. void set_max_timeout(time_t msec) override;
  9722. void set_read_interrupt(std::function<bool()> interrupted) override;
  9723. private:
  9724. mutable std::mutex session_mutex_;
  9725. socket_t sock_;
  9726. tls::session_t session_;
  9727. // May change while another thread is in wait_readable(); write timeouts don't
  9728. std::atomic<time_t> read_timeout_sec_;
  9729. std::atomic<time_t> read_timeout_usec_;
  9730. time_t write_timeout_sec_;
  9731. time_t write_timeout_usec_;
  9732. std::atomic<time_t> max_timeout_msec_{0};
  9733. std::atomic<std::chrono::steady_clock::rep> start_time_;
  9734. std::function<bool()> read_interrupted_;
  9735. };
  9736. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9737. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9738. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9739. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9740. unsigned int hash_length = 0;
  9741. unsigned char hash[EVP_MAX_MD_SIZE];
  9742. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9743. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9744. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9745. std::stringstream ss;
  9746. for (auto i = 0u; i < hash_length; ++i) {
  9747. ss << std::hex << std::setw(2) << std::setfill('0')
  9748. << static_cast<unsigned int>(hash[i]);
  9749. }
  9750. return ss.str();
  9751. }
  9752. inline std::string MD5(const std::string &s) {
  9753. return message_digest(s, EVP_md5());
  9754. }
  9755. inline std::string SHA_256(const std::string &s) {
  9756. return message_digest(s, EVP_sha256());
  9757. }
  9758. inline std::string SHA_512(const std::string &s) {
  9759. return message_digest(s, EVP_sha512());
  9760. }
  9761. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9762. namespace {
  9763. template <size_t N>
  9764. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9765. std::stringstream ss;
  9766. for (size_t i = 0; i < N; ++i) {
  9767. ss << std::hex << std::setw(2) << std::setfill('0')
  9768. << static_cast<unsigned int>(hash[i]);
  9769. }
  9770. return ss.str();
  9771. }
  9772. } // namespace
  9773. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9774. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9775. // initialized once. PSA state is process-global; do not free it.
  9776. inline bool ensure_mbedtls_psa_crypto() {
  9777. static std::once_flag once;
  9778. static bool ok = false;
  9779. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9780. return ok;
  9781. }
  9782. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9783. unsigned char *out, size_t out_size) {
  9784. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9785. size_t olen = 0;
  9786. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9787. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9788. olen == out_size;
  9789. }
  9790. #endif
  9791. inline std::string MD5(const std::string &s) {
  9792. unsigned char hash[16];
  9793. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9794. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9795. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9796. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9797. hash);
  9798. #else
  9799. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9800. hash);
  9801. #endif
  9802. return hash_to_hex(hash);
  9803. }
  9804. inline std::string SHA_256(const std::string &s) {
  9805. unsigned char hash[32];
  9806. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9807. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9808. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9809. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9810. hash, 0);
  9811. #else
  9812. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9813. s.size(), hash, 0);
  9814. #endif
  9815. return hash_to_hex(hash);
  9816. }
  9817. inline std::string SHA_512(const std::string &s) {
  9818. unsigned char hash[64];
  9819. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9820. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9821. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9822. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9823. hash, 0);
  9824. #else
  9825. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9826. s.size(), hash, 0);
  9827. #endif
  9828. return hash_to_hex(hash);
  9829. }
  9830. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9831. namespace {
  9832. template <size_t N>
  9833. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9834. std::stringstream ss;
  9835. for (size_t i = 0; i < N; ++i) {
  9836. ss << std::hex << std::setw(2) << std::setfill('0')
  9837. << static_cast<unsigned int>(hash[i]);
  9838. }
  9839. return ss.str();
  9840. }
  9841. } // namespace
  9842. inline std::string MD5(const std::string &s) {
  9843. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9844. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9845. static_cast<word32>(s.size()), hash);
  9846. return hash_to_hex(hash);
  9847. }
  9848. inline std::string SHA_256(const std::string &s) {
  9849. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9850. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9851. static_cast<word32>(s.size()), hash);
  9852. return hash_to_hex(hash);
  9853. }
  9854. inline std::string SHA_512(const std::string &s) {
  9855. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9856. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9857. static_cast<word32>(s.size()), hash);
  9858. return hash_to_hex(hash);
  9859. }
  9860. #endif
  9861. template <typename T>
  9862. inline bool process_server_socket_ssl(
  9863. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9864. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9865. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9866. time_t write_timeout_usec, T callback) {
  9867. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9868. // of a pipelined request, which keep_alive() cannot see on the socket.
  9869. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9870. write_timeout_sec, write_timeout_usec);
  9871. size_t served = 0;
  9872. return process_server_socket_core(
  9873. strm, served, keep_alive_max_count,
  9874. [&]() { return keep_alive(svr_sock, sock, keep_alive_timeout_sec); },
  9875. callback);
  9876. }
  9877. template <typename T>
  9878. inline bool process_client_socket_ssl(
  9879. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9880. time_t read_timeout_usec, time_t write_timeout_sec,
  9881. time_t write_timeout_usec, time_t max_timeout_msec,
  9882. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9883. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9884. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9885. start_time);
  9886. return callback(strm);
  9887. }
  9888. // `uri` is req's request-target in origin form, as curl sends it, also when
  9889. // the request line carries the absolute form for a proxy.
  9890. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9891. const Request &req, const std::string &uri,
  9892. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9893. const std::string &cnonce, const std::string &username,
  9894. const std::string &password, bool is_proxy = false) {
  9895. std::string nc;
  9896. {
  9897. std::stringstream ss;
  9898. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9899. nc = ss.str();
  9900. }
  9901. std::string qop;
  9902. if (auth.find("qop") != auth.end()) {
  9903. qop = auth.at("qop");
  9904. if (qop.find("auth-int") != std::string::npos) {
  9905. qop = "auth-int";
  9906. } else if (qop.find("auth") != std::string::npos) {
  9907. qop = "auth";
  9908. } else {
  9909. qop.clear();
  9910. }
  9911. }
  9912. std::string algo = "MD5";
  9913. if (auth.find("algorithm") != auth.end()) {
  9914. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9915. // not a token would otherwise be emitted verbatim and could carry commas
  9916. // or quotes that inject further auth-params into the header below.
  9917. const auto &a = auth.at("algorithm");
  9918. if (fields::is_token(a)) { algo = a; }
  9919. }
  9920. std::string response;
  9921. {
  9922. auto H = algo == "SHA-256" ? detail::SHA_256
  9923. : algo == "SHA-512" ? detail::SHA_512
  9924. : detail::MD5;
  9925. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9926. auto A2 = req.method + ":" + uri;
  9927. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9928. if (qop.empty()) {
  9929. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9930. } else {
  9931. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9932. ":" + qop + ":" + H(A2));
  9933. }
  9934. }
  9935. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9936. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9937. // close the string early. realm, nonce and opaque come straight from the
  9938. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9939. // without this a crafted challenge injects extra auth-params into the header.
  9940. auto field =
  9941. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9942. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9943. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9944. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9945. "\", algorithm=" + algo +
  9946. (qop.empty() ? ", response=\""
  9947. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9948. "\", response=\"") +
  9949. response + "\"" +
  9950. (opaque.empty()
  9951. ? ""
  9952. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9953. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9954. return std::make_pair(key, field);
  9955. }
  9956. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9957. // backend accepts the same names.
  9958. inline bool match_hostname(const std::string &pattern,
  9959. const std::string &hostname) {
  9960. // A trailing dot on the host is ignored
  9961. auto host = hostname;
  9962. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9963. // Exact match (case-insensitive)
  9964. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9965. // Split both pattern and hostname into components by '.', keeping any empty
  9966. // one, which no name may have
  9967. auto labels = [](const std::string &s) {
  9968. std::vector<std::string> v;
  9969. size_t b = 0;
  9970. while (true) {
  9971. auto e = s.find('.', b);
  9972. v.push_back(s.substr(b, e - b));
  9973. if (e == std::string::npos) { return v; }
  9974. b = e + 1;
  9975. }
  9976. };
  9977. auto pattern_components = labels(pattern);
  9978. auto host_components = labels(host);
  9979. auto has_empty_label = [](const std::vector<std::string> &v) {
  9980. return std::any_of(v.begin(), v.end(),
  9981. [](const std::string &l) { return l.empty(); });
  9982. };
  9983. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9984. return false;
  9985. }
  9986. // Component count must match
  9987. if (host_components.size() != pattern_components.size()) { return false; }
  9988. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9989. // and an IDNA label may not have one
  9990. const auto &leftmost = pattern_components.front();
  9991. if (leftmost.find('*') != std::string::npos &&
  9992. (pattern_components.size() < 3 ||
  9993. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9994. return false;
  9995. }
  9996. // Compare each component with wildcard support
  9997. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9998. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9999. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  10000. auto itr = pattern_components.begin();
  10001. for (const auto &h : host_components) {
  10002. auto &p = *itr;
  10003. auto is_leftmost = itr == pattern_components.begin();
  10004. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  10005. bool partial_match = false;
  10006. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  10007. const auto prefix_length = p.size() - 1;
  10008. if (prefix_length == 0) {
  10009. partial_match = true;
  10010. } else if (h.size() >= prefix_length) {
  10011. partial_match =
  10012. std::equal(p.begin(),
  10013. p.begin() + static_cast<std::string::difference_type>(
  10014. prefix_length),
  10015. h.begin(), [](const char ca, const char cb) {
  10016. return detail::case_ignore::to_lower(ca) ==
  10017. detail::case_ignore::to_lower(cb);
  10018. });
  10019. }
  10020. }
  10021. if (!partial_match) { return false; }
  10022. }
  10023. ++itr;
  10024. }
  10025. return true;
  10026. }
  10027. #ifdef _WIN32
  10028. // Verify certificate using Windows CertGetCertificateChain API.
  10029. // This provides real-time certificate validation with Windows Update
  10030. // integration, independent of the TLS backend.
  10031. inline bool verify_cert_with_windows_schannel(
  10032. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  10033. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  10034. if (der_cert.empty()) { return false; }
  10035. out_error = 0;
  10036. // Create Windows certificate context from DER data
  10037. auto cert_context = CertCreateCertificateContext(
  10038. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  10039. static_cast<DWORD>(der_cert.size()));
  10040. if (!cert_context) {
  10041. out_error = GetLastError();
  10042. return false;
  10043. }
  10044. auto cert_guard =
  10045. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  10046. // Give CryptoAPI the certificates the server sent. Without them it follows
  10047. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  10048. std::vector<tls::cert_t> peer_certs;
  10049. tls::get_peer_certs(session, peer_certs);
  10050. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  10051. auto store_guard = scope_exit([&] {
  10052. for (auto cert : peer_certs) {
  10053. tls::free_cert(cert);
  10054. }
  10055. if (store) { CertCloseStore(store, 0); }
  10056. });
  10057. for (auto cert : peer_certs) {
  10058. std::vector<unsigned char> der;
  10059. if (store && tls::get_cert_der(cert, der)) {
  10060. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  10061. static_cast<DWORD>(der.size()),
  10062. CERT_STORE_ADD_USE_EXISTING, nullptr);
  10063. }
  10064. }
  10065. // Setup chain parameters
  10066. CERT_CHAIN_PARA chain_para = {};
  10067. chain_para.cbSize = sizeof(chain_para);
  10068. // Require the server authentication usage along the chain, which also
  10069. // rejects roots that Windows trusts only for other purposes.
  10070. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  10071. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  10072. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  10073. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  10074. // Build certificate chain with revocation checking
  10075. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  10076. auto chain_result = CertGetCertificateChain(
  10077. nullptr, cert_context, nullptr, store, &chain_para,
  10078. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  10079. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  10080. nullptr, &chain_context);
  10081. if (!chain_result || !chain_context) {
  10082. out_error = GetLastError();
  10083. return false;
  10084. }
  10085. auto chain_guard =
  10086. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  10087. // Verify SSL policy
  10088. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  10089. extra_policy_para.cbSize = sizeof(extra_policy_para);
  10090. #ifdef AUTHTYPE_SERVER
  10091. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  10092. #endif
  10093. std::wstring whost;
  10094. if (verify_hostname) {
  10095. whost = u8string_to_wstring(hostname.c_str());
  10096. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  10097. }
  10098. CERT_CHAIN_POLICY_PARA policy_para = {};
  10099. policy_para.cbSize = sizeof(policy_para);
  10100. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  10101. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  10102. #else
  10103. policy_para.dwFlags = 0;
  10104. #endif
  10105. policy_para.pvExtraPolicyPara = &extra_policy_para;
  10106. CERT_CHAIN_POLICY_STATUS policy_status = {};
  10107. policy_status.cbSize = sizeof(policy_status);
  10108. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  10109. &policy_para, &policy_status)) {
  10110. out_error = GetLastError();
  10111. return false;
  10112. }
  10113. if (policy_status.dwError != 0) {
  10114. out_error = policy_status.dwError;
  10115. return false;
  10116. }
  10117. return true;
  10118. }
  10119. #endif // _WIN32
  10120. // Loads CA file/dir configuration and applies the system CA policy to a
  10121. // client TLS context. PEM data and native stores are applied to the context
  10122. // directly at set time; has_custom_store reflects them for the Auto policy
  10123. // decision.
  10124. inline bool load_client_ca_config(tls::ctx_t ctx,
  10125. const std::string &ca_cert_file_path,
  10126. const std::string &ca_cert_dir_path,
  10127. bool has_custom_store, SystemCAMode mode,
  10128. uint64_t &backend_error) {
  10129. auto ret = true;
  10130. if (!ca_cert_file_path.empty()) {
  10131. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  10132. backend_error = tls::get_error();
  10133. ret = false;
  10134. }
  10135. } else if (!ca_cert_dir_path.empty()) {
  10136. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  10137. backend_error = tls::get_error();
  10138. ret = false;
  10139. }
  10140. }
  10141. auto has_custom_ca = !ca_cert_file_path.empty() ||
  10142. !ca_cert_dir_path.empty() || has_custom_store;
  10143. if (mode == SystemCAMode::Enabled ||
  10144. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  10145. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  10146. }
  10147. return ret;
  10148. }
  10149. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  10150. // Schannel is skipped when a custom CA is specified, as the Windows
  10151. // certificate store would not know about it, and when system CA trust is
  10152. // explicitly disabled.
  10153. inline bool use_windows_cert_verification(bool enabled,
  10154. const std::string &ca_cert_file_path,
  10155. const std::string &ca_cert_dir_path,
  10156. bool has_custom_store,
  10157. SystemCAMode mode) {
  10158. return enabled && mode != SystemCAMode::Disabled &&
  10159. ca_cert_file_path.empty() && ca_cert_dir_path.empty() &&
  10160. !has_custom_store;
  10161. }
  10162. #endif
  10163. // Serializes the CA certificates installed in ctx as PEM, so they can be
  10164. // loaded into another context.
  10165. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  10166. std::string pem;
  10167. std::vector<tls::cert_t> certs;
  10168. tls::get_ca_certs(ctx, certs);
  10169. for (auto cert : certs) {
  10170. std::vector<unsigned char> der;
  10171. if (tls::get_cert_der(cert, der)) {
  10172. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  10173. pem += "-----BEGIN CERTIFICATE-----\n";
  10174. for (size_t i = 0; i < b64.size(); i += 64) {
  10175. pem += b64.substr(i, 64);
  10176. pem += '\n';
  10177. }
  10178. pem += "-----END CERTIFICATE-----\n";
  10179. }
  10180. tls::free_cert(cert);
  10181. }
  10182. return pem;
  10183. }
  10184. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  10185. // copied to buf, or pem itself when len is 0.
  10186. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  10187. if (!pem || len == 0) { return pem; }
  10188. buf.assign(pem, len);
  10189. return buf.c_str();
  10190. }
  10191. // The parts of session setup that only SSLClient needs, plus the handful
  10192. // WebSocketClient also exposes; everything else takes the defaults, which is
  10193. // what keeps the two clients on one implementation.
  10194. struct ClientTlsSessionOptions {
  10195. // Both SSLClient and WebSocketClient expose this independently of
  10196. // certificate verification.
  10197. bool server_hostname_verification = true;
  10198. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  10199. // When set, ends the handshake as a timeout does once it returns true
  10200. std::function<bool()> interrupted;
  10201. // When non-null, guards session creation against concurrent use of the
  10202. // context. A WebSocketClient is not safe to use from several threads to
  10203. // begin with, so it passes nothing.
  10204. std::mutex *ctx_mutex = nullptr;
  10205. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  10206. // See use_windows_cert_verification().
  10207. bool windows_cert_verification = false;
  10208. // A server certificate verifier works on the backend's chain verification,
  10209. // so the backend keeps deciding and Schannel only adds its own check.
  10210. bool server_certificate_verifier_set = false;
  10211. #endif
  10212. };
  10213. // Filled in on failure for callers that report error details.
  10214. struct ClientTlsSessionError {
  10215. Error error = Error::Success;
  10216. int ssl_error = 0;
  10217. uint64_t backend_error = 0;
  10218. };
  10219. // Establishes a client TLS session on an already connected socket. On failure
  10220. // the session is left for the caller to free: SSLClient frees it right away,
  10221. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  10222. inline bool setup_client_tls_session(
  10223. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  10224. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  10225. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  10226. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  10227. using namespace tls;
  10228. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  10229. if (out_error) {
  10230. out_error->error = error;
  10231. out_error->ssl_error = ssl_error;
  10232. out_error->backend_error = backend_error;
  10233. }
  10234. return false;
  10235. };
  10236. // A TLS failure, whose verification codes name the Error too
  10237. auto fail_tls = [&](ErrorCode code, uint64_t backend_error) {
  10238. auto error = Error::SSLConnection;
  10239. if (code == ErrorCode::CertVerifyFailed) {
  10240. error = Error::SSLServerVerification;
  10241. } else if (code == ErrorCode::HostnameMismatch) {
  10242. error = Error::SSLServerHostnameVerification;
  10243. }
  10244. return fail(error, static_cast<int>(code), backend_error);
  10245. };
  10246. if (!ctx) {
  10247. session = nullptr;
  10248. return fail(Error::SSLConnection, 0, 0);
  10249. }
  10250. // With Windows verification on and no server certificate verifier set,
  10251. // Schannel is the only chain verifier. The backend's trust store is a
  10252. // snapshot of the Windows stores that lacks the roots Windows fetches on
  10253. // demand, so the backend's verdict is not used.
  10254. auto windows_verifies_chain = false;
  10255. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  10256. windows_verifies_chain = options.windows_cert_verification &&
  10257. !options.server_certificate_verifier_set;
  10258. #endif
  10259. // The chain, and a host name, are verified during the handshake, so that a
  10260. // server failing them never gets to see a client certificate. Unless
  10261. // Schannel verifies the chain instead, this holds for IP hosts too, whose
  10262. // identity is checked after the handshake by verify_hostname().
  10263. auto verify_in_handshake =
  10264. server_certificate_verification && !windows_verifies_chain;
  10265. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10266. // A session verifier may accept a certificate the built-in check rejects,
  10267. // and runs only after the handshake
  10268. verify_in_handshake = verify_in_handshake && !options.session_verifier;
  10269. #endif
  10270. {
  10271. std::unique_lock<std::mutex> guard;
  10272. if (options.ctx_mutex) {
  10273. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  10274. }
  10275. // The mode is set on the context, so under the same lock
  10276. set_verify_client(ctx, verify_in_handshake);
  10277. session = create_session(ctx, sock);
  10278. }
  10279. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  10280. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  10281. // their identity is checked post-handshake below instead.
  10282. if (!is_ip_address(host)) {
  10283. if (!set_sni(session, host.c_str(),
  10284. verify_in_handshake && options.server_hostname_verification)) {
  10285. return fail(Error::SSLConnection, 0, get_error());
  10286. }
  10287. }
  10288. TlsError tls_err;
  10289. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec, &tls_err,
  10290. options.interrupted)) {
  10291. return fail_tls(tls_err.code, tls_err.backend_code);
  10292. }
  10293. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  10294. if (options.session_verifier) {
  10295. verification_status = options.session_verifier(session);
  10296. }
  10297. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  10298. return fail(Error::SSLServerVerification, 0, get_error());
  10299. }
  10300. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  10301. server_certificate_verification) {
  10302. if (!windows_verifies_chain) {
  10303. auto verify_result = get_verify_result(session);
  10304. if (verify_result != 0) {
  10305. return fail_tls(ErrorCode::CertVerifyFailed,
  10306. static_cast<uint64_t>(verify_result));
  10307. }
  10308. }
  10309. auto server_cert = get_peer_cert(session);
  10310. if (!server_cert) {
  10311. return fail_tls(ErrorCode::CertVerifyFailed, get_error());
  10312. }
  10313. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  10314. // Identity check against the peer certificate, post-handshake for all
  10315. // backends. For IP hosts this is the only identity verification, since no
  10316. // hostname is bound during the handshake.
  10317. if (options.server_hostname_verification) {
  10318. if (!verify_hostname(server_cert, host.c_str())) {
  10319. return fail_tls(ErrorCode::HostnameMismatch, hostname_mismatch_code());
  10320. }
  10321. }
  10322. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  10323. // Windows Schannel verification, which lets Windows fetch missing roots
  10324. // and intermediates on demand. It must not be skipped: unless a server
  10325. // certificate verifier is set, it is the only chain check.
  10326. if (options.windows_cert_verification) {
  10327. std::vector<unsigned char> der;
  10328. uint64_t wincrypt_error = 0;
  10329. if (!get_cert_der(server_cert, der) ||
  10330. !verify_cert_with_windows_schannel(
  10331. der, host, options.server_hostname_verification, wincrypt_error,
  10332. session)) {
  10333. return fail_tls(ErrorCode::CertVerifyFailed, wincrypt_error);
  10334. }
  10335. }
  10336. #endif
  10337. }
  10338. return true;
  10339. }
  10340. } // namespace detail
  10341. #endif // CPPHTTPLIB_SSL_ENABLED
  10342. /*
  10343. * Group 3: httplib namespace - Non-SSL public API implementations
  10344. */
  10345. inline void default_socket_options(socket_t sock) {
  10346. set_socket_opt(sock, SOL_SOCKET,
  10347. #ifdef SO_REUSEPORT
  10348. SO_REUSEPORT,
  10349. #else
  10350. SO_REUSEADDR,
  10351. #endif
  10352. 1);
  10353. }
  10354. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  10355. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  10356. sizeof(optval));
  10357. }
  10358. inline std::string get_bearer_token_auth(const Request &req) {
  10359. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  10360. // than the prefix carries no token.
  10361. constexpr const char bearer_prefix[] = "Bearer ";
  10362. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  10363. auto value = req.get_header_value("Authorization");
  10364. if (value.size() >= bearer_prefix_len &&
  10365. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  10366. bearer_prefix)) {
  10367. return value.substr(bearer_prefix_len);
  10368. }
  10369. return "";
  10370. }
  10371. inline const char *status_message(int status) {
  10372. switch (status) {
  10373. case StatusCode::Continue_100: return "Continue";
  10374. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  10375. case StatusCode::Processing_102: return "Processing";
  10376. case StatusCode::EarlyHints_103: return "Early Hints";
  10377. case StatusCode::OK_200: return "OK";
  10378. case StatusCode::Created_201: return "Created";
  10379. case StatusCode::Accepted_202: return "Accepted";
  10380. case StatusCode::NonAuthoritativeInformation_203:
  10381. return "Non-Authoritative Information";
  10382. case StatusCode::NoContent_204: return "No Content";
  10383. case StatusCode::ResetContent_205: return "Reset Content";
  10384. case StatusCode::PartialContent_206: return "Partial Content";
  10385. case StatusCode::MultiStatus_207: return "Multi-Status";
  10386. case StatusCode::AlreadyReported_208: return "Already Reported";
  10387. case StatusCode::IMUsed_226: return "IM Used";
  10388. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  10389. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  10390. case StatusCode::Found_302: return "Found";
  10391. case StatusCode::SeeOther_303: return "See Other";
  10392. case StatusCode::NotModified_304: return "Not Modified";
  10393. case StatusCode::UseProxy_305: return "Use Proxy";
  10394. case StatusCode::unused_306: return "unused";
  10395. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  10396. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  10397. case StatusCode::BadRequest_400: return "Bad Request";
  10398. case StatusCode::Unauthorized_401: return "Unauthorized";
  10399. case StatusCode::PaymentRequired_402: return "Payment Required";
  10400. case StatusCode::Forbidden_403: return "Forbidden";
  10401. case StatusCode::NotFound_404: return "Not Found";
  10402. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  10403. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  10404. case StatusCode::ProxyAuthenticationRequired_407:
  10405. return "Proxy Authentication Required";
  10406. case StatusCode::RequestTimeout_408: return "Request Timeout";
  10407. case StatusCode::Conflict_409: return "Conflict";
  10408. case StatusCode::Gone_410: return "Gone";
  10409. case StatusCode::LengthRequired_411: return "Length Required";
  10410. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  10411. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  10412. case StatusCode::UriTooLong_414: return "URI Too Long";
  10413. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  10414. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  10415. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  10416. case StatusCode::ImATeapot_418: return "I'm a teapot";
  10417. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  10418. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  10419. case StatusCode::Locked_423: return "Locked";
  10420. case StatusCode::FailedDependency_424: return "Failed Dependency";
  10421. case StatusCode::TooEarly_425: return "Too Early";
  10422. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  10423. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  10424. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  10425. case StatusCode::RequestHeaderFieldsTooLarge_431:
  10426. return "Request Header Fields Too Large";
  10427. case StatusCode::UnavailableForLegalReasons_451:
  10428. return "Unavailable For Legal Reasons";
  10429. case StatusCode::NotImplemented_501: return "Not Implemented";
  10430. case StatusCode::BadGateway_502: return "Bad Gateway";
  10431. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  10432. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  10433. case StatusCode::HttpVersionNotSupported_505:
  10434. return "HTTP Version Not Supported";
  10435. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  10436. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  10437. case StatusCode::LoopDetected_508: return "Loop Detected";
  10438. case StatusCode::NotExtended_510: return "Not Extended";
  10439. case StatusCode::NetworkAuthenticationRequired_511:
  10440. return "Network Authentication Required";
  10441. default:
  10442. case StatusCode::InternalServerError_500: return "Internal Server Error";
  10443. }
  10444. }
  10445. inline std::string to_string(const Error error) {
  10446. switch (error) {
  10447. case Error::Success: return "Success (no error)";
  10448. case Error::Unknown: return "Unknown";
  10449. case Error::Connection: return "Could not establish connection";
  10450. case Error::BindIPAddress: return "Failed to bind IP address";
  10451. case Error::Read: return "Failed to read connection";
  10452. case Error::Write: return "Failed to write connection";
  10453. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  10454. case Error::Canceled: return "Connection handling canceled";
  10455. case Error::SSLConnection: return "SSL connection failed";
  10456. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  10457. case Error::SSLServerVerification: return "SSL server verification failed";
  10458. case Error::SSLServerHostnameVerification:
  10459. return "SSL server hostname verification failed";
  10460. case Error::UnsupportedMultipartBoundaryChars:
  10461. return "Unsupported HTTP multipart boundary characters";
  10462. case Error::Compression: return "Compression failed";
  10463. case Error::ConnectionTimeout: return "Connection timed out";
  10464. case Error::ProxyConnection: return "Proxy connection failed";
  10465. case Error::ConnectionClosed: return "Connection closed by server";
  10466. case Error::Timeout: return "Read timeout";
  10467. case Error::ResourceExhaustion: return "Resource exhaustion";
  10468. case Error::TooManyFormDataFiles: return "Too many form data files";
  10469. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  10470. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  10471. case Error::ExceedMaxSocketDescriptorCount:
  10472. return "Exceeded maximum socket descriptor count";
  10473. case Error::InvalidRequestLine: return "Invalid request line";
  10474. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  10475. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  10476. case Error::InvalidHeaders: return "Invalid headers";
  10477. case Error::MultipartParsing: return "Multipart parsing failed";
  10478. case Error::OpenFile: return "Failed to open file";
  10479. case Error::Listen: return "Failed to listen on socket";
  10480. case Error::GetSockName: return "Failed to get socket name";
  10481. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  10482. case Error::HTTPParsing: return "HTTP parsing failed";
  10483. case Error::InvalidRangeHeader: return "Invalid Range header";
  10484. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  10485. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  10486. case Error::UserCallbackException: return "User callback threw an exception";
  10487. default: break;
  10488. }
  10489. return "Invalid";
  10490. }
  10491. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  10492. os << to_string(obj);
  10493. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  10494. return os;
  10495. }
  10496. inline std::string hosted_at(const std::string &hostname) {
  10497. std::vector<std::string> addrs;
  10498. hosted_at(hostname, addrs);
  10499. if (addrs.empty()) { return std::string(); }
  10500. return addrs[0];
  10501. }
  10502. inline void hosted_at(const std::string &hostname,
  10503. std::vector<std::string> &addrs) {
  10504. struct addrinfo hints;
  10505. struct addrinfo *result;
  10506. memset(&hints, 0, sizeof(struct addrinfo));
  10507. hints.ai_family = AF_UNSPEC;
  10508. hints.ai_socktype = SOCK_STREAM;
  10509. hints.ai_protocol = 0;
  10510. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  10511. &result, 0)) {
  10512. #if defined __linux__ && !defined __ANDROID__
  10513. res_init();
  10514. #endif
  10515. return;
  10516. }
  10517. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  10518. for (auto rp = result; rp; rp = rp->ai_next) {
  10519. const auto &addr =
  10520. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  10521. std::string ip;
  10522. auto dummy = -1;
  10523. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  10524. dummy)) {
  10525. addrs.emplace_back(std::move(ip));
  10526. }
  10527. }
  10528. }
  10529. inline std::string encode_uri_component(const std::string &value) {
  10530. std::ostringstream escaped;
  10531. escaped.fill('0');
  10532. escaped << std::hex;
  10533. for (auto c : value) {
  10534. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  10535. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  10536. escaped << c;
  10537. } else {
  10538. escaped << std::uppercase;
  10539. escaped << '%' << std::setw(2)
  10540. << static_cast<int>(static_cast<unsigned char>(c));
  10541. escaped << std::nouppercase;
  10542. }
  10543. }
  10544. return escaped.str();
  10545. }
  10546. inline std::string encode_uri(const std::string &value) {
  10547. std::ostringstream escaped;
  10548. escaped.fill('0');
  10549. escaped << std::hex;
  10550. for (auto c : value) {
  10551. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  10552. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  10553. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  10554. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  10555. escaped << c;
  10556. } else {
  10557. escaped << std::uppercase;
  10558. escaped << '%' << std::setw(2)
  10559. << static_cast<int>(static_cast<unsigned char>(c));
  10560. escaped << std::nouppercase;
  10561. }
  10562. }
  10563. return escaped.str();
  10564. }
  10565. inline std::string decode_uri_component(const std::string &value) {
  10566. std::string result;
  10567. for (size_t i = 0; i < value.size(); i++) {
  10568. if (value[i] == '%' && i + 2 < value.size()) {
  10569. auto val = 0;
  10570. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10571. result += static_cast<char>(val);
  10572. i += 2;
  10573. } else {
  10574. result += value[i];
  10575. }
  10576. } else {
  10577. result += value[i];
  10578. }
  10579. }
  10580. return result;
  10581. }
  10582. inline std::string decode_uri(const std::string &value) {
  10583. std::string result;
  10584. for (size_t i = 0; i < value.size(); i++) {
  10585. if (value[i] == '%' && i + 2 < value.size()) {
  10586. auto val = 0;
  10587. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10588. auto c = static_cast<char>(val);
  10589. // Keep escapes of the reserved characters that encode_uri leaves
  10590. // literal, so decode_uri is the inverse of encode_uri and an escaped
  10591. // delimiter is not promoted into a real one (as with JS decodeURI).
  10592. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  10593. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  10594. c == '#') {
  10595. result += value[i];
  10596. result += value[i + 1];
  10597. result += value[i + 2];
  10598. } else {
  10599. result += c;
  10600. }
  10601. i += 2;
  10602. } else {
  10603. result += value[i];
  10604. }
  10605. } else {
  10606. result += value[i];
  10607. }
  10608. }
  10609. return result;
  10610. }
  10611. inline std::string encode_path_component(const std::string &component) {
  10612. std::string result;
  10613. result.reserve(component.size() * 3);
  10614. for (size_t i = 0; i < component.size(); i++) {
  10615. auto c = static_cast<unsigned char>(component[i]);
  10616. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  10617. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10618. c == '_' || c == '~') {
  10619. result += static_cast<char>(c);
  10620. }
  10621. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  10622. // "," / ";" / "="
  10623. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  10624. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  10625. c == '=') {
  10626. result += static_cast<char>(c);
  10627. }
  10628. // Colon is allowed in path segments except first segment
  10629. else if (c == ':') {
  10630. result += static_cast<char>(c);
  10631. }
  10632. // @ is allowed in path
  10633. else if (c == '@') {
  10634. result += static_cast<char>(c);
  10635. } else {
  10636. result += '%';
  10637. char hex[3];
  10638. snprintf(hex, sizeof(hex), "%02X", c);
  10639. result.append(hex, 2);
  10640. }
  10641. }
  10642. return result;
  10643. }
  10644. inline std::string decode_path_component(const std::string &component) {
  10645. std::string result;
  10646. result.reserve(component.size());
  10647. for (size_t i = 0; i < component.size(); i++) {
  10648. if (component[i] == '%' && i + 1 < component.size()) {
  10649. if (component[i + 1] == 'u') {
  10650. // Unicode %uXXXX encoding
  10651. auto val = 0;
  10652. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  10653. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  10654. char buff[4];
  10655. size_t len = 0;
  10656. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  10657. (len = detail::to_utf8(val, buff)) > 0) {
  10658. result.append(buff, len);
  10659. i += 5; // 'u0000'
  10660. } else {
  10661. // Not 4 hex digits, or a surrogate, which is no character: the
  10662. // escape is kept as it is rather than joining its neighbours
  10663. result += component[i];
  10664. }
  10665. } else {
  10666. // Standard %XX encoding
  10667. auto val = 0;
  10668. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10669. // 2 digits hex codes
  10670. result += static_cast<char>(val);
  10671. i += 2; // 'XX'
  10672. } else {
  10673. result += component[i];
  10674. }
  10675. }
  10676. } else {
  10677. result += component[i];
  10678. }
  10679. }
  10680. return result;
  10681. }
  10682. inline std::string encode_query_component(const std::string &component,
  10683. bool space_as_plus) {
  10684. std::string result;
  10685. result.reserve(component.size() * 3);
  10686. for (size_t i = 0; i < component.size(); i++) {
  10687. auto c = static_cast<unsigned char>(component[i]);
  10688. // Unreserved characters per RFC 3986
  10689. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10690. c == '_' || c == '~') {
  10691. result += static_cast<char>(c);
  10692. }
  10693. // Space handling
  10694. else if (c == ' ') {
  10695. if (space_as_plus) {
  10696. result += '+';
  10697. } else {
  10698. result += "%20";
  10699. }
  10700. }
  10701. // Plus sign handling
  10702. else if (c == '+') {
  10703. if (space_as_plus) {
  10704. result += "%2B";
  10705. } else {
  10706. result += static_cast<char>(c);
  10707. }
  10708. }
  10709. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10710. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10711. c == '*' || c == ',' || c == ';') {
  10712. result += static_cast<char>(c);
  10713. }
  10714. // Colon and @ are allowed in query
  10715. else if (c == ':' || c == '@') {
  10716. result += static_cast<char>(c);
  10717. }
  10718. // Forward slash is allowed in query values
  10719. else if (c == '/') {
  10720. result += static_cast<char>(c);
  10721. }
  10722. // Question mark is allowed in query values (after first ?)
  10723. else if (c == '?') {
  10724. result += static_cast<char>(c);
  10725. } else {
  10726. result += '%';
  10727. char hex[3];
  10728. snprintf(hex, sizeof(hex), "%02X", c);
  10729. result.append(hex, 2);
  10730. }
  10731. }
  10732. return result;
  10733. }
  10734. inline std::string decode_query_component(const std::string &component,
  10735. bool plus_as_space) {
  10736. std::string result;
  10737. result.reserve(component.size());
  10738. for (size_t i = 0; i < component.size(); i++) {
  10739. if (component[i] == '%' && i + 2 < component.size()) {
  10740. auto val = 0;
  10741. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10742. result += static_cast<char>(val);
  10743. i += 2;
  10744. } else {
  10745. result += component[i];
  10746. }
  10747. } else if (component[i] == '+' && plus_as_space) {
  10748. result += ' '; // + becomes space in form-urlencoded
  10749. } else {
  10750. result += component[i];
  10751. }
  10752. }
  10753. return result;
  10754. }
  10755. inline std::string sanitize_filename(const std::string &filename) {
  10756. // Extract basename: find the last path separator (/ or \) and, on Windows,
  10757. // ':', which ends a drive prefix ("C:..") or names an NTFS stream ("a:b")
  10758. #ifdef _WIN32
  10759. auto pos = filename.find_last_of("/\\:");
  10760. #else
  10761. auto pos = filename.find_last_of("/\\");
  10762. #endif
  10763. auto result =
  10764. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10765. // Strip null bytes
  10766. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10767. // Trim whitespace
  10768. {
  10769. auto start = result.find_first_not_of(" \t");
  10770. auto end = result.find_last_not_of(" \t");
  10771. result = (start == std::string::npos)
  10772. ? ""
  10773. : result.substr(start, end - start + 1);
  10774. }
  10775. // Reject . and ..
  10776. if (result == "." || result == "..") { return ""; }
  10777. return result;
  10778. }
  10779. inline std::string append_query_params(const std::string &path,
  10780. const Params &params) {
  10781. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10782. auto fragment_pos = path.find('#');
  10783. auto path_with_query = path.substr(0, fragment_pos);
  10784. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10785. path_with_query += detail::params_to_query_str(params);
  10786. if (fragment_pos != std::string::npos) {
  10787. path_with_query.append(path, fragment_pos, std::string::npos);
  10788. }
  10789. return path_with_query;
  10790. }
  10791. // Header utilities
  10792. inline std::pair<std::string, std::string>
  10793. make_range_header(const Ranges &ranges) {
  10794. std::string field = "bytes=";
  10795. auto i = 0;
  10796. for (const auto &r : ranges) {
  10797. if (i != 0) { field += ", "; }
  10798. if (r.first != -1) { field += std::to_string(r.first); }
  10799. field += '-';
  10800. if (r.second != -1) { field += std::to_string(r.second); }
  10801. i++;
  10802. }
  10803. return std::make_pair("Range", std::move(field));
  10804. }
  10805. inline std::pair<std::string, std::string>
  10806. make_basic_authentication_header(const std::string &username,
  10807. const std::string &password, bool is_proxy) {
  10808. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10809. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10810. return std::make_pair(key, std::move(field));
  10811. }
  10812. inline std::pair<std::string, std::string>
  10813. make_bearer_token_authentication_header(const std::string &token,
  10814. bool is_proxy = false) {
  10815. auto field = "Bearer " + token;
  10816. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10817. return std::make_pair(key, std::move(field));
  10818. }
  10819. namespace detail {
  10820. // Basic auth when a username or password is set, otherwise a bearer token,
  10821. // unless the request already carries the header.
  10822. inline void add_authorization_header(Request &req, const std::string &username,
  10823. const std::string &password,
  10824. const std::string &token, bool is_proxy) {
  10825. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10826. return;
  10827. }
  10828. if (!username.empty() || !password.empty()) {
  10829. req.headers.insert(
  10830. make_basic_authentication_header(username, password, is_proxy));
  10831. } else if (!token.empty()) {
  10832. req.headers.insert(
  10833. make_bearer_token_authentication_header(token, is_proxy));
  10834. }
  10835. }
  10836. } // namespace detail
  10837. // Request implementation
  10838. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10839. size_t id) const {
  10840. return detail::get_header_value_u64(headers, key, def, id);
  10841. }
  10842. inline bool Request::has_header(const std::string &key) const {
  10843. return detail::has_header(headers, key);
  10844. }
  10845. inline std::string Request::get_header_value(const std::string &key,
  10846. const char *def, size_t id) const {
  10847. return detail::get_header_value(headers, key, def, id);
  10848. }
  10849. inline size_t Request::get_header_value_count(const std::string &key) const {
  10850. return detail::get_header_value_count(headers, key);
  10851. }
  10852. inline void Request::set_header(const std::string &key,
  10853. const std::string &val) {
  10854. detail::set_header(headers, key, val);
  10855. }
  10856. inline bool Request::has_trailer(const std::string &key) const {
  10857. return trailers.find(key) != trailers.end();
  10858. }
  10859. inline std::string Request::get_trailer_value(const std::string &key,
  10860. size_t id) const {
  10861. return detail::get_multimap_value(trailers, key, id);
  10862. }
  10863. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10864. return trailers.count(key);
  10865. }
  10866. inline bool Request::has_param(const std::string &key) const {
  10867. return params.find(key) != params.end();
  10868. }
  10869. inline std::string Request::get_param_value(const std::string &key,
  10870. size_t id) const {
  10871. return detail::get_multimap_value(params, key, id);
  10872. }
  10873. inline std::vector<std::string>
  10874. Request::get_param_values(const std::string &key) const {
  10875. auto rng = params.equal_range(key);
  10876. std::vector<std::string> values;
  10877. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10878. for (auto it = rng.first; it != rng.second; ++it) {
  10879. values.push_back(it->second);
  10880. }
  10881. return values;
  10882. }
  10883. inline size_t Request::get_param_value_count(const std::string &key) const {
  10884. return params.count(key);
  10885. }
  10886. inline bool Request::is_multipart_form_data() const {
  10887. const auto &content_type = get_header_value("Content-Type");
  10888. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10889. "multipart/form-data");
  10890. }
  10891. // Multipart FormData implementation
  10892. inline std::string MultipartFormData::get_field(const std::string &key,
  10893. size_t id) const {
  10894. auto rng = fields.equal_range(key);
  10895. auto it = detail::bounded_next(rng.first, id, rng.second);
  10896. if (it != rng.second) { return it->second.content; }
  10897. return std::string();
  10898. }
  10899. inline std::vector<std::string>
  10900. MultipartFormData::get_fields(const std::string &key) const {
  10901. std::vector<std::string> values;
  10902. auto rng = fields.equal_range(key);
  10903. for (auto it = rng.first; it != rng.second; it++) {
  10904. values.push_back(it->second.content);
  10905. }
  10906. return values;
  10907. }
  10908. inline bool MultipartFormData::has_field(const std::string &key) const {
  10909. return fields.find(key) != fields.end();
  10910. }
  10911. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10912. return fields.count(key);
  10913. }
  10914. inline FormData MultipartFormData::get_file(const std::string &key,
  10915. size_t id) const {
  10916. return detail::get_multimap_value(files, key, id);
  10917. }
  10918. inline std::vector<FormData>
  10919. MultipartFormData::get_files(const std::string &key) const {
  10920. std::vector<FormData> values;
  10921. auto rng = files.equal_range(key);
  10922. for (auto it = rng.first; it != rng.second; it++) {
  10923. values.push_back(it->second);
  10924. }
  10925. return values;
  10926. }
  10927. inline bool MultipartFormData::has_file(const std::string &key) const {
  10928. return files.find(key) != files.end();
  10929. }
  10930. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10931. return files.count(key);
  10932. }
  10933. // Multipart FormData writer implementation
  10934. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10935. return detail::is_multipart_boundary_chars_valid(boundary);
  10936. }
  10937. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10938. : boundary_(detail::make_multipart_data_boundary()) {}
  10939. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10940. : boundary_(std::move(boundary)) {}
  10941. inline const std::string &MultipartFormDataWriter::boundary() const {
  10942. return boundary_;
  10943. }
  10944. inline std::string MultipartFormDataWriter::content_type() const {
  10945. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10946. }
  10947. inline std::string
  10948. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10949. return detail::serialize_multipart_formdata(items, boundary_);
  10950. }
  10951. inline size_t MultipartFormDataWriter::content_length(
  10952. const UploadFormDataItems &items) const {
  10953. return detail::get_multipart_content_length(items, boundary_);
  10954. }
  10955. inline std::string
  10956. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10957. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10958. }
  10959. inline std::string MultipartFormDataWriter::item_end() {
  10960. return detail::serialize_multipart_formdata_item_end();
  10961. }
  10962. inline std::string MultipartFormDataWriter::finish() const {
  10963. return detail::serialize_multipart_formdata_finish(boundary_);
  10964. }
  10965. // Response implementation
  10966. namespace detail {
  10967. // A response has one content source: `body`, a content provider, or a file.
  10968. // Each content setter calls this so that the one called last wins.
  10969. inline void clear_content_provider(Response &res) {
  10970. auto releaser = std::move(res.content_provider_resource_releaser_);
  10971. auto success = res.content_provider_success_;
  10972. res.content_length_ = 0;
  10973. res.content_provider_ = nullptr;
  10974. res.content_provider_resource_releaser_ = nullptr;
  10975. res.is_chunked_content_provider_ = false;
  10976. res.is_file_content_provider_ = false;
  10977. res.content_provider_success_ = false;
  10978. res.content_coding_ = EncodingType::None;
  10979. res.file_content_path_.clear();
  10980. res.file_content_content_type_.clear();
  10981. if (releaser) { releaser(success); }
  10982. }
  10983. inline void clear_content(Response &res) {
  10984. res.body.clear();
  10985. clear_content_provider(res);
  10986. }
  10987. // The Content-Type of the old content goes with it.
  10988. inline void set_content_type(Response &res, const std::string &content_type) {
  10989. res.headers.erase("Content-Type");
  10990. res.set_header("Content-Type", content_type);
  10991. }
  10992. // `body` is public, so it can be assigned directly after a provider or a file
  10993. // was set. It came last, so it wins.
  10994. inline void prefer_assigned_body(Response &res) {
  10995. if (!res.body.empty() &&
  10996. (res.content_provider_ || !res.file_content_path_.empty())) {
  10997. clear_content_provider(res);
  10998. }
  10999. }
  11000. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  11001. inline bool body_allowed_for_status(int status) {
  11002. return status >= 200 && status != StatusCode::NoContent_204 &&
  11003. status != StatusCode::NotModified_304;
  11004. }
  11005. // Only a 206 response is served as a partial representation. range_error()
  11006. // validates `req.ranges` only for a 2xx status, so slicing under any other
  11007. // status would start from an unchecked offset.
  11008. inline bool is_partial_content(const Request &req, const Response &res) {
  11009. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11010. }
  11011. // Sets the Content-Length or Transfer-Encoding framing the body that
  11012. // Server::write_response_core() writes, or closes the connection after a body
  11013. // that has neither. Only the library sets them: one from a handler would go
  11014. // out next to it, or describe some other body.
  11015. inline void set_framing_headers(const Request &req, Response &res,
  11016. const std::string &boundary,
  11017. const std::string &content_type) {
  11018. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  11019. auto head_length = req.method == "HEAD"
  11020. ? res.get_header_value("Content-Length")
  11021. : std::string();
  11022. res.headers.erase("Content-Length");
  11023. res.headers.erase("Transfer-Encoding");
  11024. if (!body_allowed_for_status(res.status)) { return; }
  11025. if (res.content_provider_) {
  11026. if (res.content_length_ == 0) {
  11027. if (res.is_chunked_content_provider_) {
  11028. res.set_header("Transfer-Encoding", "chunked");
  11029. } else if (req.method != "HEAD") {
  11030. // RFC 9112 6.3: a body with neither ends where the connection does.
  11031. res.headers.erase("Keep-Alive");
  11032. if (!has_header_token(res.headers, "Connection", "close")) {
  11033. res.set_header("Connection", "close");
  11034. }
  11035. }
  11036. return;
  11037. }
  11038. // The part Server::write_content_with_provider() writes.
  11039. auto length = res.content_length_;
  11040. if (is_partial_content(req, res)) {
  11041. length = req.ranges.size() == 1
  11042. ? get_range_offset_and_length(req.ranges[0], length).second
  11043. : get_multipart_ranges_data_length(req, boundary,
  11044. content_type, length);
  11045. }
  11046. res.set_header("Content-Length", std::to_string(length));
  11047. } else if (!res.body.empty()) {
  11048. res.set_header("Content-Length", std::to_string(res.body.size()));
  11049. } else {
  11050. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  11051. }
  11052. }
  11053. } // namespace detail
  11054. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  11055. size_t id) const {
  11056. return detail::get_header_value_u64(headers, key, def, id);
  11057. }
  11058. inline bool Response::has_header(const std::string &key) const {
  11059. return headers.find(key) != headers.end();
  11060. }
  11061. inline std::string Response::get_header_value(const std::string &key,
  11062. const char *def,
  11063. size_t id) const {
  11064. return detail::get_header_value(headers, key, def, id);
  11065. }
  11066. inline size_t Response::get_header_value_count(const std::string &key) const {
  11067. return detail::get_header_value_count(headers, key);
  11068. }
  11069. inline void Response::set_header(const std::string &key,
  11070. const std::string &val) {
  11071. detail::set_header(headers, key, val);
  11072. }
  11073. inline bool Response::has_trailer(const std::string &key) const {
  11074. return trailers.find(key) != trailers.end();
  11075. }
  11076. inline std::string Response::get_trailer_value(const std::string &key,
  11077. size_t id) const {
  11078. return detail::get_multimap_value(trailers, key, id);
  11079. }
  11080. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  11081. return trailers.count(key);
  11082. }
  11083. inline void Response::set_redirect(const std::string &url, int stat) {
  11084. if (detail::fields::is_field_value(url)) {
  11085. set_header("Location", url);
  11086. if (300 <= stat && stat < 400) {
  11087. this->status = stat;
  11088. } else {
  11089. this->status = StatusCode::Found_302;
  11090. }
  11091. }
  11092. }
  11093. inline void Response::set_content(const char *s, size_t n,
  11094. const std::string &content_type) {
  11095. body.assign(s, n); // Before the releaser runs; it may own `s`.
  11096. detail::clear_content_provider(*this);
  11097. detail::set_content_type(*this, content_type);
  11098. }
  11099. inline void Response::set_content(const std::string &s,
  11100. const std::string &content_type) {
  11101. set_content(s.data(), s.size(), content_type);
  11102. }
  11103. inline void Response::set_content(std::string &&s,
  11104. const std::string &content_type) {
  11105. body = std::move(s);
  11106. detail::clear_content_provider(*this);
  11107. detail::set_content_type(*this, content_type);
  11108. }
  11109. inline void Response::set_content_provider(
  11110. size_t in_length, const std::string &content_type, ContentProvider provider,
  11111. ContentProviderResourceReleaser resource_releaser) {
  11112. detail::clear_content(*this);
  11113. detail::set_content_type(*this, content_type);
  11114. content_length_ = in_length;
  11115. if (in_length > 0) { content_provider_ = std::move(provider); }
  11116. content_provider_resource_releaser_ = std::move(resource_releaser);
  11117. }
  11118. inline void Response::set_content_provider(
  11119. const std::string &content_type, ContentProviderWithoutLength provider,
  11120. ContentProviderResourceReleaser resource_releaser) {
  11121. detail::clear_content(*this);
  11122. detail::set_content_type(*this, content_type);
  11123. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  11124. content_provider_resource_releaser_ = std::move(resource_releaser);
  11125. }
  11126. inline void Response::set_chunked_content_provider(
  11127. const std::string &content_type, ContentProviderWithoutLength provider,
  11128. ContentProviderResourceReleaser resource_releaser) {
  11129. set_content_provider(content_type, std::move(provider),
  11130. std::move(resource_releaser));
  11131. is_chunked_content_provider_ = true;
  11132. }
  11133. inline void Response::set_file_content(const std::string &path,
  11134. const std::string &content_type) {
  11135. detail::clear_content(*this);
  11136. headers.erase("Content-Type");
  11137. file_content_path_ = path;
  11138. file_content_content_type_ = content_type;
  11139. }
  11140. inline void Response::set_file_content(const std::string &path) {
  11141. set_file_content(path, std::string());
  11142. }
  11143. // Result implementation
  11144. inline size_t Result::get_request_header_value_u64(const std::string &key,
  11145. size_t def,
  11146. size_t id) const {
  11147. return detail::get_header_value_u64(request_headers_, key, def, id);
  11148. }
  11149. inline bool Result::has_request_header(const std::string &key) const {
  11150. return request_headers_.find(key) != request_headers_.end();
  11151. }
  11152. inline std::string Result::get_request_header_value(const std::string &key,
  11153. const char *def,
  11154. size_t id) const {
  11155. return detail::get_header_value(request_headers_, key, def, id);
  11156. }
  11157. inline size_t
  11158. Result::get_request_header_value_count(const std::string &key) const {
  11159. return request_headers_.count(key);
  11160. }
  11161. // Stream implementation
  11162. inline ssize_t Stream::write(const char *ptr) {
  11163. return write(ptr, strlen(ptr));
  11164. }
  11165. inline ssize_t Stream::write(const std::string &s) {
  11166. return write(s.data(), s.size());
  11167. }
  11168. // BodyReader implementation
  11169. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  11170. if (!stream) {
  11171. last_error = Error::Connection;
  11172. return -1;
  11173. }
  11174. if (eof) { return 0; }
  11175. if (!chunked) {
  11176. // Content-Length based reading
  11177. if (has_content_length && bytes_read >= content_length) {
  11178. eof = true;
  11179. return 0;
  11180. }
  11181. auto to_read = len;
  11182. if (has_content_length) {
  11183. auto remaining = content_length - bytes_read;
  11184. to_read = (std::min)(len, remaining);
  11185. }
  11186. auto n = stream->read(buf, to_read);
  11187. // Without Content-Length the body ends when the connection closes
  11188. // (RFC 9112 §6.3); with one, an EOF here came too early
  11189. if (n < 0 || (n == 0 && has_content_length)) {
  11190. last_error = stream->get_error();
  11191. if (last_error == Error::Success) { last_error = Error::Read; }
  11192. }
  11193. if (n <= 0) {
  11194. eof = true;
  11195. return n;
  11196. }
  11197. bytes_read += static_cast<size_t>(n);
  11198. if (has_content_length && bytes_read >= content_length) { eof = true; }
  11199. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  11200. last_error = Error::ExceedMaxPayloadSize;
  11201. eof = true;
  11202. return -1;
  11203. }
  11204. return n;
  11205. }
  11206. // Chunked transfer encoding: delegate to shared decoder instance.
  11207. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  11208. size_t chunk_offset = 0;
  11209. size_t chunk_total = 0;
  11210. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  11211. if (n < 0) {
  11212. last_error = stream->get_error();
  11213. if (last_error == Error::Success) { last_error = Error::Read; }
  11214. eof = true;
  11215. return n;
  11216. }
  11217. if (n == 0) {
  11218. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  11219. eof = true;
  11220. return 0;
  11221. }
  11222. bytes_read += static_cast<size_t>(n);
  11223. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  11224. last_error = Error::ExceedMaxPayloadSize;
  11225. eof = true;
  11226. return -1;
  11227. }
  11228. return n;
  11229. }
  11230. // ThreadPool implementation
  11231. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  11232. time_t idle_timeout_sec)
  11233. : base_thread_count_(n), max_queued_requests_(mqr),
  11234. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  11235. shutdown_(false) {
  11236. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11237. if (max_n != 0 && max_n < n) {
  11238. std::string msg = "max_threads must be >= base_threads";
  11239. throw std::invalid_argument(msg);
  11240. }
  11241. #endif
  11242. max_thread_count_ = max_n == 0 ? n : max_n;
  11243. threads_.reserve(base_thread_count_);
  11244. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11245. try {
  11246. #endif
  11247. for (size_t i = 0; i < base_thread_count_; i++) {
  11248. threads_.emplace_back(std::thread([this]() { worker(false); }));
  11249. }
  11250. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11251. } catch (...) {
  11252. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  11253. // signal the workers we already spawned to exit and join them so the
  11254. // vector destructor does not see joinable threads (which would call
  11255. // std::terminate). Then rethrow so the caller learns of the failure.
  11256. {
  11257. std::unique_lock<std::mutex> lock(mutex_);
  11258. shutdown_ = true;
  11259. }
  11260. cond_.notify_all();
  11261. for (auto &t : threads_) {
  11262. if (t.joinable()) { t.join(); }
  11263. }
  11264. throw;
  11265. }
  11266. #endif
  11267. }
  11268. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  11269. {
  11270. std::unique_lock<std::mutex> lock(mutex_);
  11271. if (shutdown_) { return false; }
  11272. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  11273. return false;
  11274. }
  11275. jobs_.push_back(std::move(fn));
  11276. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  11277. if (jobs_.size() > idle_thread_count_ &&
  11278. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  11279. cleanup_finished_threads();
  11280. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11281. try {
  11282. #endif
  11283. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  11284. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11285. } catch (const std::system_error &) {
  11286. // No thread budget left: keep the job queued for an existing worker
  11287. // instead of letting the exception escape the accept loop.
  11288. }
  11289. #endif
  11290. }
  11291. }
  11292. cond_.notify_one();
  11293. return true;
  11294. }
  11295. inline void ThreadPool::shutdown() {
  11296. {
  11297. std::unique_lock<std::mutex> lock(mutex_);
  11298. shutdown_ = true;
  11299. }
  11300. cond_.notify_all();
  11301. for (auto &t : threads_) {
  11302. if (t.joinable()) { t.join(); }
  11303. }
  11304. // Move dynamic_threads_ to a local list under the lock to avoid racing
  11305. // with worker threads that call move_to_finished() concurrently.
  11306. std::list<std::thread> remaining_dynamic;
  11307. {
  11308. std::unique_lock<std::mutex> lock(mutex_);
  11309. remaining_dynamic = std::move(dynamic_threads_);
  11310. }
  11311. for (auto &t : remaining_dynamic) {
  11312. if (t.joinable()) { t.join(); }
  11313. }
  11314. std::unique_lock<std::mutex> lock(mutex_);
  11315. cleanup_finished_threads();
  11316. }
  11317. inline void ThreadPool::move_to_finished(std::thread::id id) {
  11318. // Must be called with mutex_ held
  11319. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  11320. if (it->get_id() == id) {
  11321. finished_threads_.push_back(std::move(*it));
  11322. dynamic_threads_.erase(it);
  11323. return;
  11324. }
  11325. }
  11326. }
  11327. inline void ThreadPool::cleanup_finished_threads() {
  11328. // Must be called with mutex_ held
  11329. for (auto &t : finished_threads_) {
  11330. if (t.joinable()) { t.join(); }
  11331. }
  11332. finished_threads_.clear();
  11333. }
  11334. inline void ThreadPool::worker(bool is_dynamic) {
  11335. for (;;) {
  11336. std::function<void()> fn;
  11337. {
  11338. std::unique_lock<std::mutex> lock(mutex_);
  11339. idle_thread_count_++;
  11340. if (is_dynamic) {
  11341. auto has_work =
  11342. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  11343. [&] { return !jobs_.empty() || shutdown_; });
  11344. if (!has_work) {
  11345. // Timed out with no work - exit this dynamic thread
  11346. idle_thread_count_--;
  11347. move_to_finished(std::this_thread::get_id());
  11348. break;
  11349. }
  11350. } else {
  11351. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  11352. }
  11353. idle_thread_count_--;
  11354. if (shutdown_ && jobs_.empty()) { break; }
  11355. fn = std::move(jobs_.front());
  11356. jobs_.pop_front();
  11357. }
  11358. assert(true == static_cast<bool>(fn));
  11359. fn();
  11360. }
  11361. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  11362. !defined(LIBRESSL_VERSION_NUMBER)
  11363. OPENSSL_thread_stop();
  11364. #endif
  11365. }
  11366. /*
  11367. * Group 1 (continued): detail namespace - Stream implementations
  11368. */
  11369. namespace detail {
  11370. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  11371. time_t timeout_sec, time_t timeout_usec,
  11372. time_t &actual_timeout_sec,
  11373. time_t &actual_timeout_usec) {
  11374. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  11375. auto actual_timeout_msec =
  11376. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  11377. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  11378. actual_timeout_sec = actual_timeout_msec / 1000;
  11379. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  11380. }
  11381. // Socket stream implementation
  11382. inline SocketStream::SocketStream(
  11383. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  11384. time_t write_timeout_sec, time_t write_timeout_usec,
  11385. time_t max_timeout_msec,
  11386. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11387. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  11388. read_timeout_usec_(read_timeout_usec),
  11389. write_timeout_sec_(write_timeout_sec),
  11390. write_timeout_usec_(write_timeout_usec),
  11391. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {}
  11392. inline SocketStream::~SocketStream() = default;
  11393. inline bool SocketStream::is_readable() const {
  11394. return read_buff_off_ < read_buff_content_size_;
  11395. }
  11396. inline bool SocketStream::wait_readable() const {
  11397. if (max_timeout_msec_ <= 0) {
  11398. return select_read_interruptible(sock_, read_timeout_sec_,
  11399. read_timeout_usec_, read_interrupted_) > 0;
  11400. }
  11401. time_t read_timeout_sec;
  11402. time_t read_timeout_usec;
  11403. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11404. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11405. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11406. read_interrupted_) > 0;
  11407. }
  11408. inline bool SocketStream::wait_writable() const {
  11409. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11410. }
  11411. inline bool SocketStream::ensure_readable() {
  11412. if (readable_hint_) {
  11413. readable_hint_ = false;
  11414. return true;
  11415. }
  11416. return wait_readable();
  11417. }
  11418. inline const char *SocketStream::buffered_data(size_t &size) const {
  11419. size = read_buff_content_size_ - read_buff_off_;
  11420. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  11421. }
  11422. inline void SocketStream::release_buffer() {
  11423. assert(read_buff_off_ == read_buff_content_size_);
  11424. std::vector<char>().swap(read_buff_);
  11425. }
  11426. inline void SocketStream::consume_buffered(size_t size) {
  11427. assert(size <= read_buff_content_size_ - read_buff_off_);
  11428. read_buff_off_ += size;
  11429. }
  11430. inline bool SocketStream::is_peer_alive() const {
  11431. return detail::is_socket_alive(sock_);
  11432. }
  11433. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  11434. #ifdef _WIN32
  11435. size =
  11436. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  11437. #else
  11438. size = (std::min)(size,
  11439. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  11440. #endif
  11441. if (read_buff_off_ < read_buff_content_size_) {
  11442. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  11443. if (size <= remaining_size) {
  11444. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  11445. read_buff_off_ += size;
  11446. return static_cast<ssize_t>(size);
  11447. } else {
  11448. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  11449. read_buff_off_ += remaining_size;
  11450. return static_cast<ssize_t>(remaining_size);
  11451. }
  11452. }
  11453. if (!ensure_readable()) {
  11454. error_ = Error::Timeout;
  11455. return -1;
  11456. }
  11457. read_buff_off_ = 0;
  11458. read_buff_content_size_ = 0;
  11459. if (size < read_buff_size_) {
  11460. // Allocated on the first use, which an idle connection may never make.
  11461. if (read_buff_.empty()) { read_buff_.resize(read_buff_size_); }
  11462. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  11463. CPPHTTPLIB_RECV_FLAGS);
  11464. if (n <= 0) {
  11465. if (n == 0) {
  11466. error_ = Error::ConnectionClosed;
  11467. } else {
  11468. error_ = Error::Read;
  11469. }
  11470. return n;
  11471. } else if (n <= static_cast<ssize_t>(size)) {
  11472. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  11473. return n;
  11474. } else {
  11475. memcpy(ptr, read_buff_.data(), size);
  11476. read_buff_off_ = size;
  11477. read_buff_content_size_ = static_cast<size_t>(n);
  11478. return static_cast<ssize_t>(size);
  11479. }
  11480. } else {
  11481. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  11482. if (n <= 0) {
  11483. if (n == 0) {
  11484. error_ = Error::ConnectionClosed;
  11485. } else {
  11486. error_ = Error::Read;
  11487. }
  11488. }
  11489. return n;
  11490. }
  11491. }
  11492. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  11493. if (!wait_writable()) { return -1; }
  11494. // Winsock's send() takes an int length, even on 64-bit Windows
  11495. #ifdef _WIN32
  11496. size =
  11497. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  11498. #endif
  11499. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  11500. }
  11501. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  11502. int &port) const {
  11503. return detail::get_remote_ip_and_port(sock_, ip, port);
  11504. }
  11505. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  11506. int &port) const {
  11507. return detail::get_local_ip_and_port(sock_, ip, port);
  11508. }
  11509. inline socket_t SocketStream::socket() const { return sock_; }
  11510. inline time_t SocketStream::duration() const {
  11511. return static_cast<time_t>(
  11512. std::chrono::duration_cast<std::chrono::milliseconds>(
  11513. std::chrono::steady_clock::now() - start_time_)
  11514. .count());
  11515. }
  11516. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  11517. read_timeout_sec_ = sec;
  11518. read_timeout_usec_ = usec;
  11519. }
  11520. inline void SocketStream::set_max_timeout(time_t msec) {
  11521. max_timeout_msec_ = msec;
  11522. start_time_ = std::chrono::steady_clock::now();
  11523. }
  11524. inline void
  11525. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11526. read_interrupted_ = std::move(interrupted);
  11527. }
  11528. // Buffer stream implementation
  11529. inline bool BufferStream::is_readable() const { return true; }
  11530. inline bool BufferStream::wait_readable() const { return true; }
  11531. inline bool BufferStream::wait_writable() const { return true; }
  11532. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  11533. #if defined(_MSC_VER) && _MSC_VER < 1910
  11534. auto len_read = buffer._Copy_s(ptr, size, size, position);
  11535. #else
  11536. auto len_read = buffer.copy(ptr, size, position);
  11537. #endif
  11538. position += static_cast<size_t>(len_read);
  11539. return static_cast<ssize_t>(len_read);
  11540. }
  11541. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  11542. buffer.append(ptr, size);
  11543. return static_cast<ssize_t>(size);
  11544. }
  11545. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  11546. int & /*port*/) const {}
  11547. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  11548. int & /*port*/) const {}
  11549. inline socket_t BufferStream::socket() const { return 0; }
  11550. inline time_t BufferStream::duration() const { return 0; }
  11551. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  11552. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  11553. : MatcherBase(pattern) {
  11554. constexpr const char marker[] = "/:";
  11555. // One past the last ending position of a path param substring
  11556. std::size_t last_param_end = 0;
  11557. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11558. // Needed to ensure that parameter names are unique during matcher
  11559. // construction
  11560. // If exceptions are disabled, only last duplicate path
  11561. // parameter will be set
  11562. std::unordered_set<std::string> param_name_set;
  11563. #endif
  11564. while (true) {
  11565. const auto marker_pos = pattern.find(
  11566. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  11567. if (marker_pos == std::string::npos) { break; }
  11568. static_fragments_.push_back(
  11569. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  11570. const auto param_name_start = marker_pos + str_len(marker);
  11571. auto sep_pos = pattern.find(separator, param_name_start);
  11572. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  11573. auto param_name =
  11574. pattern.substr(param_name_start, sep_pos - param_name_start);
  11575. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11576. if (param_name_set.find(param_name) != param_name_set.cend()) {
  11577. std::string msg = "Encountered path parameter '" + param_name +
  11578. "' multiple times in route pattern '" + pattern + "'.";
  11579. throw std::invalid_argument(msg);
  11580. }
  11581. #endif
  11582. param_names_.push_back(std::move(param_name));
  11583. last_param_end = sep_pos + 1;
  11584. }
  11585. if (last_param_end < pattern.length()) {
  11586. static_fragments_.push_back(pattern.substr(last_param_end));
  11587. }
  11588. }
  11589. inline bool PathParamsMatcher::match(Request &request) const {
  11590. request.matches = std::smatch();
  11591. request.path_params.clear();
  11592. // A pattern without parameters is just a literal path to compare against
  11593. if (param_names_.empty()) { return request.path == pattern(); }
  11594. request.path_params.reserve(param_names_.size());
  11595. // One past the position at which the path matched the pattern last time
  11596. std::size_t starting_pos = 0;
  11597. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  11598. const auto &fragment = static_fragments_[i];
  11599. if (starting_pos + fragment.length() > request.path.length()) {
  11600. return false;
  11601. }
  11602. // Avoid unnecessary allocation by using strncmp instead of substr +
  11603. // comparison
  11604. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  11605. fragment.length()) != 0) {
  11606. return false;
  11607. }
  11608. starting_pos += fragment.length();
  11609. // Should only happen when we have a static fragment after a param
  11610. // Example: '/users/:id/subscriptions'
  11611. // The 'subscriptions' fragment here does not have a corresponding param
  11612. if (i >= param_names_.size()) { continue; }
  11613. auto sep_pos = request.path.find(separator, starting_pos);
  11614. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  11615. const auto &param_name = param_names_[i];
  11616. request.path_params.emplace(
  11617. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  11618. // Mark everything up to '/' as matched
  11619. starting_pos = sep_pos + 1;
  11620. }
  11621. // Returns false if the path is longer than the pattern
  11622. return starting_pos >= request.path.length();
  11623. }
  11624. inline bool RegexMatcher::match(Request &request) const {
  11625. request.path_params.clear();
  11626. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  11627. // a non-match rather than risking a stack overflow in std::regex_match.
  11628. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  11629. return false;
  11630. }
  11631. return std::regex_match(request.path, request.matches, regex_);
  11632. }
  11633. // Enclose IPv6 address in brackets if needed
  11634. inline std::string prepare_host_string(const std::string &host) {
  11635. // Enclose IPv6 address in brackets (but not if already enclosed)
  11636. if (host.find(':') == std::string::npos ||
  11637. (!host.empty() && host[0] == '[')) {
  11638. // IPv4, hostname, or already bracketed IPv6
  11639. return host;
  11640. } else {
  11641. // IPv6 address without brackets
  11642. return "[" + host + "]";
  11643. }
  11644. }
  11645. inline std::string make_host_and_port_string(const std::string &host, int port,
  11646. bool is_ssl) {
  11647. auto result = prepare_host_string(host);
  11648. // Append port if not default
  11649. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  11650. ; // do nothing
  11651. } else {
  11652. result += ":" + std::to_string(port);
  11653. }
  11654. return result;
  11655. }
  11656. // Create "host:port" string always including port number (for CONNECT method)
  11657. inline std::string
  11658. make_host_and_port_string_always_port(const std::string &host, int port) {
  11659. return prepare_host_string(host) + ":" + std::to_string(port);
  11660. }
  11661. // Where a client connects for `host`, as one string: the mapped address or
  11662. // name, or `host` itself.
  11663. inline std::string
  11664. addr_map_target(const std::map<std::string, std::string> &addr_map,
  11665. const std::string &host) {
  11666. std::string connect_host;
  11667. std::string ip;
  11668. apply_addr_map(addr_map, host, connect_host, ip);
  11669. return ip.empty() ? connect_host : ip;
  11670. }
  11671. // Request target of a CONNECT for `host`, with `addr_map` applied.
  11672. inline std::string
  11673. make_connect_request_target(const std::map<std::string, std::string> &addr_map,
  11674. const std::string &host, int port) {
  11675. return make_host_and_port_string_always_port(addr_map_target(addr_map, host),
  11676. port);
  11677. }
  11678. // Value for the Host header a client sends when the caller supplied none.
  11679. // Only the value: callers decide where in their header list it goes.
  11680. inline std::string make_default_host_header_value(const std::string &host,
  11681. int port, bool is_ssl,
  11682. int address_family) {
  11683. if (address_family == AF_UNIX) { return "localhost"; }
  11684. return make_host_and_port_string(host, port, is_ssl);
  11685. }
  11686. inline void add_default_user_agent_header(Request &req) {
  11687. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  11688. if (!req.has_header("User-Agent")) {
  11689. req.set_header("User-Agent",
  11690. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  11691. }
  11692. #else
  11693. (void)req;
  11694. #endif
  11695. }
  11696. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  11697. NormalizedTarget normalize_target(const std::string &host);
  11698. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  11699. bool host_matches_no_proxy(const NormalizedTarget &target,
  11700. const std::vector<NoProxyEntry> &entries);
  11701. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  11702. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  11703. if (prefix_bits == 0) { return true; }
  11704. int full_bytes = prefix_bits / 8;
  11705. int rem_bits = prefix_bits % 8;
  11706. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  11707. static_cast<size_t>(full_bytes)) != 0) {
  11708. return false;
  11709. }
  11710. if (rem_bits == 0) { return true; }
  11711. auto i = static_cast<size_t>(full_bytes);
  11712. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11713. return (ip[i] & mask) == (net[i] & mask);
  11714. }
  11715. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11716. if (token.empty()) { return false; }
  11717. if (token == "*") {
  11718. out.kind = NoProxyKind::Wildcard;
  11719. return true;
  11720. }
  11721. auto slash = token.find('/');
  11722. std::string addr_part =
  11723. (slash == std::string::npos) ? token : token.substr(0, slash);
  11724. std::string prefix_part =
  11725. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11726. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11727. // don't silently treat it as a /32 (or /128).
  11728. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11729. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11730. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11731. // when brackets are present.
  11732. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11733. addr_part.back() == ']';
  11734. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11735. if (!bracketed) {
  11736. struct in_addr v4;
  11737. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11738. int prefix = 32;
  11739. if (!prefix_part.empty() &&
  11740. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11741. prefix)) {
  11742. return false;
  11743. }
  11744. out.kind = NoProxyKind::IPv4Cidr;
  11745. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11746. out.prefix_bits = prefix;
  11747. return true;
  11748. }
  11749. }
  11750. struct in6_addr v6;
  11751. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11752. int prefix = 128;
  11753. if (!prefix_part.empty() &&
  11754. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11755. prefix)) {
  11756. return false;
  11757. }
  11758. out.kind = NoProxyKind::IPv6Cidr;
  11759. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11760. out.prefix_bits = prefix;
  11761. return true;
  11762. }
  11763. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11764. // the entry is malformed — don't fall through to the hostname branch.
  11765. if (bracketed) { return false; }
  11766. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11767. if (slash != std::string::npos) { return false; }
  11768. // Port-specific entries (host:port) are not supported.
  11769. if (token.find(':') != std::string::npos) { return false; }
  11770. std::string hostname = case_ignore::to_lower(token);
  11771. while (!hostname.empty() && hostname.front() == '.') {
  11772. hostname.erase(hostname.begin());
  11773. }
  11774. while (!hostname.empty() && hostname.back() == '.') {
  11775. hostname.pop_back();
  11776. }
  11777. if (hostname.empty()) { return false; }
  11778. out.kind = NoProxyKind::HostnameSuffix;
  11779. out.hostname_pattern = std::move(hostname);
  11780. return true;
  11781. }
  11782. inline std::vector<NoProxyEntry>
  11783. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11784. std::vector<NoProxyEntry> entries;
  11785. entries.reserve(patterns.size());
  11786. for (const auto &p : patterns) {
  11787. auto trimmed = trim_copy(p);
  11788. if (trimmed.empty()) { continue; }
  11789. NoProxyEntry entry;
  11790. if (parse_no_proxy_entry(trimmed, entry)) {
  11791. entries.push_back(std::move(entry));
  11792. }
  11793. }
  11794. return entries;
  11795. }
  11796. inline NormalizedTarget normalize_target(const std::string &host) {
  11797. NormalizedTarget t;
  11798. std::string h = host;
  11799. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11800. h = h.substr(1, h.size() - 2);
  11801. }
  11802. // Strip a single trailing dot so "example.com." canonicalizes to
  11803. // "example.com".
  11804. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11805. t.hostname = case_ignore::to_lower(h);
  11806. if (!t.hostname.empty()) {
  11807. struct in_addr v4;
  11808. struct in6_addr v6;
  11809. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11810. t.is_ipv4 = true;
  11811. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11812. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11813. t.is_ipv6 = true;
  11814. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11815. }
  11816. }
  11817. return t;
  11818. }
  11819. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11820. const std::vector<NoProxyEntry> &entries) {
  11821. if (target.hostname.empty()) { return false; }
  11822. for (const auto &e : entries) {
  11823. switch (e.kind) {
  11824. case NoProxyKind::Wildcard: return true;
  11825. case NoProxyKind::IPv4Cidr:
  11826. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11827. return true;
  11828. }
  11829. break;
  11830. case NoProxyKind::IPv6Cidr:
  11831. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11832. return true;
  11833. }
  11834. break;
  11835. case NoProxyKind::HostnameSuffix:
  11836. if (target.is_ipv4 || target.is_ipv6) { break; }
  11837. if (target.hostname == e.hostname_pattern) { return true; }
  11838. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11839. // an entry of "example.com".
  11840. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11841. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11842. if (target.hostname[offset - 1] == '.' &&
  11843. target.hostname.compare(offset, e.hostname_pattern.size(),
  11844. e.hostname_pattern) == 0) {
  11845. return true;
  11846. }
  11847. }
  11848. break;
  11849. }
  11850. }
  11851. return false;
  11852. }
  11853. template <typename T>
  11854. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11855. T header_writer, Error &error) {
  11856. for (const auto &h : headers) {
  11857. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11858. error = Error::InvalidHeaders;
  11859. return false;
  11860. }
  11861. }
  11862. if (header_writer(strm, headers) <= 0) {
  11863. error = Error::Write;
  11864. return false;
  11865. }
  11866. return true;
  11867. }
  11868. } // namespace detail
  11869. /*
  11870. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11871. */
  11872. #ifdef CPPHTTPLIB_SSL_ENABLED
  11873. namespace detail {
  11874. // SSL socket stream implementation
  11875. inline SSLSocketStream::SSLSocketStream(
  11876. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11877. time_t read_timeout_usec, time_t write_timeout_sec,
  11878. time_t write_timeout_usec, time_t max_timeout_msec,
  11879. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11880. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11881. read_timeout_usec_(read_timeout_usec),
  11882. write_timeout_sec_(write_timeout_sec),
  11883. write_timeout_usec_(write_timeout_usec),
  11884. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11885. tls_error_.code = tls::ErrorCode::Success;
  11886. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11887. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11888. // Note: create_session() also clears this, but SSLClient currently
  11889. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11890. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11891. // SSL session was created.
  11892. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11893. #endif
  11894. }
  11895. inline SSLSocketStream::~SSLSocketStream() = default;
  11896. inline bool SSLSocketStream::is_readable() const {
  11897. return tls::pending(session_) > 0;
  11898. }
  11899. inline bool SSLSocketStream::wait_readable() const {
  11900. if (max_timeout_msec_ <= 0) {
  11901. return select_read_interruptible(sock_, read_timeout_sec_,
  11902. read_timeout_usec_, read_interrupted_) > 0;
  11903. }
  11904. time_t read_timeout_sec;
  11905. time_t read_timeout_usec;
  11906. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11907. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11908. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11909. read_interrupted_) > 0;
  11910. }
  11911. inline bool SSLSocketStream::wait_writable() const {
  11912. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11913. !tls::is_peer_closed(session_, sock_);
  11914. }
  11915. inline bool SSLSocketStream::ensure_readable() {
  11916. if (readable_hint_) {
  11917. readable_hint_ = false;
  11918. return true;
  11919. }
  11920. return wait_readable();
  11921. }
  11922. inline bool SSLSocketStream::is_peer_alive() const {
  11923. return !tls::is_peer_closed(session_, sock_);
  11924. }
  11925. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11926. if (tls::pending(session_) > 0) {
  11927. tls::TlsError err;
  11928. auto ret = tls::read(session_, ptr, size, err);
  11929. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11930. error_ = Error::ConnectionClosed;
  11931. } else if (ret < 0) {
  11932. tls_error_ = err;
  11933. }
  11934. return ret;
  11935. } else if (ensure_readable()) {
  11936. tls::TlsError err;
  11937. auto ret = tls::read(session_, ptr, size, err);
  11938. if (ret < 0) {
  11939. auto n = 1000;
  11940. #ifdef _WIN32
  11941. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11942. (err.code == tls::ErrorCode::SyscallError &&
  11943. WSAGetLastError() == WSAETIMEDOUT))) {
  11944. #else
  11945. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11946. #endif
  11947. if (tls::pending(session_) > 0) {
  11948. ret = tls::read(session_, ptr, size, err);
  11949. if (ret >= 0) { return ret; }
  11950. break;
  11951. } else if (wait_readable()) {
  11952. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11953. ret = tls::read(session_, ptr, size, err);
  11954. if (ret >= 0) { return ret; }
  11955. } else {
  11956. break;
  11957. }
  11958. }
  11959. assert(ret < 0);
  11960. tls_error_ = err;
  11961. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11962. error_ = Error::ConnectionClosed;
  11963. }
  11964. return ret;
  11965. } else {
  11966. error_ = Error::Timeout;
  11967. return -1;
  11968. }
  11969. }
  11970. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11971. if (wait_writable()) {
  11972. auto handle_size =
  11973. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11974. tls::TlsError err;
  11975. auto ret = tls::write(session_, ptr, handle_size, err);
  11976. if (ret < 0) {
  11977. auto n = 1000;
  11978. #ifdef _WIN32
  11979. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11980. (err.code == tls::ErrorCode::SyscallError &&
  11981. WSAGetLastError() == WSAETIMEDOUT))) {
  11982. #else
  11983. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11984. #endif
  11985. if (wait_writable()) {
  11986. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11987. ret = tls::write(session_, ptr, handle_size, err);
  11988. if (ret >= 0) { return ret; }
  11989. } else {
  11990. break;
  11991. }
  11992. }
  11993. assert(ret < 0);
  11994. tls_error_ = err;
  11995. }
  11996. return ret;
  11997. }
  11998. return -1;
  11999. }
  12000. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  12001. int &port) const {
  12002. detail::get_remote_ip_and_port(sock_, ip, port);
  12003. }
  12004. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  12005. int &port) const {
  12006. detail::get_local_ip_and_port(sock_, ip, port);
  12007. }
  12008. inline socket_t SSLSocketStream::socket() const { return sock_; }
  12009. inline time_t SSLSocketStream::duration() const {
  12010. return static_cast<time_t>(
  12011. std::chrono::duration_cast<std::chrono::milliseconds>(
  12012. std::chrono::steady_clock::now() - start_time_)
  12013. .count());
  12014. }
  12015. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  12016. read_timeout_sec_ = sec;
  12017. read_timeout_usec_ = usec;
  12018. }
  12019. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  12020. max_timeout_msec_ = msec;
  12021. start_time_ = std::chrono::steady_clock::now();
  12022. }
  12023. inline void
  12024. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  12025. read_interrupted_ = std::move(interrupted);
  12026. }
  12027. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  12028. tls::session_t session,
  12029. time_t read_timeout_sec,
  12030. time_t read_timeout_usec,
  12031. time_t write_timeout_sec,
  12032. time_t write_timeout_usec)
  12033. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  12034. read_timeout_usec_(read_timeout_usec),
  12035. write_timeout_sec_(write_timeout_sec),
  12036. write_timeout_usec_(write_timeout_usec),
  12037. start_time_(std::chrono::steady_clock::now().time_since_epoch().count()) {
  12038. // The receive and send paths run on different threads, so each TLS call is
  12039. // driven in non-blocking mode and readiness is awaited with select()
  12040. // outside the session lock. Set the socket non-blocking once here; it is
  12041. // never flipped back, so no thread races on the flag.
  12042. detail::set_nonblocking(sock_, true);
  12043. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  12044. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  12045. #endif
  12046. }
  12047. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  12048. inline bool WebSocketSSLStream::is_readable() const {
  12049. std::lock_guard<std::mutex> guard(session_mutex_);
  12050. return tls::pending(session_) > 0;
  12051. }
  12052. inline bool WebSocketSSLStream::wait_readable() const {
  12053. auto max_timeout_msec = max_timeout_msec_.load();
  12054. if (max_timeout_msec <= 0) {
  12055. return select_read_interruptible(sock_, read_timeout_sec_,
  12056. read_timeout_usec_, read_interrupted_) > 0;
  12057. }
  12058. time_t read_timeout_sec;
  12059. time_t read_timeout_usec;
  12060. calc_actual_timeout(max_timeout_msec, duration(), read_timeout_sec_,
  12061. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  12062. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  12063. read_interrupted_) > 0;
  12064. }
  12065. inline bool WebSocketSSLStream::wait_writable() const {
  12066. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  12067. // that probe toggles the socket's blocking flag, which would race with the
  12068. // concurrent reader on a permanently non-blocking socket.
  12069. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  12070. }
  12071. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  12072. tls::TlsError err;
  12073. auto n = 1000;
  12074. while (--n >= 0) {
  12075. {
  12076. std::lock_guard<std::mutex> guard(session_mutex_);
  12077. auto ret = tls::read(session_, ptr, size, err);
  12078. if (ret > 0) { return ret; }
  12079. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  12080. error_ = Error::ConnectionClosed;
  12081. return ret;
  12082. }
  12083. }
  12084. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  12085. // direction: the send path shares this session, so output it left pending
  12086. // has to be flushed before more input can be decrypted. Anything else is
  12087. // a hard error.
  12088. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  12089. #ifdef _WIN32
  12090. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  12091. needs_readable =
  12092. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  12093. WSAGetLastError() == WSAETIMEDOUT);
  12094. #endif
  12095. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  12096. error_ = Error::Read;
  12097. return -1;
  12098. }
  12099. if (!(needs_readable ? wait_readable() : wait_writable())) {
  12100. error_ = Error::Timeout;
  12101. return -1;
  12102. }
  12103. }
  12104. // Out of retries. Recording a reason matters: a caller that reads get_error()
  12105. // to tell a timeout from a close would otherwise see whatever the previous
  12106. // failure left behind (error_ is never cleared on success).
  12107. error_ = Error::Read;
  12108. return -1;
  12109. }
  12110. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  12111. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  12112. tls::TlsError err;
  12113. auto n = 1000;
  12114. while (--n >= 0) {
  12115. {
  12116. std::lock_guard<std::mutex> guard(session_mutex_);
  12117. auto ret = tls::write(session_, ptr, handle_size, err);
  12118. if (ret >= 0) { return ret; }
  12119. }
  12120. // ret < 0. As in read(), either direction can be needed: a renegotiation
  12121. // or a post-handshake message must be consumed before the record goes
  12122. // out. Anything else is a hard error.
  12123. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  12124. #ifdef _WIN32
  12125. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  12126. needs_writable =
  12127. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  12128. WSAGetLastError() == WSAETIMEDOUT);
  12129. #endif
  12130. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  12131. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  12132. }
  12133. return -1;
  12134. }
  12135. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  12136. int &port) const {
  12137. detail::get_remote_ip_and_port(sock_, ip, port);
  12138. }
  12139. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  12140. int &port) const {
  12141. detail::get_local_ip_and_port(sock_, ip, port);
  12142. }
  12143. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  12144. inline time_t WebSocketSSLStream::duration() const {
  12145. auto start = std::chrono::steady_clock::time_point(
  12146. std::chrono::steady_clock::duration(start_time_.load()));
  12147. return static_cast<time_t>(
  12148. std::chrono::duration_cast<std::chrono::milliseconds>(
  12149. std::chrono::steady_clock::now() - start)
  12150. .count());
  12151. }
  12152. // Start time first: a reader that sees the new bound also sees its start
  12153. inline void WebSocketSSLStream::set_max_timeout(time_t msec) {
  12154. start_time_ = std::chrono::steady_clock::now().time_since_epoch().count();
  12155. max_timeout_msec_ = msec;
  12156. }
  12157. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  12158. read_timeout_sec_ = sec;
  12159. read_timeout_usec_ = usec;
  12160. }
  12161. inline void
  12162. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  12163. read_interrupted_ = std::move(interrupted);
  12164. }
  12165. } // namespace detail
  12166. #endif // CPPHTTPLIB_SSL_ENABLED
  12167. /*
  12168. * Group 4: Server implementation
  12169. */
  12170. // A kept-alive connection that the event loop of set_keep_alive_parking()
  12171. // owns while it is idle, and a worker owns while it serves a request. A
  12172. // derived class adds the transport: the stream, and for TLS the session.
  12173. struct Server::KeepAliveConnection {
  12174. KeepAliveConnection(socket_t s, Server &server) : svr(server), sock(s) {}
  12175. // Every owner closes it before letting go, which the transport hooks need;
  12176. // this is only a net, which cannot reach them any more.
  12177. virtual ~KeepAliveConnection() {
  12178. if (sock != INVALID_SOCKET) { detail::drain_and_close_socket(sock, 0); }
  12179. }
  12180. // On a worker before the first request, e.g. for a TLS handshake. False
  12181. // closes the connection. One that reads from the socket clears turn.woken.
  12182. virtual bool open() { return true; }
  12183. // Serves requests while they come: serve_on() with the transport's stream.
  12184. virtual bool serve() = 0;
  12185. // Before it is parked. Nothing is buffered then.
  12186. virtual void release_buffers() {}
  12187. // Before the socket of an open connection is closed, e.g. to send TLS
  12188. // close_notify.
  12189. virtual void shut_down(bool /*graceful*/) {}
  12190. // On a worker, once the event loop has seen the socket readable. Afterwards
  12191. // turn.park tells whether it may be parked again.
  12192. bool resume() {
  12193. turn = Turn();
  12194. return svr.serve_guarded([this]() {
  12195. if (!opened) {
  12196. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12197. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12198. if (!open()) { return false; }
  12199. opened = true;
  12200. }
  12201. return serve();
  12202. });
  12203. }
  12204. // From the event loop, which must not wait for the peer.
  12205. void close_idle() {
  12206. assert(sock != INVALID_SOCKET);
  12207. if (opened) {
  12208. detail::set_nonblocking(sock, true);
  12209. shut_down(true);
  12210. }
  12211. detail::drain_and_close_socket(sock, 0);
  12212. sock = INVALID_SOCKET;
  12213. }
  12214. // From the worker that served it.
  12215. void close_served(bool graceful) {
  12216. assert(sock != INVALID_SOCKET);
  12217. if (opened) {
  12218. shut_down(graceful);
  12219. detail::drain_and_close_socket(sock);
  12220. } else {
  12221. // It never got as far as a request, e.g. a failed TLS handshake.
  12222. detail::shutdown_socket(sock);
  12223. detail::close_socket(sock);
  12224. }
  12225. sock = INVALID_SOCKET;
  12226. }
  12227. template <typename S>
  12228. bool serve_on(S &strm,
  12229. const std::function<void(Request &)> &setup_request = nullptr) {
  12230. return detail::process_server_socket_core(
  12231. strm, served, svr.keep_alive_max_count_,
  12232. [this]() { return wait_for_next_request(); },
  12233. [&](Stream &s, bool close_connection, bool &connection_closed) {
  12234. return svr.process_request(s, remote_addr, remote_port, local_addr,
  12235. local_port, close_connection,
  12236. connection_closed, setup_request,
  12237. &turn.websocket_upgraded);
  12238. });
  12239. }
  12240. bool wait_for_next_request() {
  12241. // The event loop saw the socket readable just before this ran.
  12242. if (turn.woken) {
  12243. turn.woken = false;
  12244. return true;
  12245. }
  12246. if (svr.is_stopping()) { return false; }
  12247. // Waiting here for a slow client would keep the worker from others.
  12248. turn.park = detail::select_read(sock, 0, 0) <= 0;
  12249. return !turn.park;
  12250. }
  12251. // A worker's time with it, from resume() until it is parked or closed.
  12252. struct Turn {
  12253. bool woken = true;
  12254. bool park = false;
  12255. bool websocket_upgraded = false;
  12256. };
  12257. Server &svr;
  12258. socket_t sock;
  12259. int remote_port = 0;
  12260. int local_port = 0;
  12261. bool opened = false; // by resume(), once open() has succeeded
  12262. Turn turn;
  12263. size_t served = 0;
  12264. std::string remote_addr;
  12265. std::string local_addr;
  12266. // While parked
  12267. std::list<std::shared_ptr<KeepAliveConnection>>::iterator parked_at;
  12268. std::chrono::steady_clock::time_point deadline;
  12269. };
  12270. struct Server::PlainConnection final : Server::KeepAliveConnection {
  12271. PlainConnection(socket_t s, Server &server)
  12272. : KeepAliveConnection(s, server),
  12273. strm(s, server.read_timeout_sec_, server.read_timeout_usec_,
  12274. server.write_timeout_sec_, server.write_timeout_usec_) {}
  12275. bool serve() override { return serve_on(strm); }
  12276. void release_buffers() override { strm.release_buffer(); }
  12277. // Kept across requests: it may hold the start of a pipelined request.
  12278. detail::SocketStream strm;
  12279. };
  12280. struct Server::ParkingState {
  12281. using Clock = std::chrono::steady_clock;
  12282. using Token = detail::Poller::Token;
  12283. using Connection = std::shared_ptr<KeepAliveConnection>;
  12284. // Kept for the Server's life, so that stop() can wake() it without a lock.
  12285. std::unique_ptr<detail::Poller> poller;
  12286. // The listening socket while parking_loop() watches it. Whichever of stop()
  12287. // and parking_loop() takes it out of here decides who closes it, so that it
  12288. // is never closed while the poller still watches it.
  12289. std::atomic<socket_t> listen_sock{INVALID_SOCKET};
  12290. // From stop(): whether parking_loop() takes over closing `sock`.
  12291. bool release_listen(socket_t sock) {
  12292. if (!listen_sock.compare_exchange_strong(sock, INVALID_SOCKET)) {
  12293. return false;
  12294. }
  12295. poller->wake();
  12296. return true;
  12297. }
  12298. // From a worker: hands an idle connection back, unless the loop has ended.
  12299. bool give_back(Connection conn) {
  12300. {
  12301. std::lock_guard<std::mutex> guard(mutex);
  12302. if (closed) { return false; }
  12303. returned.push_back(std::move(conn));
  12304. }
  12305. poller->wake();
  12306. return true;
  12307. }
  12308. // The rest belongs to parking_loop(). A parked connection's token is its
  12309. // address, and `parked` lists them in the order they expire.
  12310. // Closes it and returns false when the poller cannot watch it: unwatched,
  12311. // it would only wait for its deadline.
  12312. bool park(Connection conn, Clock::time_point deadline) {
  12313. auto &c = *conn;
  12314. c.deadline = deadline;
  12315. c.parked_at = parked.insert(parked.end(), std::move(conn));
  12316. if (poller->arm(c.sock, reinterpret_cast<Token>(&c))) { return true; }
  12317. unpark(reinterpret_cast<Token>(&c))->close_idle();
  12318. return false;
  12319. }
  12320. Connection unpark(Token token) {
  12321. auto &c = *reinterpret_cast<KeepAliveConnection *>(token);
  12322. auto conn = std::move(*c.parked_at);
  12323. parked.erase(c.parked_at);
  12324. return conn;
  12325. }
  12326. Clock::time_point next_deadline() const {
  12327. return parked.empty() ? (Clock::time_point::max)()
  12328. : parked.front()->deadline;
  12329. }
  12330. void expire(Clock::time_point now) {
  12331. while (!parked.empty() && parked.front()->deadline <= now) {
  12332. poller->disarm(parked.front()->sock);
  12333. parked.front()->close_idle();
  12334. parked.pop_front();
  12335. }
  12336. }
  12337. // Closes them here rather than wherever the last reference goes, which may
  12338. // be a worker that has just given one back, or the destructor, which cannot
  12339. // reach the transport.
  12340. void close_all() {
  12341. std::vector<Connection> left;
  12342. {
  12343. std::lock_guard<std::mutex> guard(mutex);
  12344. closed = true;
  12345. left.swap(returned);
  12346. }
  12347. for (auto &conn : parked) {
  12348. poller->disarm(conn->sock);
  12349. conn->close_idle();
  12350. }
  12351. for (auto &conn : left) {
  12352. conn->close_idle();
  12353. }
  12354. for (auto &conn : backlog) {
  12355. conn->close_idle();
  12356. }
  12357. parked.clear();
  12358. backlog.clear();
  12359. }
  12360. std::mutex mutex;
  12361. std::vector<Connection> returned;
  12362. bool closed = false;
  12363. std::list<Connection> parked;
  12364. std::list<Connection> backlog;
  12365. };
  12366. // HTTP server implementation
  12367. inline Server::Server()
  12368. : new_task_queue([] {
  12369. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  12370. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  12371. }) {
  12372. #ifndef _WIN32
  12373. signal(SIGPIPE, SIG_IGN);
  12374. #endif
  12375. }
  12376. inline Server::~Server() = default;
  12377. inline std::unique_ptr<detail::MatcherBase>
  12378. Server::make_matcher(const std::string &pattern) {
  12379. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  12380. // a path params pattern
  12381. if (pattern.find("/:") != std::string::npos) {
  12382. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  12383. }
  12384. // A pattern with no regex metacharacter only has to be compared literally,
  12385. // which is what PathParamsMatcher already does when it captures no
  12386. // parameter, so std::regex is only worth building for the patterns that
  12387. // actually need it
  12388. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  12389. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  12390. }
  12391. return detail::make_unique<detail::RegexMatcher>(pattern);
  12392. }
  12393. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  12394. return add_handler(get_handlers_, pattern, std::move(handler));
  12395. }
  12396. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  12397. return add_handler(post_handlers_, pattern, std::move(handler));
  12398. }
  12399. inline Server &Server::Post(const std::string &pattern,
  12400. HandlerWithContentReader handler) {
  12401. return add_handler(post_handlers_for_content_reader_, pattern,
  12402. std::move(handler));
  12403. }
  12404. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  12405. return add_handler(put_handlers_, pattern, std::move(handler));
  12406. }
  12407. inline Server &Server::Put(const std::string &pattern,
  12408. HandlerWithContentReader handler) {
  12409. return add_handler(put_handlers_for_content_reader_, pattern,
  12410. std::move(handler));
  12411. }
  12412. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  12413. return add_handler(patch_handlers_, pattern, std::move(handler));
  12414. }
  12415. inline Server &Server::Patch(const std::string &pattern,
  12416. HandlerWithContentReader handler) {
  12417. return add_handler(patch_handlers_for_content_reader_, pattern,
  12418. std::move(handler));
  12419. }
  12420. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  12421. return add_handler(delete_handlers_, pattern, std::move(handler));
  12422. }
  12423. inline Server &Server::Delete(const std::string &pattern,
  12424. HandlerWithContentReader handler) {
  12425. return add_handler(delete_handlers_for_content_reader_, pattern,
  12426. std::move(handler));
  12427. }
  12428. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  12429. return add_handler(options_handlers_, pattern, std::move(handler));
  12430. }
  12431. inline const std::set<std::string> &Server::builtin_methods() {
  12432. thread_local const std::set<std::string> methods{
  12433. "GET", "HEAD", "POST", "PUT", "DELETE",
  12434. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  12435. return methods;
  12436. }
  12437. inline Server::CustomHandlerEntry *
  12438. Server::custom_entry_for_registration(const std::string &method) {
  12439. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  12440. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  12441. // routing() before the custom tables are consulted, so a route registered
  12442. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  12443. // there and would be reachable, but they carry protocol-level meaning
  12444. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  12445. // library does not route.
  12446. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  12447. output_error_log(Error::InvalidHTTPMethod, nullptr);
  12448. has_invalid_registration_ = true;
  12449. return nullptr;
  12450. }
  12451. return &custom_handlers_[method];
  12452. }
  12453. inline Server &Server::CustomRoute(const std::string &method,
  12454. const std::string &pattern,
  12455. Handler handler) {
  12456. auto *entry = custom_entry_for_registration(method);
  12457. if (!entry) { return *this; }
  12458. return add_handler(entry->handlers, pattern, std::move(handler));
  12459. }
  12460. inline Server &Server::CustomRoute(const std::string &method,
  12461. const std::string &pattern,
  12462. HandlerWithContentReader handler) {
  12463. auto *entry = custom_entry_for_registration(method);
  12464. if (!entry) { return *this; }
  12465. return add_handler(entry->handlers_for_content_reader, pattern,
  12466. std::move(handler));
  12467. }
  12468. inline const Server::CustomHandlerEntry *
  12469. Server::find_custom_entry(const std::string &method) const {
  12470. // find() alone would be correct here. The empty() check is what keeps the
  12471. // per-request cost off servers that never call CustomRoute(), which is the
  12472. // overwhelmingly common case; keep it rather than walking into the tree.
  12473. if (custom_handlers_.empty()) { return nullptr; }
  12474. auto it = custom_handlers_.find(method);
  12475. return it == custom_handlers_.end() ? nullptr : &it->second;
  12476. }
  12477. inline Server &Server::WebSocket(const std::string &pattern,
  12478. WebSocketHandler handler) {
  12479. websocket_handlers_.push_back(
  12480. {make_matcher(pattern), std::move(handler), nullptr});
  12481. return *this;
  12482. }
  12483. inline Server &Server::WebSocket(const std::string &pattern,
  12484. WebSocketHandler handler,
  12485. SubProtocolSelector sub_protocol_selector) {
  12486. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  12487. std::move(sub_protocol_selector)});
  12488. return *this;
  12489. }
  12490. inline bool Server::set_base_dir(const std::string &dir,
  12491. const std::string &mount_point) {
  12492. return set_mount_point(mount_point, dir);
  12493. }
  12494. inline bool Server::set_mount_point(const std::string &mount_point,
  12495. const std::string &dir, Headers headers) {
  12496. detail::FileStat stat(dir);
  12497. if (stat.is_dir()) {
  12498. std::string mnt = !mount_point.empty() ? mount_point : "/";
  12499. if (!mnt.empty() && mnt[0] == '/') {
  12500. // Without the resolved directory, a file could not be checked to be
  12501. // inside it.
  12502. std::string resolved_base;
  12503. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  12504. return false;
  12505. }
  12506. #if defined(_WIN32)
  12507. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  12508. resolved_base += '\\';
  12509. }
  12510. #else
  12511. if (resolved_base.back() != '/') { resolved_base += '/'; }
  12512. #endif
  12513. base_dirs_.push_back(
  12514. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  12515. return true;
  12516. }
  12517. }
  12518. return false;
  12519. }
  12520. inline bool Server::remove_mount_point(const std::string &mount_point) {
  12521. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  12522. if (it->mount_point == mount_point) {
  12523. base_dirs_.erase(it);
  12524. return true;
  12525. }
  12526. }
  12527. return false;
  12528. }
  12529. inline Server &
  12530. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  12531. const std::string &mime) {
  12532. // Keyed as find_content_type() looks it up
  12533. auto key = detail::case_ignore::to_lower(ext);
  12534. if (!key.empty() && key[0] == '.') { key.erase(0, 1); }
  12535. file_extension_and_mimetype_map_[key] = mime;
  12536. return *this;
  12537. }
  12538. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  12539. default_file_mimetype_ = mime;
  12540. return *this;
  12541. }
  12542. inline Server &Server::set_file_request_handler(Handler handler) {
  12543. file_request_handler_ = std::move(handler);
  12544. return *this;
  12545. }
  12546. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  12547. std::true_type) {
  12548. error_handler_ = std::move(handler);
  12549. return *this;
  12550. }
  12551. inline Server &Server::set_error_handler_core(Handler handler,
  12552. std::false_type) {
  12553. error_handler_ = [handler](const Request &req, Response &res) {
  12554. handler(req, res);
  12555. return HandlerResponse::Handled;
  12556. };
  12557. return *this;
  12558. }
  12559. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  12560. exception_handler_ = std::move(handler);
  12561. return *this;
  12562. }
  12563. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  12564. pre_routing_handler_ = std::move(handler);
  12565. return *this;
  12566. }
  12567. inline Server &Server::set_post_routing_handler(Handler handler) {
  12568. post_routing_handler_ = std::move(handler);
  12569. return *this;
  12570. }
  12571. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  12572. pre_request_handler_ = std::move(handler);
  12573. return *this;
  12574. }
  12575. inline Server &Server::set_logger(Logger logger) {
  12576. logger_ = std::move(logger);
  12577. return *this;
  12578. }
  12579. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  12580. error_logger_ = std::move(error_logger);
  12581. return *this;
  12582. }
  12583. inline Server &Server::set_pre_compression_logger(Logger logger) {
  12584. pre_compression_logger_ = std::move(logger);
  12585. return *this;
  12586. }
  12587. inline Server &
  12588. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  12589. expect_100_continue_handler_ = std::move(handler);
  12590. return *this;
  12591. }
  12592. inline Server &Server::set_start_handler(StartHandler handler) {
  12593. start_handler_ = std::move(handler);
  12594. return *this;
  12595. }
  12596. inline Server &Server::set_address_family(int family) {
  12597. address_family_ = family;
  12598. return *this;
  12599. }
  12600. inline Server &Server::set_tcp_nodelay(bool on) {
  12601. tcp_nodelay_ = on;
  12602. return *this;
  12603. }
  12604. inline Server &Server::set_ipv6_v6only(bool on) {
  12605. ipv6_v6only_ = on;
  12606. return *this;
  12607. }
  12608. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  12609. socket_options_ = std::move(socket_options);
  12610. return *this;
  12611. }
  12612. inline Server &Server::set_default_headers(Headers headers) {
  12613. default_headers_ = std::move(headers);
  12614. return *this;
  12615. }
  12616. inline Server &Server::set_header_writer(
  12617. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  12618. header_writer_ = writer;
  12619. return *this;
  12620. }
  12621. inline Server &
  12622. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  12623. trusted_proxies_.clear();
  12624. trusted_proxies_.reserve(proxies.size());
  12625. for (const auto &proxy : proxies) {
  12626. trusted_proxies_.push_back(detail::canonical_ip(proxy));
  12627. }
  12628. return *this;
  12629. }
  12630. inline Server &Server::set_keep_alive_max_count(size_t count) {
  12631. keep_alive_max_count_ = count;
  12632. return *this;
  12633. }
  12634. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  12635. keep_alive_timeout_sec_ = sec;
  12636. return *this;
  12637. }
  12638. template <class Rep, class Period>
  12639. inline Server &Server::set_keep_alive_timeout(
  12640. const std::chrono::duration<Rep, Period> &duration) {
  12641. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  12642. set_keep_alive_timeout(sec);
  12643. });
  12644. return *this;
  12645. }
  12646. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  12647. read_timeout_sec_ = sec;
  12648. read_timeout_usec_ = usec;
  12649. return *this;
  12650. }
  12651. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  12652. write_timeout_sec_ = sec;
  12653. write_timeout_usec_ = usec;
  12654. return *this;
  12655. }
  12656. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  12657. idle_interval_sec_ = sec;
  12658. idle_interval_usec_ = usec;
  12659. idle_interval_set_ = true;
  12660. return *this;
  12661. }
  12662. inline Server &Server::set_keep_alive_parking(bool on) {
  12663. // Never destroyed once made: stop() may use it from another thread.
  12664. if (on && !parking_) {
  12665. auto poller = detail::make_poller();
  12666. if (poller) {
  12667. parking_.reset(new ParkingState());
  12668. parking_->poller = std::move(poller);
  12669. }
  12670. }
  12671. keep_alive_parking_ = on;
  12672. return *this;
  12673. }
  12674. inline Server &Server::set_payload_max_length(size_t length) {
  12675. payload_max_length_ = length;
  12676. return *this;
  12677. }
  12678. inline Server &Server::set_compress(bool on) {
  12679. compress_ = on;
  12680. return *this;
  12681. }
  12682. inline Server &Server::set_static_file_compression(bool on) {
  12683. static_file_compression_ = on;
  12684. return *this;
  12685. }
  12686. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  12687. static_file_compression_min_length_ = length;
  12688. return *this;
  12689. }
  12690. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  12691. static_file_compression_max_length_ = length;
  12692. return *this;
  12693. }
  12694. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  12695. websocket_max_missed_pongs_ = count;
  12696. return *this;
  12697. }
  12698. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  12699. websocket_ping_interval_sec_ = sec;
  12700. return *this;
  12701. }
  12702. template <class Rep, class Period>
  12703. inline Server &Server::set_websocket_ping_interval(
  12704. const std::chrono::duration<Rep, Period> &duration) {
  12705. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  12706. set_websocket_ping_interval(sec);
  12707. });
  12708. return *this;
  12709. }
  12710. inline bool Server::bind_to_port(const std::string &host, int port,
  12711. int socket_flags) {
  12712. auto ret = bind_internal(host, port, socket_flags);
  12713. if (ret == -1) { is_decommissioned = true; }
  12714. return ret >= 0;
  12715. }
  12716. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  12717. auto ret = bind_internal(host, 0, socket_flags);
  12718. if (ret == -1) { is_decommissioned = true; }
  12719. return ret;
  12720. }
  12721. inline bool Server::listen_after_bind() { return listen_internal(); }
  12722. inline bool Server::listen(const std::string &host, int port,
  12723. int socket_flags) {
  12724. return bind_to_port(host, port, socket_flags) && listen_internal();
  12725. }
  12726. inline bool Server::is_running() const { return is_running_; }
  12727. inline void Server::wait_until_ready() const {
  12728. while (!is_running_ && !is_decommissioned) {
  12729. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12730. }
  12731. }
  12732. inline void Server::stop() noexcept {
  12733. // Release the listening socket whether or not the accept loop is running:
  12734. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  12735. // exchange is what makes this safe to call concurrently with the accept loop.
  12736. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  12737. if (sock != INVALID_SOCKET && !(parking_ && parking_->release_listen(sock))) {
  12738. detail::shutdown_socket(sock);
  12739. detail::close_socket(sock);
  12740. }
  12741. is_decommissioned = false;
  12742. }
  12743. inline void Server::decommission() { is_decommissioned = true; }
  12744. inline bool Server::parse_request_line(const char *s, Request &req) const {
  12745. auto len = strlen(s);
  12746. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  12747. len -= 2;
  12748. {
  12749. // RFC 9112 §3: exactly one SP between the method, the target and the
  12750. // version. Taking other whitespace as a separator too lets recipients
  12751. // that parse more strictly see a different request.
  12752. auto end = s + len;
  12753. if (std::count(s, end, ' ') != 2) { return false; }
  12754. auto sp1 = std::find(s, end, ' ');
  12755. auto sp2 = std::find(sp1 + 1, end, ' ');
  12756. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  12757. req.method.assign(s, sp1);
  12758. req.target.assign(sp1 + 1, sp2);
  12759. req.version.assign(sp2 + 1, end);
  12760. }
  12761. // A method outside the built-in set is accepted only when a handler has been
  12762. // registered for it with CustomRoute().
  12763. const auto &methods = builtin_methods();
  12764. if (methods.find(req.method) == methods.end() &&
  12765. !find_custom_entry(req.method)) {
  12766. output_error_log(Error::InvalidHTTPMethod, &req);
  12767. return false;
  12768. }
  12769. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  12770. output_error_log(Error::InvalidHTTPVersion, &req);
  12771. return false;
  12772. }
  12773. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  12774. // would leave this server routing a different path than a cache or a
  12775. // filter in front of it sees.
  12776. if (!detail::fields::is_request_target(req.target) ||
  12777. req.target.find('#') != std::string::npos) {
  12778. return false;
  12779. }
  12780. {
  12781. detail::divide(req.target, '?',
  12782. [&](const char *lhs_data, std::size_t lhs_size,
  12783. const char *rhs_data, std::size_t rhs_size) {
  12784. req.path =
  12785. decode_path_component(std::string(lhs_data, lhs_size));
  12786. detail::parse_query_text(rhs_data, rhs_size, req.params);
  12787. });
  12788. }
  12789. return true;
  12790. }
  12791. inline bool Server::write_response(Stream &strm, bool close_connection,
  12792. Request &req, Response &res) {
  12793. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  12794. // incorrectly to the error content.
  12795. req.ranges.clear();
  12796. return write_response_core(strm, close_connection, req, res, false);
  12797. }
  12798. inline bool Server::write_response_with_content(Stream &strm,
  12799. bool close_connection,
  12800. const Request &req,
  12801. Response &res) {
  12802. return write_response_core(strm, close_connection, req, res, true);
  12803. }
  12804. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  12805. const Request &req, Response &res,
  12806. bool need_apply_ranges) {
  12807. assert(res.status != -1);
  12808. if (400 <= res.status && error_handler_ &&
  12809. error_handler_(req, res) == HandlerResponse::Handled) {
  12810. need_apply_ranges = true;
  12811. }
  12812. // Before anything below reads res.headers, which the handlers may have
  12813. // filled directly
  12814. detail::erase_invalid_fields(res.headers);
  12815. if (!detail::body_allowed_for_status(res.status)) {
  12816. detail::clear_content(res);
  12817. }
  12818. detail::prefer_assigned_body(res);
  12819. std::string content_type;
  12820. std::string boundary;
  12821. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  12822. // Prepare additional headers
  12823. if (close_connection ||
  12824. detail::has_header_token(req.headers, "Connection", "close") ||
  12825. 400 <= res.status || // Don't leave connections open after errors
  12826. // The client withholds the body until `100 Continue`, which was never
  12827. // sent, so whether and when the body follows is unknown.
  12828. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  12829. // The body was left partway, e.g. by a content receiver that returned
  12830. // false, so the rest of it cannot be told from the next request.
  12831. (req.body_read_started_ && !req.body_consumed_)) {
  12832. res.set_header("Connection", "close");
  12833. } else {
  12834. std::string s = "timeout=";
  12835. s += std::to_string(keep_alive_timeout_sec_);
  12836. if (keep_alive_max_count_ > 0) {
  12837. s += ", max=";
  12838. s += std::to_string(keep_alive_max_count_);
  12839. }
  12840. res.set_header("Keep-Alive", s);
  12841. }
  12842. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  12843. !res.has_header("Content-Type")) {
  12844. res.set_header("Content-Type", "text/plain");
  12845. }
  12846. detail::set_framing_headers(req, res, boundary, content_type);
  12847. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  12848. res.set_header("Accept-Ranges", "bytes");
  12849. }
  12850. if (post_routing_handler_) {
  12851. post_routing_handler_(req, res);
  12852. detail::erase_invalid_fields(res.headers);
  12853. // Again, for a body or framing headers the handler changed.
  12854. detail::set_framing_headers(req, res, boundary, content_type);
  12855. }
  12856. // Response line and headers
  12857. detail::BufferStream bstrm;
  12858. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  12859. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  12860. // Combine a small body with the headers so the whole response leaves in a
  12861. // single write. A large body is written on its own instead: a copy of it
  12862. // costs more than the extra write saves.
  12863. auto send_body =
  12864. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  12865. auto body_is_separate = false;
  12866. auto provider_done = false;
  12867. if (send_body && !res.body.empty() && !res.content_provider_) {
  12868. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  12869. bstrm.write(res.body.data(), res.body.size());
  12870. } else {
  12871. body_is_separate = true;
  12872. }
  12873. } else if (send_body && res.content_provider_ &&
  12874. res.is_file_content_provider_ &&
  12875. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  12876. // A small file is read into the same buffer. Other providers may produce
  12877. // their data over time, so they are never held back.
  12878. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  12879. return false;
  12880. }
  12881. provider_done = true;
  12882. }
  12883. // Log before writing to avoid race condition with client-side code that
  12884. // accesses logger-captured data immediately after receiving the response.
  12885. output_log(req, res);
  12886. // Flush buffer
  12887. auto &data = bstrm.get_buffer();
  12888. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  12889. if (body_is_separate) {
  12890. return detail::write_data(strm, res.body.data(), res.body.size());
  12891. }
  12892. // Streaming body
  12893. if (send_body && res.content_provider_) {
  12894. if (!provider_done &&
  12895. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  12896. return false;
  12897. }
  12898. res.content_provider_success_ = true;
  12899. }
  12900. return true;
  12901. }
  12902. inline bool
  12903. Server::write_content_with_provider(Stream &strm, const Request &req,
  12904. Response &res, const std::string &boundary,
  12905. const std::string &content_type) {
  12906. auto is_shutting_down = [this]() { return is_stopping(); };
  12907. if (res.content_length_ > 0) {
  12908. if (!detail::is_partial_content(req, res)) {
  12909. return detail::write_content(strm, res.content_provider_, 0,
  12910. res.content_length_, is_shutting_down);
  12911. } else if (req.ranges.size() == 1) {
  12912. auto offset_and_length = detail::get_range_offset_and_length(
  12913. req.ranges[0], res.content_length_);
  12914. return detail::write_content(strm, res.content_provider_,
  12915. offset_and_length.first,
  12916. offset_and_length.second, is_shutting_down);
  12917. } else {
  12918. return detail::write_multipart_ranges_data(
  12919. strm, req, res, boundary, content_type, res.content_length_,
  12920. is_shutting_down);
  12921. }
  12922. } else {
  12923. if (res.is_chunked_content_provider_) {
  12924. // Use the coding `apply_ranges()` chose when it wrote the headers;
  12925. // re-negotiating here would disagree with them, e.g. once a handler's
  12926. // own Content-Encoding header suppresses the negotiation.
  12927. auto compressor = detail::make_compressor(res.content_coding_);
  12928. if (!compressor) {
  12929. compressor = detail::make_unique<detail::nocompressor>();
  12930. }
  12931. return detail::write_content_chunked(strm, res.content_provider_,
  12932. is_shutting_down, *compressor);
  12933. } else {
  12934. return detail::write_content_without_length(strm, res.content_provider_,
  12935. is_shutting_down);
  12936. }
  12937. }
  12938. }
  12939. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  12940. FormFields::iterator cur_field;
  12941. FormFiles::iterator cur_file;
  12942. auto is_text_field = false;
  12943. size_t count = 0;
  12944. if (read_content_core(
  12945. strm, req, res,
  12946. // Regular
  12947. [&](const char *buf, size_t n) {
  12948. // Prevent arithmetic overflow when checking sizes.
  12949. // Avoid computing (req.body.size() + n) directly because
  12950. // adding two unsigned `size_t` values can wrap around and
  12951. // produce a small result instead of indicating overflow.
  12952. // Instead, check using subtraction: ensure `n` does not
  12953. // exceed the remaining capacity `max_size() - size()`.
  12954. if (req.body.size() >= req.body.max_size() ||
  12955. n > req.body.max_size() - req.body.size()) {
  12956. return false;
  12957. }
  12958. // Limit decompressed body size to payload_max_length_ to protect
  12959. // against "zip bomb" attacks where a small compressed payload
  12960. // decompresses to a massive size.
  12961. if (payload_max_length_ > 0 &&
  12962. (req.body.size() >= payload_max_length_ ||
  12963. n > payload_max_length_ - req.body.size())) {
  12964. return false;
  12965. }
  12966. req.body.append(buf, n);
  12967. return true;
  12968. },
  12969. // Multipart FormData
  12970. [&](const FormData &file) {
  12971. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12972. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12973. output_error_log(Error::TooManyFormDataFiles, &req);
  12974. return false;
  12975. }
  12976. if (file.filename.empty()) {
  12977. cur_field = req.form.fields.emplace(
  12978. file.name, FormField{file.name, file.content, file.headers});
  12979. is_text_field = true;
  12980. } else {
  12981. cur_file = req.form.files.emplace(file.name, file);
  12982. is_text_field = false;
  12983. }
  12984. return true;
  12985. },
  12986. [&](const char *buf, size_t n) {
  12987. if (is_text_field) {
  12988. auto &content = cur_field->second.content;
  12989. if (content.size() + n > content.max_size()) { return false; }
  12990. content.append(buf, n);
  12991. } else {
  12992. auto &content = cur_file->second.content;
  12993. if (content.size() + n > content.max_size()) { return false; }
  12994. content.append(buf, n);
  12995. }
  12996. return true;
  12997. })) {
  12998. const auto &content_type = req.get_header_value("Content-Type");
  12999. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  13000. "application/x-www-form-urlencoded")) {
  13001. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  13002. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  13003. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  13004. output_error_log(Error::ExceedMaxPayloadSize, &req);
  13005. return false;
  13006. }
  13007. detail::parse_query_text(req.body, req.params);
  13008. }
  13009. return true;
  13010. }
  13011. return false;
  13012. }
  13013. inline bool Server::read_content_with_content_receiver(
  13014. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  13015. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  13016. return read_content_core(strm, req, res, std::move(receiver),
  13017. std::move(multipart_header),
  13018. std::move(multipart_receiver));
  13019. }
  13020. inline bool Server::read_content_core(
  13021. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  13022. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  13023. detail::FormDataParser multipart_form_data_parser;
  13024. ContentReceiverWithProgress out;
  13025. if (req.is_multipart_form_data()) {
  13026. const auto &content_type = req.get_header_value("Content-Type");
  13027. std::string boundary;
  13028. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  13029. res.status = StatusCode::BadRequest_400;
  13030. output_error_log(Error::MultipartParsing, &req);
  13031. return false;
  13032. }
  13033. multipart_form_data_parser.set_boundary(std::move(boundary));
  13034. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  13035. return multipart_form_data_parser.parse(buf, n, multipart_header,
  13036. multipart_receiver);
  13037. };
  13038. } else {
  13039. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  13040. size_t /*len*/) { return receiver(buf, n); };
  13041. }
  13042. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  13043. if (!req.has_header("Content-Length") &&
  13044. !detail::is_chunked_transfer_encoding(req.headers)) {
  13045. return true;
  13046. }
  13047. // A second read would start where the first one stopped, or in the next
  13048. // request.
  13049. if (req.body_read_started_) { return false; }
  13050. // The client is waiting for this before it sends the body.
  13051. if (req.expect_100_continue_pending_) {
  13052. req.expect_100_continue_pending_ = false;
  13053. detail::write_response_line(strm, StatusCode::Continue_100);
  13054. strm.write("\r\n");
  13055. }
  13056. // Set before reading, since a receiver may also stop by throwing.
  13057. req.body_read_started_ = true;
  13058. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  13059. out, true)) {
  13060. return false;
  13061. }
  13062. req.body_consumed_ = true;
  13063. if (req.is_multipart_form_data()) {
  13064. if (!multipart_form_data_parser.is_valid()) {
  13065. res.status = StatusCode::BadRequest_400;
  13066. output_error_log(Error::MultipartParsing, &req);
  13067. return false;
  13068. }
  13069. }
  13070. return true;
  13071. }
  13072. inline bool Server::handle_file_request(Request &req, Response &res) {
  13073. if (!detail::is_valid_path(req.path)) { return false; }
  13074. for (const auto &entry : base_dirs_) {
  13075. // Prefix match, on a path segment boundary. A mount point of "/mount"
  13076. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  13077. // One that already ends in '/' (the root mount among them) carries its own
  13078. // boundary; set_mount_point() guarantees the mount point is not empty.
  13079. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  13080. (entry.mount_point.back() == '/' ||
  13081. req.path.size() == entry.mount_point.size() ||
  13082. req.path[entry.mount_point.size()] == '/')) {
  13083. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  13084. auto path = entry.base_dir + sub_path;
  13085. if (path.back() == '/') { path += "index.html"; }
  13086. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  13087. // but symlinks/junctions can still escape the base directory. A path
  13088. // that cannot be resolved, which includes one that does not exist, is
  13089. // not served from here.
  13090. std::string resolved_path;
  13091. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  13092. if (!detail::is_path_within_base(resolved_path,
  13093. entry.resolved_base_dir)) {
  13094. res.status = StatusCode::Forbidden_403;
  13095. return true;
  13096. }
  13097. detail::FileStat stat(path);
  13098. if (stat.is_dir()) {
  13099. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  13100. // in the name from reading as a scheme.
  13101. auto name = req.path.substr(req.path.rfind('/') + 1);
  13102. res.set_redirect("./" + encode_path_component(name) + "/",
  13103. StatusCode::MovedPermanently_301);
  13104. return true;
  13105. }
  13106. if (stat.is_file()) {
  13107. for (const auto &kv : entry.headers) {
  13108. res.set_header(kv.first, kv.second);
  13109. }
  13110. auto content_type = detail::find_content_type(
  13111. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13112. auto encoding = detail::EncodingType::None;
  13113. if (static_file_compression_) {
  13114. encoding = static_file_encoding(req, res, content_type, stat.size());
  13115. }
  13116. // The ETag names the representation actually sent, so a client that
  13117. // cached the compressed form revalidates against the compressed ETag
  13118. // and still gets a 304, while one that took identity keeps the plain
  13119. // ETag.
  13120. auto etag = detail::compute_etag(
  13121. stat, encoding == detail::EncodingType::None
  13122. ? std::string()
  13123. : std::string("-") + detail::encoding_name(encoding));
  13124. if (!etag.empty()) { res.set_header("ETag", etag); }
  13125. auto mtime = stat.mtime();
  13126. auto last_modified = detail::file_mtime_to_http_date(mtime);
  13127. if (!last_modified.empty()) {
  13128. res.set_header("Last-Modified", last_modified);
  13129. }
  13130. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  13131. check_if_range(req, etag, mtime);
  13132. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13133. if (!mm->is_open()) {
  13134. output_error_log(Error::OpenFile, &req);
  13135. return false;
  13136. }
  13137. detail::set_file_content_provider(res, mm, content_type, encoding);
  13138. if (req.method != "HEAD" && file_request_handler_) {
  13139. file_request_handler_(req, res);
  13140. }
  13141. return true;
  13142. } else {
  13143. output_error_log(Error::OpenFile, &req);
  13144. }
  13145. }
  13146. }
  13147. return false;
  13148. }
  13149. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  13150. const std::string &etag,
  13151. time_t mtime) const {
  13152. // Handle conditional GET:
  13153. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  13154. // 2. If-Modified-Since is checked only when If-None-Match is absent
  13155. if (req.has_header("If-None-Match")) {
  13156. if (!etag.empty()) {
  13157. auto val =
  13158. detail::get_combined_header_value(req.headers, "If-None-Match");
  13159. // NOTE: We use exact string matching here. This works correctly
  13160. // because our server always generates weak ETags (W/"..."), and
  13161. // clients typically send back the same ETag they received.
  13162. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  13163. // If-None-Match, where W/"x" and "x" would match, but this
  13164. // simplified implementation requires exact matches.
  13165. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  13166. [&](const char *b, const char *e) {
  13167. auto seg_len = static_cast<size_t>(e - b);
  13168. return (seg_len == 1 && *b == '*') ||
  13169. (seg_len == etag.size() &&
  13170. std::equal(b, e, etag.begin()));
  13171. });
  13172. if (ret) {
  13173. res.status = StatusCode::NotModified_304;
  13174. return true;
  13175. }
  13176. }
  13177. } else if (req.has_header("If-Modified-Since")) {
  13178. auto val = req.get_header_value("If-Modified-Since");
  13179. auto t = detail::parse_http_date(val);
  13180. if (t != static_cast<time_t>(-1) && mtime <= t) {
  13181. res.status = StatusCode::NotModified_304;
  13182. return true;
  13183. }
  13184. }
  13185. return false;
  13186. }
  13187. inline bool Server::check_if_range(Request &req, const std::string &etag,
  13188. time_t mtime) const {
  13189. // Handle If-Range for partial content requests (RFC 9110
  13190. // Section 13.1.5). If-Range is only evaluated when Range header is
  13191. // present. If the validator matches, serve partial content; otherwise
  13192. // serve full content.
  13193. if (!req.ranges.empty() && req.has_header("If-Range")) {
  13194. auto val = req.get_header_value("If-Range");
  13195. auto is_valid_range = [&]() {
  13196. if (detail::is_strong_etag(val)) {
  13197. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  13198. // comparison.
  13199. return (!etag.empty() && val == etag);
  13200. } else if (detail::is_weak_etag(val)) {
  13201. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  13202. return false;
  13203. } else {
  13204. // HTTP-date comparison
  13205. auto t = detail::parse_http_date(val);
  13206. return (t != static_cast<time_t>(-1) && mtime <= t);
  13207. }
  13208. };
  13209. if (!is_valid_range()) {
  13210. // Validator doesn't match: ignore Range and serve full content
  13211. req.ranges.clear();
  13212. return false;
  13213. }
  13214. }
  13215. return true;
  13216. }
  13217. inline socket_t
  13218. Server::create_server_socket(const std::string &host, int port,
  13219. int socket_flags,
  13220. SocketOptions socket_options) const {
  13221. return detail::create_socket(
  13222. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  13223. ipv6_v6only_, std::move(socket_options),
  13224. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  13225. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  13226. output_error_log(Error::BindIPAddress, nullptr);
  13227. return false;
  13228. }
  13229. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  13230. output_error_log(Error::Listen, nullptr);
  13231. return false;
  13232. }
  13233. return true;
  13234. });
  13235. }
  13236. inline int Server::bind_internal(const std::string &host, int port,
  13237. int socket_flags) {
  13238. if (is_decommissioned) { return -1; }
  13239. if (!is_valid()) { return -1; }
  13240. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  13241. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  13242. if (port == 0) {
  13243. struct sockaddr_storage addr;
  13244. socklen_t addr_len = sizeof(addr);
  13245. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  13246. &addr_len) == -1) {
  13247. output_error_log(Error::GetSockName, nullptr);
  13248. return -1;
  13249. }
  13250. if (addr.ss_family == AF_INET) {
  13251. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  13252. } else if (addr.ss_family == AF_INET6) {
  13253. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  13254. } else {
  13255. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  13256. return -1;
  13257. }
  13258. } else {
  13259. return port;
  13260. }
  13261. }
  13262. inline bool Server::listen_internal() {
  13263. // A stop() between bind and listen leaves nothing to accept on. Report
  13264. // failure instead of returning success without ever serving, and mark the
  13265. // server decommissioned the way any failed listen does so that a concurrent
  13266. // wait_until_ready() wakes up instead of spinning forever.
  13267. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  13268. is_decommissioned = true;
  13269. return false;
  13270. }
  13271. auto ret = true;
  13272. is_running_ = true;
  13273. auto se = detail::scope_exit([&]() { is_running_ = false; });
  13274. if (start_handler_) { start_handler_(); }
  13275. {
  13276. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  13277. ret = keep_alive_parking_ && parking_ ? parking_loop(*task_queue)
  13278. : accept_loop(*task_queue);
  13279. task_queue->shutdown();
  13280. }
  13281. is_decommissioned = !ret;
  13282. return ret;
  13283. }
  13284. inline void Server::prepare_accepted_socket(socket_t sock) const {
  13285. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec_,
  13286. read_timeout_usec_);
  13287. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec_,
  13288. write_timeout_usec_);
  13289. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  13290. }
  13291. // Serves each connection on one worker thread for its whole life.
  13292. inline bool Server::accept_loop(TaskQueue &task_queue) {
  13293. auto ret = true;
  13294. while (svr_sock_ != INVALID_SOCKET) {
  13295. #ifndef _WIN32
  13296. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  13297. #endif
  13298. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  13299. idle_interval_usec_);
  13300. if (val == 0) { // Timeout
  13301. task_queue.on_idle();
  13302. continue;
  13303. }
  13304. #ifndef _WIN32
  13305. }
  13306. #endif
  13307. auto sock = detail::accept_socket(svr_sock_);
  13308. if (sock == INVALID_SOCKET) {
  13309. // NOTE: Winsock reports failures through WSAGetLastError() and never
  13310. // touches the CRT errno, so the two have to be asked platform by
  13311. // platform rather than by testing errno here.
  13312. if (detail::is_accept_resource_error()) {
  13313. // The per-process descriptor limit or the network stack's buffer
  13314. // space has been reached. Try to accept new connections after a
  13315. // short sleep.
  13316. std::this_thread::sleep_for(std::chrono::microseconds{1});
  13317. continue;
  13318. } else if (detail::is_accept_transient_error()) {
  13319. continue;
  13320. }
  13321. if (abandon_listen_socket()) { ret = false; }
  13322. break;
  13323. }
  13324. prepare_accepted_socket(sock);
  13325. if (!task_queue.enqueue(
  13326. [this, sock]() { process_and_close_socket(sock); })) {
  13327. output_error_log(Error::ResourceExhaustion, nullptr);
  13328. detail::shutdown_socket(sock);
  13329. detail::close_socket(sock);
  13330. }
  13331. }
  13332. return ret;
  13333. }
  13334. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  13335. // Call from a catch block. The response is a 500 unless the exception handler
  13336. // sets another status. Returns whether the exception handler ran.
  13337. inline bool Server::handle_exception(Request &req, Response &res) {
  13338. res.status = StatusCode::InternalServerError_500;
  13339. if (!exception_handler_) { return false; }
  13340. exception_handler_(req, res, std::current_exception());
  13341. return true;
  13342. }
  13343. #endif
  13344. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  13345. bool skip_pre_routing) {
  13346. if (!skip_pre_routing && pre_routing_handler_ &&
  13347. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  13348. return true;
  13349. }
  13350. // File handler
  13351. if ((req.method == "GET" || req.method == "HEAD") &&
  13352. handle_file_request(req, res)) {
  13353. return true;
  13354. }
  13355. const auto *custom = find_custom_entry(req.method);
  13356. // The second clause mirrors what expect_content() does unconditionally for
  13357. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  13358. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  13359. // `allprop`) would skip its handler and fall through to 404.
  13360. if (detail::expect_content(req) ||
  13361. (custom && !custom->handlers_for_content_reader.empty())) {
  13362. // Content reader handler
  13363. {
  13364. // Track whether the ContentReader was aborted due to the decompressed
  13365. // payload exceeding `payload_max_length_`.
  13366. // The user handler runs after the lambda returns, so we must restore the
  13367. // 413 status if the handler overwrites it.
  13368. bool content_reader_payload_too_large = false;
  13369. ContentReader reader(
  13370. [&](ContentReceiver receiver) {
  13371. auto result = read_content_with_content_receiver(
  13372. strm, req, res, std::move(receiver), nullptr, nullptr);
  13373. if (!result) {
  13374. output_error_log(Error::Read, &req);
  13375. if (res.status == StatusCode::PayloadTooLarge_413) {
  13376. content_reader_payload_too_large = true;
  13377. }
  13378. }
  13379. return result;
  13380. },
  13381. [&](FormDataHeader header, ContentReceiver receiver) {
  13382. auto result = read_content_with_content_receiver(
  13383. strm, req, res, nullptr, std::move(header),
  13384. std::move(receiver));
  13385. if (!result) {
  13386. output_error_log(Error::Read, &req);
  13387. if (res.status == StatusCode::PayloadTooLarge_413) {
  13388. content_reader_payload_too_large = true;
  13389. }
  13390. }
  13391. return result;
  13392. });
  13393. bool dispatched = false;
  13394. if (req.method == "POST") {
  13395. dispatched = dispatch_request_for_content_reader(
  13396. req, res, std::move(reader), post_handlers_for_content_reader_);
  13397. } else if (req.method == "PUT") {
  13398. dispatched = dispatch_request_for_content_reader(
  13399. req, res, std::move(reader), put_handlers_for_content_reader_);
  13400. } else if (req.method == "PATCH") {
  13401. dispatched = dispatch_request_for_content_reader(
  13402. req, res, std::move(reader), patch_handlers_for_content_reader_);
  13403. } else if (req.method == "DELETE") {
  13404. dispatched = dispatch_request_for_content_reader(
  13405. req, res, std::move(reader), delete_handlers_for_content_reader_);
  13406. } else if (custom) {
  13407. dispatched = dispatch_request_for_content_reader(
  13408. req, res, std::move(reader), custom->handlers_for_content_reader);
  13409. }
  13410. if (dispatched) {
  13411. if (content_reader_payload_too_large) {
  13412. // Enforce the limit: override any status the handler may have set
  13413. // and return false so the error path sends a plain 413 response.
  13414. res.status = StatusCode::PayloadTooLarge_413;
  13415. detail::clear_content(res);
  13416. return false;
  13417. }
  13418. return true;
  13419. }
  13420. }
  13421. // NOTE: `req.body` is not read here. For a regular handler the body is
  13422. // read inside dispatch_request(), after the route has matched and the
  13423. // pre-request handler has approved the request, so that a rejected
  13424. // request (e.g. failed authentication) never forces us to buffer a
  13425. // potentially large body.
  13426. }
  13427. // Regular handler
  13428. if (req.method == "GET" || req.method == "HEAD") {
  13429. return dispatch_request(req, res, get_handlers_, strm);
  13430. } else if (req.method == "POST") {
  13431. return dispatch_request(req, res, post_handlers_, strm);
  13432. } else if (req.method == "PUT") {
  13433. return dispatch_request(req, res, put_handlers_, strm);
  13434. } else if (req.method == "DELETE") {
  13435. return dispatch_request(req, res, delete_handlers_, strm);
  13436. } else if (req.method == "OPTIONS") {
  13437. return dispatch_request(req, res, options_handlers_, strm);
  13438. } else if (req.method == "PATCH") {
  13439. return dispatch_request(req, res, patch_handlers_, strm);
  13440. } else if (custom) {
  13441. return dispatch_request(req, res, custom->handlers, strm);
  13442. }
  13443. res.status = StatusCode::BadRequest_400;
  13444. return false;
  13445. }
  13446. inline bool Server::dispatch_request(Request &req, Response &res,
  13447. const Handlers &handlers, Stream &strm) {
  13448. for (const auto &x : handlers) {
  13449. const auto &matcher = x.first;
  13450. const auto &handler = x.second;
  13451. if (matcher->match(req)) {
  13452. req.matched_route = matcher->pattern();
  13453. // Run the pre-request handler before reading the body so a rejected
  13454. // request (e.g. failed authentication) never forces us to buffer a
  13455. // potentially large body. `req.matched_route` is available here.
  13456. if (pre_request_handler_ &&
  13457. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  13458. return true;
  13459. }
  13460. // The route matched and the request was approved; read the body now.
  13461. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  13462. output_error_log(Error::Read, &req);
  13463. return false;
  13464. }
  13465. handler(req, res);
  13466. return true;
  13467. }
  13468. }
  13469. return false;
  13470. }
  13471. // Decides the content coding for a response served straight from a file. Both
  13472. // the ETag, which has to name the representation actually sent, and
  13473. // `apply_static_file_compression()` go through this, so the two cannot drift
  13474. // apart.
  13475. inline detail::EncodingType
  13476. Server::static_file_encoding(const Request &req, const Response &res,
  13477. const std::string &content_type,
  13478. size_t length) const {
  13479. if (!static_file_compression_) { return detail::EncodingType::None; }
  13480. // Nothing to compress, and an empty file already answers with
  13481. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  13482. // turn an empty body into a 20-byte gzip stream.
  13483. if (length == 0) { return detail::EncodingType::None; }
  13484. // A file that already fits in a single packet gains nothing from being made
  13485. // smaller, since it still travels in that one segment, and a file of a few
  13486. // bytes comes out larger than it went in.
  13487. if (length < static_file_compression_min_length_) {
  13488. return detail::EncodingType::None;
  13489. }
  13490. // RFC 9110 applies Range to the representation after content coding, so a
  13491. // compressed 206 would mean compressing the whole file and then slicing it.
  13492. // Serve ranges from the identity representation instead.
  13493. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  13494. if (static_file_compression_max_length_ > 0 &&
  13495. length > static_file_compression_max_length_) {
  13496. return detail::EncodingType::None;
  13497. }
  13498. return detail::encoding_type(req, res, content_type);
  13499. }
  13500. // Compresses a file-backed content provider into `res.body`. Returns false when
  13501. // the response is left untouched.
  13502. inline bool Server::apply_static_file_compression(const Request &req,
  13503. Response &res) const {
  13504. auto type = res.content_coding_;
  13505. if (type == detail::EncodingType::None || !res.content_provider_) {
  13506. return false;
  13507. }
  13508. auto compressor = detail::make_compressor(type);
  13509. if (!compressor) { return false; }
  13510. output_pre_compression_log(req, res);
  13511. std::string compressed;
  13512. if (!detail::compress_content_provider(res.content_provider_,
  13513. res.content_length_, *compressor,
  13514. compressed)) {
  13515. return false;
  13516. }
  13517. res.body.swap(compressed);
  13518. // The provider was consumed in full, so its releaser hears about a success.
  13519. res.content_provider_success_ = true;
  13520. detail::clear_content_provider(res);
  13521. res.set_header("Content-Encoding", detail::encoding_name(type));
  13522. res.set_header("Vary", "Accept-Encoding");
  13523. return true;
  13524. }
  13525. inline void Server::apply_ranges(const Request &req, Response &res,
  13526. std::string &content_type,
  13527. std::string &boundary) const {
  13528. // A known-length content provider leaves `res.body` empty, so the compressor
  13529. // at the end of this function never runs for one (issue #2545). A file-backed
  13530. // provider is fully readable right here, so compress it and answer with an
  13531. // ordinary body: `Content-Length` and HEAD keep working, and the response
  13532. // takes the same path as `set_content()` from here on. Range requests never
  13533. // get a content coding, so `Content-Range` still names identity bytes and
  13534. // none of the range handling below applies.
  13535. if (apply_static_file_compression(req, res)) { return; }
  13536. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  13537. auto it = res.headers.find("Content-Type");
  13538. if (it != res.headers.end()) {
  13539. content_type = it->second;
  13540. res.headers.erase(it);
  13541. }
  13542. boundary = detail::make_multipart_data_boundary();
  13543. res.set_header("Content-Type",
  13544. "multipart/byteranges; boundary=" + boundary);
  13545. }
  13546. auto type =
  13547. compress_ ? detail::encoding_type(req, res) : detail::EncodingType::None;
  13548. if (res.body.empty()) {
  13549. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  13550. res.status == StatusCode::PartialContent_206) {
  13551. auto offset_and_length = detail::get_range_offset_and_length(
  13552. req.ranges[0], res.content_length_);
  13553. auto content_range = detail::make_content_range_header_field(
  13554. offset_and_length, res.content_length_);
  13555. res.set_header("Content-Range", content_range);
  13556. } else if (res.is_chunked_content_provider_) {
  13557. res.content_coding_ = type;
  13558. if (type != detail::EncodingType::None) {
  13559. res.set_header("Content-Encoding", detail::encoding_name(type));
  13560. res.set_header("Vary", "Accept-Encoding");
  13561. }
  13562. }
  13563. } else {
  13564. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  13565. ;
  13566. } else if (req.ranges.size() == 1) {
  13567. auto offset_and_length =
  13568. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  13569. auto offset = offset_and_length.first;
  13570. auto length = offset_and_length.second;
  13571. auto content_range = detail::make_content_range_header_field(
  13572. offset_and_length, res.body.size());
  13573. res.set_header("Content-Range", content_range);
  13574. assert(offset + length <= res.body.size());
  13575. res.body = res.body.substr(offset, length);
  13576. } else {
  13577. std::string data;
  13578. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  13579. res.body.size(), data);
  13580. res.body.swap(data);
  13581. }
  13582. if (type != detail::EncodingType::None) {
  13583. output_pre_compression_log(req, res);
  13584. if (auto compressor = detail::make_compressor(type)) {
  13585. std::string compressed;
  13586. if (compressor->compress(res.body.data(), res.body.size(), true,
  13587. [&](const char *data, size_t data_len) {
  13588. compressed.append(data, data_len);
  13589. return true;
  13590. })) {
  13591. res.body.swap(compressed);
  13592. res.set_header("Content-Encoding", detail::encoding_name(type));
  13593. res.set_header("Vary", "Accept-Encoding");
  13594. }
  13595. }
  13596. }
  13597. res.content_length_ = res.body.size();
  13598. }
  13599. }
  13600. inline bool Server::dispatch_request_for_content_reader(
  13601. Request &req, Response &res, ContentReader content_reader,
  13602. const HandlersForContentReader &handlers) const {
  13603. for (const auto &x : handlers) {
  13604. const auto &matcher = x.first;
  13605. const auto &handler = x.second;
  13606. if (matcher->match(req)) {
  13607. req.matched_route = matcher->pattern();
  13608. if (!pre_request_handler_ ||
  13609. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  13610. handler(req, res, content_reader);
  13611. }
  13612. return true;
  13613. }
  13614. }
  13615. return false;
  13616. }
  13617. inline std::string
  13618. get_client_ip(const std::string &x_forwarded_for,
  13619. const std::vector<std::string> &trusted_proxies) {
  13620. // X-Forwarded-For is a comma-separated list per RFC 7239
  13621. std::vector<std::string> ip_list;
  13622. detail::split(x_forwarded_for.data(),
  13623. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  13624. [&](const char *b, const char *e) {
  13625. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  13626. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  13627. });
  13628. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  13629. // no segments. Signal "no client IP derived" with an empty string so the
  13630. // caller can fall back to the connection-level remote address.
  13631. if (ip_list.empty()) { return std::string(); }
  13632. // Each hop appends the address it received the request from, so the rightmost
  13633. // entries are the ones written by our own infrastructure while the leftmost
  13634. // are whatever the original client chose to send. Walk from the right and
  13635. // skip trusted proxies; the first address that is not a trusted proxy is the
  13636. // furthest point still attributable to a real hop, i.e. the client. Scanning
  13637. // from the left instead lets a client forge an arbitrary address by following
  13638. // it with a trusted proxy's address, which the left-to-right scan then
  13639. // returned as the client.
  13640. for (size_t i = ip_list.size(); i-- > 0;) {
  13641. const auto &ip = ip_list[i];
  13642. if (!detail::is_trusted_proxy(ip, trusted_proxies)) { return ip; }
  13643. }
  13644. // Every hop was a trusted proxy; fall back to the first entry.
  13645. return ip_list.front();
  13646. }
  13647. inline bool
  13648. Server::process_request(Stream &strm, const std::string &remote_addr,
  13649. int remote_port, const std::string &local_addr,
  13650. int local_port, bool close_connection,
  13651. bool &connection_closed,
  13652. const std::function<void(Request &)> &setup_request,
  13653. bool *websocket_upgraded) {
  13654. std::array<char, 2048> buf{};
  13655. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13656. // The read timeout bounds the request line and headers as a whole, so a
  13657. // client sending them a byte at a time cannot hold the worker any longer.
  13658. auto read_timeout_msec = read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000;
  13659. strm.set_max_timeout(read_timeout_msec);
  13660. // Connection has been closed on client
  13661. if (!line_reader.getline()) { return false; }
  13662. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  13663. // clients send an extra CRLF after a request body, which would otherwise be
  13664. // parsed as the next request on a persistent connection.
  13665. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  13666. return false;
  13667. }
  13668. Request req;
  13669. req.start_time_ = std::chrono::steady_clock::now();
  13670. req.remote_addr = remote_addr;
  13671. req.remote_port = remote_port;
  13672. req.local_addr = local_addr;
  13673. req.local_port = local_port;
  13674. Response res;
  13675. res.version = "HTTP/1.1";
  13676. res.headers = default_headers_;
  13677. // RFC 9112 §9.6: a server that sends the "close" connection option must
  13678. // close the connection after that response, whichever path wrote it (an
  13679. // error status, a handler, or a rejected request). Reading on would also
  13680. // parse whatever the client sent next on a connection it considers done.
  13681. auto honor_connection_close = detail::scope_exit([&] {
  13682. if (detail::has_header_token(res.headers, "Connection", "close")) {
  13683. connection_closed = true;
  13684. }
  13685. });
  13686. // Request line and headers. A rejected message leaves the rest of it (and
  13687. // any body) unread, so the connection cannot be reused: the leftover bytes
  13688. // would be parsed as the next request.
  13689. if (!parse_request_line(line_reader.ptr(), req)) {
  13690. connection_closed = true;
  13691. res.status = StatusCode::BadRequest_400;
  13692. output_error_log(Error::InvalidRequestLine, &req);
  13693. return write_response(strm, close_connection, req, res);
  13694. }
  13695. // Request headers
  13696. if (!detail::read_headers(strm, req.headers)) {
  13697. connection_closed = true;
  13698. res.status = StatusCode::BadRequest_400;
  13699. output_error_log(Error::InvalidHeaders, &req);
  13700. return write_response(strm, close_connection, req, res);
  13701. }
  13702. strm.set_max_timeout(0);
  13703. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  13704. // which would otherwise let an intermediary and this parser disagree on
  13705. // where the body ends and enable request smuggling. Three cases: a
  13706. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  13707. // or empty), which would otherwise be read as "no body"; a non-zero
  13708. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  13709. // tolerated for compatibility with existing clients); and a
  13710. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  13711. // length undeterminable. None of them may fall through to the "no body"
  13712. // path, or the body bytes are parsed as the next request on a persistent
  13713. // connection.
  13714. auto is_invalid_content_length = false;
  13715. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  13716. is_invalid_content_length);
  13717. if (is_invalid_content_length ||
  13718. detail::has_conflicting_content_length(req.headers) ||
  13719. (req.has_header("Transfer-Encoding") &&
  13720. !detail::is_chunked_transfer_encoding(req.headers))) {
  13721. connection_closed = true;
  13722. res.status = StatusCode::BadRequest_400;
  13723. return write_response(strm, close_connection, req, res);
  13724. }
  13725. // RFC 9112 6.1: a lone "chunked" is the only transfer coding implemented
  13726. if (req.has_header("Transfer-Encoding") &&
  13727. (req.get_header_value_count("Transfer-Encoding") != 1 ||
  13728. !detail::case_ignore::equal(req.get_header_value("Transfer-Encoding"),
  13729. "chunked"))) {
  13730. connection_closed = true;
  13731. res.status = StatusCode::NotImplemented_501;
  13732. return write_response(strm, close_connection, req, res);
  13733. }
  13734. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  13735. // HTTP/1.0 request, is honoured, but the connection closes after the
  13736. // response.
  13737. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  13738. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  13739. // value, or none in HTTP/1.1, so that every recipient of the request sees
  13740. // the same authority.
  13741. auto host_count = req.get_header_value_count("Host");
  13742. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  13743. !detail::fields::is_host(req.get_header_value("Host"))) {
  13744. connection_closed = true;
  13745. res.status = StatusCode::BadRequest_400;
  13746. output_error_log(Error::InvalidHeaders, &req);
  13747. return write_response(strm, close_connection, req, res);
  13748. }
  13749. // Check if the request URI doesn't exceed the limit
  13750. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13751. connection_closed = true;
  13752. res.status = StatusCode::UriTooLong_414;
  13753. output_error_log(Error::ExceedUriMaxLength, &req);
  13754. return write_response(strm, close_connection, req, res);
  13755. }
  13756. if (detail::has_header_token(req.headers, "Connection", "close")) {
  13757. connection_closed = true;
  13758. }
  13759. if (req.version == "HTTP/1.0" &&
  13760. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  13761. connection_closed = true;
  13762. }
  13763. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  13764. // itself a trusted proxy. Otherwise any direct client could spoof
  13765. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  13766. if (detail::is_trusted_proxy(remote_addr, trusted_proxies_) &&
  13767. req.has_header("X-Forwarded-For")) {
  13768. // Some proxies append the address they observed as a separate
  13769. // X-Forwarded-For field line instead of extending the one the client sent
  13770. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  13771. // be scanned. Reading only the first occurrence would hand back the
  13772. // client-supplied, and therefore forgeable, value.
  13773. auto x_forwarded_for =
  13774. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  13775. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  13776. req.remote_addr = derived.empty() ? remote_addr : derived;
  13777. } else {
  13778. req.remote_addr = remote_addr;
  13779. }
  13780. req.remote_port = remote_port;
  13781. req.local_addr = local_addr;
  13782. req.local_port = local_port;
  13783. if (req.has_header("Accept")) {
  13784. auto accept_header =
  13785. detail::get_combined_header_value(req.headers, "Accept");
  13786. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  13787. connection_closed = true;
  13788. res.status = StatusCode::BadRequest_400;
  13789. output_error_log(Error::HTTPParsing, &req);
  13790. return write_response(strm, close_connection, req, res);
  13791. }
  13792. }
  13793. // RFC 9110 14.2: range handling is defined only for GET (and so for HEAD)
  13794. if ((req.method == "GET" || req.method == "HEAD") &&
  13795. req.has_header("Range")) {
  13796. const auto &range_header_value = req.get_header_value("Range");
  13797. // RFC 9110 14.2: a range unit other than bytes must be ignored
  13798. auto unit = range_header_value.substr(0, range_header_value.find('='));
  13799. if (detail::case_ignore::equal(unit, "bytes") &&
  13800. !detail::parse_range_header(range_header_value, req.ranges)) {
  13801. connection_closed = true;
  13802. res.status = StatusCode::RangeNotSatisfiable_416;
  13803. output_error_log(Error::InvalidRangeHeader, &req);
  13804. return write_response(strm, close_connection, req, res);
  13805. }
  13806. }
  13807. if (setup_request) { setup_request(req); }
  13808. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  13809. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  13810. // must be ignored. An expectation we do not recognize is left alone; the
  13811. // 417 the section allows for one is a MAY, not a requirement.
  13812. //
  13813. // `100 Continue` itself is deferred until the body is actually read (see
  13814. // read_content_core), so a request rejected by a later handler never
  13815. // invites the client to send a body nobody will read.
  13816. if (req.version != "HTTP/1.0" &&
  13817. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  13818. int status = StatusCode::Continue_100;
  13819. if (expect_100_continue_handler_) {
  13820. status = expect_100_continue_handler_(req, res);
  13821. }
  13822. if (status == StatusCode::Continue_100) {
  13823. req.expect_100_continue_pending_ = true;
  13824. } else {
  13825. if (res.status == -1) { res.status = status; }
  13826. connection_closed = true;
  13827. return write_response(strm, true, req, res);
  13828. }
  13829. }
  13830. // Setup `is_connection_closed` method
  13831. auto sock = strm.socket();
  13832. req.is_connection_closed = [sock]() {
  13833. return !detail::is_socket_alive(sock);
  13834. };
  13835. // WebSocket upgrade
  13836. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  13837. // that authentication and other middleware can reject the request with an
  13838. // HTTP response (e.g., 401) before the protocol switches.
  13839. // The response says so when this connection closes after it.
  13840. auto close_after_response = close_connection || connection_closed;
  13841. // An upgrade request has been through pre-routing before it reaches routing()
  13842. auto is_upgrade = detail::is_websocket_upgrade(req);
  13843. if (is_upgrade) {
  13844. // A response given here leaves the body unread, and it would be parsed as
  13845. // the next request.
  13846. auto close_if_answered =
  13847. close_after_response || detail::has_framed_body(req);
  13848. const WebSocketHandlerEntry *ws_route = nullptr;
  13849. std::string selected_subprotocol;
  13850. auto answer_before_upgrade = [&]() -> bool {
  13851. if (pre_routing_handler_ &&
  13852. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  13853. return true;
  13854. }
  13855. for (const auto &entry : websocket_handlers_) {
  13856. if (!entry.matcher->match(req)) { continue; }
  13857. req.matched_route = entry.matcher->pattern();
  13858. if (pre_request_handler_ &&
  13859. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  13860. return true;
  13861. }
  13862. ws_route = &entry;
  13863. if (entry.sub_protocol_selector) {
  13864. auto protocol_header = detail::get_combined_header_value(
  13865. req.headers, "Sec-WebSocket-Protocol");
  13866. if (!protocol_header.empty()) {
  13867. std::vector<std::string> protocols;
  13868. detail::split(protocol_header.data(),
  13869. protocol_header.data() + protocol_header.size(), ',',
  13870. [&](const char *b, const char *e) {
  13871. protocols.emplace_back(b, e);
  13872. });
  13873. selected_subprotocol = entry.sub_protocol_selector(protocols);
  13874. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  13875. if (std::find(protocols.begin(), protocols.end(),
  13876. selected_subprotocol) == protocols.end()) {
  13877. selected_subprotocol.clear();
  13878. }
  13879. }
  13880. }
  13881. return false;
  13882. }
  13883. return false;
  13884. };
  13885. auto answered = false;
  13886. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13887. answered = answer_before_upgrade();
  13888. #else
  13889. try {
  13890. answered = answer_before_upgrade();
  13891. } catch (...) {
  13892. if (!handle_exception(req, res)) {
  13893. return write_response(strm, close_if_answered, req, res);
  13894. }
  13895. answered = true;
  13896. }
  13897. #endif
  13898. if (answered) {
  13899. if (res.status == -1) { res.status = StatusCode::OK_200; }
  13900. return write_response_with_content(strm, close_if_answered, req, res);
  13901. }
  13902. if (ws_route) {
  13903. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  13904. auto accept_key = detail::websocket_accept_key(client_key);
  13905. // Send 101 Switching Protocols
  13906. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  13907. "Upgrade: websocket\r\n"
  13908. "Connection: Upgrade\r\n"
  13909. "Sec-WebSocket-Accept: " +
  13910. accept_key + "\r\n";
  13911. if (!selected_subprotocol.empty()) {
  13912. if (!detail::fields::is_field_value(selected_subprotocol)) {
  13913. return false;
  13914. }
  13915. handshake_response +=
  13916. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  13917. }
  13918. handshake_response += "\r\n";
  13919. if (strm.write(handshake_response.data(), handshake_response.size()) <
  13920. 0) {
  13921. return false;
  13922. }
  13923. connection_closed = true;
  13924. if (websocket_upgraded) { *websocket_upgraded = true; }
  13925. auto stopping = [this] { return is_stopping(); };
  13926. if (CPPHTTPLIB_WEBSOCKET_TCP_NODELAY) {
  13927. set_socket_opt(strm.socket(), IPPROTO_TCP, TCP_NODELAY, 1);
  13928. }
  13929. #ifdef CPPHTTPLIB_SSL_ENABLED
  13930. if (req.ssl) {
  13931. // wss: the heartbeat ping thread and the read path enter the same
  13932. // TLS session from different threads. Hand the WebSocket a stream
  13933. // that serializes every TLS call, so the shared SSLSocketStream on
  13934. // the plain HTTP/HTTPS paths stays untouched.
  13935. auto ws_strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  13936. strm.socket(), const_cast<tls::session_t>(req.ssl),
  13937. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  13938. write_timeout_sec_, write_timeout_usec_));
  13939. ws::WebSocket ws(std::move(ws_strm), req, true,
  13940. websocket_ping_interval_sec_,
  13941. websocket_max_missed_pongs_, stopping);
  13942. ws_route->handler(req, ws);
  13943. return true;
  13944. }
  13945. #endif
  13946. // Use WebSocket-specific read timeout instead of HTTP timeout
  13947. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0);
  13948. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  13949. websocket_max_missed_pongs_, stopping);
  13950. ws_route->handler(req, ws);
  13951. return true;
  13952. }
  13953. // No WebSocket route: route it as a plain HTTP request
  13954. }
  13955. // Routing
  13956. auto routed = false;
  13957. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13958. routed = routing(req, res, strm, is_upgrade);
  13959. #else
  13960. try {
  13961. routed = routing(req, res, strm, is_upgrade);
  13962. } catch (...) { routed = handle_exception(req, res); }
  13963. #endif
  13964. auto ret = false;
  13965. if (routed) {
  13966. if (res.status == -1) {
  13967. res.status = req.ranges.empty() ? StatusCode::OK_200
  13968. : StatusCode::PartialContent_206;
  13969. }
  13970. // Before the Range checks below, so they see the body's own length.
  13971. detail::prefer_assigned_body(res);
  13972. // Serve file content by using a content provider
  13973. auto file_open_error = false;
  13974. if (!res.file_content_path_.empty()) {
  13975. const auto &path = res.file_content_path_;
  13976. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13977. if (!mm->is_open()) {
  13978. res.status = StatusCode::NotFound_404;
  13979. output_error_log(Error::OpenFile, &req);
  13980. file_open_error = true;
  13981. } else {
  13982. auto content_type = res.file_content_content_type_;
  13983. if (content_type.empty()) {
  13984. // One the handler set after set_file_content()
  13985. content_type = res.get_header_value("Content-Type");
  13986. }
  13987. if (content_type.empty()) {
  13988. content_type = detail::find_content_type(
  13989. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13990. }
  13991. detail::set_file_content_provider(
  13992. res, mm, content_type,
  13993. static_file_encoding(req, res, content_type, mm->size()));
  13994. }
  13995. }
  13996. if (file_open_error) {
  13997. ret = write_response(strm, close_after_response, req, res);
  13998. } else if (detail::range_error(req, res)) {
  13999. detail::clear_content(res);
  14000. res.status = StatusCode::RangeNotSatisfiable_416;
  14001. ret = write_response(strm, close_after_response, req, res);
  14002. } else {
  14003. ret = write_response_with_content(strm, close_after_response, req, res);
  14004. }
  14005. } else {
  14006. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  14007. ret = write_response(strm, close_after_response, req, res);
  14008. }
  14009. // Drain any unconsumed framed body to prevent request smuggling on
  14010. // keep-alive. Without framing there is no body to drain — reading would
  14011. // consume the next request (issue #2450). If the response has committed the
  14012. // connection to close, there is no next request to protect. A body read in
  14013. // part cannot be drained from where it stopped, so the connection closes,
  14014. // as it does when the body is longer than the drain limit or does not
  14015. // arrive within the read timeout.
  14016. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  14017. !detail::has_header_token(res.headers, "Connection", "close")) {
  14018. strm.set_max_timeout(read_timeout_msec);
  14019. int dummy_status;
  14020. if (req.body_read_started_ ||
  14021. !detail::read_content(
  14022. strm, req, CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH, dummy_status,
  14023. nullptr, [](const char *, size_t, size_t, size_t) { return true; },
  14024. false)) {
  14025. connection_closed = true;
  14026. }
  14027. }
  14028. return ret;
  14029. }
  14030. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  14031. inline bool Server::process_and_close_socket(socket_t sock) {
  14032. std::string remote_addr;
  14033. int remote_port = 0;
  14034. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  14035. std::string local_addr;
  14036. int local_port = 0;
  14037. detail::get_local_ip_and_port(sock, local_addr, local_port);
  14038. bool websocket_upgraded = false;
  14039. auto ret = serve_guarded([&]() {
  14040. return detail::process_server_socket(
  14041. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  14042. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14043. write_timeout_usec_,
  14044. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  14045. return process_request(strm, remote_addr, remote_port, local_addr,
  14046. local_port, close_connection,
  14047. connection_closed, nullptr,
  14048. &websocket_upgraded);
  14049. });
  14050. });
  14051. detail::drain_and_close_socket(sock);
  14052. return ret;
  14053. }
  14054. // After accept() failed for good. Takes the descriptor out of svr_sock_
  14055. // before closing it: a later stop() would otherwise shutdown()/close() a value
  14056. // the OS may have reused, and keep_alive() watches svr_sock_ to notice the
  14057. // server is gone. The exchange also settles the race with a concurrent stop(),
  14058. // since whichever side takes the descriptor closes it exactly once. Returns
  14059. // false when stop() took it first.
  14060. inline bool Server::abandon_listen_socket() {
  14061. auto sock = svr_sock_.exchange(INVALID_SOCKET);
  14062. if (sock == INVALID_SOCKET) { return false; }
  14063. detail::close_socket(sock);
  14064. output_error_log(Error::Connection, nullptr);
  14065. return true;
  14066. }
  14067. // Like accept_loop(), but a connection waiting for its next request sits in
  14068. // the poller instead of keeping a worker. A worker serves a connection while it
  14069. // has requests to read, then gives it back to this loop.
  14070. inline bool Server::parking_loop(TaskQueue &task_queue) {
  14071. using Clock = ParkingState::Clock;
  14072. using Connection = ParkingState::Connection;
  14073. const ParkingState::Token listen_token = 0;
  14074. const auto never = (Clock::time_point::max)();
  14075. auto &st = *parking_;
  14076. auto &poller = *st.poller;
  14077. std::vector<ParkingState::Token> ready;
  14078. poller.wait(0, ready); // drops a wake() left from an earlier stop()
  14079. {
  14080. std::lock_guard<std::mutex> guard(st.mutex);
  14081. st.closed = false;
  14082. }
  14083. // Publish the listening socket before checking that stop() has not taken it,
  14084. // so that a stop() from now on leaves closing it to this loop.
  14085. auto listen_sock = svr_sock_.load();
  14086. st.listen_sock = listen_sock;
  14087. auto listening = listen_sock != INVALID_SOCKET && svr_sock_ == listen_sock;
  14088. if (listening) { detail::set_nonblocking(listen_sock, true); }
  14089. auto listen_rearm_at = Clock::now(); // `never` while it is armed
  14090. auto fatal = false;
  14091. const auto check_interval =
  14092. std::chrono::duration_cast<Clock::duration>(std::chrono::microseconds(
  14093. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND));
  14094. // Never shorter than the interval keep_alive() first waits, so that a
  14095. // request sent right after connecting is served even with a timeout of 0.
  14096. const auto keep_alive =
  14097. (std::max)(Clock::duration(std::chrono::seconds(keep_alive_timeout_sec_)),
  14098. check_interval);
  14099. // Only an interval the user asked for: Windows' default exists for the sake
  14100. // of stop(), which wake() already serves here.
  14101. const auto idle = std::chrono::microseconds(
  14102. idle_interval_set_ ? idle_interval_sec_ * 1000000 + idle_interval_usec_
  14103. : 0);
  14104. auto next_idle = idle.count() > 0 ? Clock::now() + idle : never;
  14105. auto park = [&](Connection conn, Clock::time_point now) {
  14106. if (!st.park(std::move(conn), now + keep_alive)) {
  14107. output_error_log(Error::ResourceExhaustion, nullptr);
  14108. }
  14109. };
  14110. auto dispatch = [&](const Connection &conn) {
  14111. return task_queue.enqueue([this, conn]() { resume_connection(conn); });
  14112. };
  14113. // The only way into the queue besides the backlog, which nothing overtakes.
  14114. // When the queue is full, a new connection is turned away, as accept_loop()
  14115. // does, and an established one waits in the backlog, since closing it would
  14116. // lose its request. A TaskQueue gives no sign when it has room again, so the
  14117. // backlog is retried every check_interval.
  14118. auto submit = [&](Connection conn) {
  14119. if (st.backlog.empty() && dispatch(conn)) { return; }
  14120. if (conn->opened) {
  14121. st.backlog.push_back(std::move(conn));
  14122. return;
  14123. }
  14124. conn->close_idle();
  14125. output_error_log(Error::ResourceExhaustion, nullptr);
  14126. };
  14127. std::vector<Connection> returned;
  14128. while (listening && svr_sock_ == listen_sock) {
  14129. auto now = Clock::now();
  14130. if (now >= listen_rearm_at) {
  14131. listen_rearm_at =
  14132. poller.arm(listen_sock, listen_token) ? never : now + check_interval;
  14133. }
  14134. // At most a minute, which keeps the timeout below within an int.
  14135. auto until = (std::min)({st.next_deadline(), listen_rearm_at, next_idle,
  14136. st.backlog.empty() ? never : now + check_interval,
  14137. now + std::chrono::seconds(60)});
  14138. // Rounded up, so that the wait does not end just short of the deadline.
  14139. auto timeout = std::chrono::duration_cast<std::chrono::milliseconds>(
  14140. until - now + std::chrono::microseconds(999));
  14141. poller.wait(static_cast<int>((std::max)(timeout.count(),
  14142. std::chrono::milliseconds::rep(0))),
  14143. ready);
  14144. if (svr_sock_ != listen_sock) { break; }
  14145. now = Clock::now();
  14146. {
  14147. std::lock_guard<std::mutex> guard(st.mutex);
  14148. returned.swap(st.returned);
  14149. }
  14150. for (auto &conn : returned) {
  14151. park(std::move(conn), now);
  14152. }
  14153. returned.clear();
  14154. // Connections that found the queue full go first, in their order.
  14155. while (!st.backlog.empty() && dispatch(st.backlog.front())) {
  14156. st.backlog.pop_front();
  14157. }
  14158. for (auto token : ready) {
  14159. if (token == listen_token) {
  14160. listen_rearm_at = now;
  14161. // A batch per round, so that a burst of new connections does not
  14162. // hold up the ones that are ready.
  14163. for (auto i = 0; i < 64; i++) {
  14164. auto sock = detail::accept_socket(listen_sock);
  14165. if (sock == INVALID_SOCKET) {
  14166. if (detail::is_would_block_error()) { break; }
  14167. if (detail::is_accept_resource_error()) {
  14168. // Out of descriptors: let the deadlines free some first.
  14169. listen_rearm_at = now + check_interval;
  14170. break;
  14171. }
  14172. if (detail::is_accept_transient_error()) { continue; }
  14173. fatal = true;
  14174. break;
  14175. }
  14176. // Some platforms make it non-blocking like the listening socket.
  14177. detail::set_nonblocking(sock, false);
  14178. prepare_accepted_socket(sock);
  14179. park(new_keep_alive_connection(sock), now);
  14180. if (idle.count() > 0) { next_idle = now + idle; }
  14181. }
  14182. continue;
  14183. }
  14184. submit(st.unpark(token));
  14185. }
  14186. if (fatal) { break; }
  14187. st.expire(now);
  14188. if (now >= next_idle) {
  14189. task_queue.on_idle();
  14190. next_idle = now + idle;
  14191. }
  14192. }
  14193. // A worker still serving a request closes its connection itself.
  14194. st.close_all();
  14195. poller.disarm(listen_sock);
  14196. // See ParkingState::listen_sock.
  14197. if (st.listen_sock.exchange(INVALID_SOCKET) == INVALID_SOCKET) {
  14198. // stop() handed it over.
  14199. detail::shutdown_socket(listen_sock);
  14200. detail::close_socket(listen_sock);
  14201. return true;
  14202. }
  14203. return !(fatal && abandon_listen_socket());
  14204. }
  14205. inline std::shared_ptr<Server::KeepAliveConnection>
  14206. Server::new_keep_alive_connection(socket_t sock) {
  14207. return std::make_shared<PlainConnection>(sock, *this);
  14208. }
  14209. inline void
  14210. Server::resume_connection(std::shared_ptr<KeepAliveConnection> conn) {
  14211. auto &st = *parking_;
  14212. auto &c = *conn;
  14213. auto ret = c.resume();
  14214. if (c.turn.park) {
  14215. c.release_buffers(); // it may stay idle for long
  14216. if (st.give_back(conn)) { return; }
  14217. }
  14218. c.close_served(!c.turn.websocket_upgraded && ret);
  14219. }
  14220. inline void Server::output_log(const Request &req, const Response &res) const {
  14221. if (logger_) {
  14222. std::lock_guard<std::mutex> guard(logger_mutex_);
  14223. logger_(req, res);
  14224. }
  14225. }
  14226. inline void Server::output_pre_compression_log(const Request &req,
  14227. const Response &res) const {
  14228. if (pre_compression_logger_) {
  14229. std::lock_guard<std::mutex> guard(logger_mutex_);
  14230. pre_compression_logger_(req, res);
  14231. }
  14232. }
  14233. inline void Server::output_error_log(const Error &err,
  14234. const Request *req) const {
  14235. if (error_logger_) {
  14236. std::lock_guard<std::mutex> guard(logger_mutex_);
  14237. error_logger_(err, req);
  14238. }
  14239. }
  14240. /*
  14241. * Group 5: ClientImpl and Client (Universal) implementation
  14242. */
  14243. // HTTP client implementation
  14244. inline ClientImpl::ClientImpl(const std::string &host)
  14245. : ClientImpl(host, 80, std::string(), std::string()) {}
  14246. inline ClientImpl::ClientImpl(const std::string &host, int port)
  14247. : ClientImpl(host, port, std::string(), std::string()) {}
  14248. inline ClientImpl::ClientImpl(const std::string &host, int port,
  14249. const std::string &client_cert_path,
  14250. const std::string &client_key_path)
  14251. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  14252. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  14253. inline ClientImpl::~ClientImpl() {
  14254. // Wait until all the requests in flight are handled.
  14255. size_t retry_count = 10;
  14256. while (retry_count-- > 0) {
  14257. {
  14258. std::lock_guard<std::mutex> guard(socket_mutex_);
  14259. if (socket_requests_in_flight_ == 0) { break; }
  14260. }
  14261. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  14262. }
  14263. std::lock_guard<std::mutex> guard(socket_mutex_);
  14264. shutdown_socket(socket_);
  14265. close_socket(socket_);
  14266. }
  14267. inline bool ClientImpl::is_valid() const { return true; }
  14268. inline bool
  14269. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  14270. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  14271. if (no_proxy_entries_.empty()) { return true; }
  14272. // host_ is const so its normalized form is invariant; cache it. The
  14273. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  14274. if (host == host_) {
  14275. if (!host_normalized_valid_) {
  14276. host_normalized_ = detail::normalize_target(host_);
  14277. host_normalized_valid_ = true;
  14278. }
  14279. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  14280. }
  14281. auto target = detail::normalize_target(host);
  14282. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  14283. }
  14284. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  14285. if (is_proxy_enabled_for_host(host_)) {
  14286. return detail::create_client_socket(
  14287. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  14288. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  14289. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  14290. write_timeout_sec_, write_timeout_usec_, interface_, error,
  14291. stop_interrupt());
  14292. }
  14293. // Check is custom IP or hostname specified for host_
  14294. std::string connect_host;
  14295. std::string ip;
  14296. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  14297. return detail::create_client_socket(
  14298. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  14299. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  14300. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14301. write_timeout_usec_, interface_, error, stop_interrupt());
  14302. }
  14303. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  14304. Error &error) {
  14305. auto sock = create_client_socket(error);
  14306. if (sock == INVALID_SOCKET) { return false; }
  14307. socket.sock = sock;
  14308. return true;
  14309. }
  14310. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  14311. socket_tls_settings_version_ = tls_settings_version_;
  14312. return create_and_connect_socket(socket, error);
  14313. }
  14314. inline bool ClientImpl::setup_proxy_connection(
  14315. Socket & /*socket*/,
  14316. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  14317. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  14318. return true;
  14319. }
  14320. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  14321. bool /*shutdown_gracefully*/) {
  14322. // If there are any requests in flight from threads other than us, then it's
  14323. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  14324. assert(socket_requests_in_flight_ == 0 ||
  14325. socket_requests_are_from_thread_ == std::this_thread::get_id());
  14326. }
  14327. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  14328. if (socket.sock == INVALID_SOCKET) { return; }
  14329. detail::shutdown_socket(socket.sock);
  14330. }
  14331. inline void ClientImpl::close_socket(Socket &socket) {
  14332. // If there are requests in flight in another thread, usually closing
  14333. // the socket will be fine and they will simply receive an error when
  14334. // using the closed socket, but it is still a bug since rarely the OS
  14335. // may reassign the socket id to be used for a new socket, and then
  14336. // suddenly they will be operating on a live socket that is different
  14337. // than the one they intended!
  14338. assert(socket_requests_in_flight_ == 0 ||
  14339. socket_requests_are_from_thread_ == std::this_thread::get_id());
  14340. // It is also a bug if this happens while SSL is still active
  14341. #ifdef CPPHTTPLIB_SSL_ENABLED
  14342. assert(socket.ssl == nullptr);
  14343. #endif
  14344. if (socket.sock == INVALID_SOCKET) { return; }
  14345. detail::close_socket(socket.sock);
  14346. socket.sock = INVALID_SOCKET;
  14347. }
  14348. inline void ClientImpl::disconnect(bool gracefully) {
  14349. shutdown_ssl(socket_, gracefully);
  14350. shutdown_socket(socket_);
  14351. close_socket(socket_);
  14352. }
  14353. inline bool ClientImpl::socket_reusable() {
  14354. if (!socket_.is_open()) { return false; }
  14355. // RFC 9112 9.2: data with no request outstanding is not a response
  14356. if (detail::select_read(socket_.sock, 0, 0) != 0) {
  14357. disconnect(/*gracefully=*/false);
  14358. return false;
  14359. }
  14360. if (is_ssl() && socket_tls_settings_version_ != tls_settings_version_) {
  14361. disconnect(/*gracefully=*/true);
  14362. return false;
  14363. }
  14364. return true;
  14365. }
  14366. inline bool ClientImpl::prepare_socket(
  14367. std::unique_lock<std::mutex> &guard,
  14368. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14369. Response &res, bool &success, Error &error) {
  14370. auto opened = true;
  14371. if (!socket_reusable()) {
  14372. Socket socket;
  14373. guard.unlock();
  14374. opened = ensure_socket_connection(socket, error);
  14375. if (opened) {
  14376. opened = setup_proxy_connection(socket, start_time, res, success, error);
  14377. } else {
  14378. success = false;
  14379. }
  14380. guard.lock();
  14381. socket_ = socket;
  14382. }
  14383. if (stop_requested_) {
  14384. disconnect(/*gracefully=*/false);
  14385. error = Error::Canceled;
  14386. success = false;
  14387. return false;
  14388. }
  14389. return opened;
  14390. }
  14391. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  14392. Response &res,
  14393. bool skip_100_continue) const {
  14394. std::array<char, 2048> buf{};
  14395. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  14396. if (!line_reader.getline()) { return false; }
  14397. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  14398. res.reason)) {
  14399. return req.method == "CONNECT";
  14400. }
  14401. // Skip interim (1xx) responses along with their header fields, except a 100
  14402. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  14403. // HTTP on the connection, so it is final. A server sending them without end
  14404. // would hold the client, so there may be only so many.
  14405. size_t interim_count = 0;
  14406. while (100 <= res.status && res.status < 200 &&
  14407. res.status != StatusCode::SwitchingProtocol_101 &&
  14408. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  14409. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  14410. return false;
  14411. }
  14412. Headers interim_headers;
  14413. if (!detail::read_headers(strm, interim_headers)) { return false; }
  14414. if (!line_reader.getline()) { return false; } // next response line
  14415. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  14416. res.reason)) {
  14417. return false;
  14418. }
  14419. }
  14420. return true;
  14421. }
  14422. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  14423. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14424. // A same-origin redirect and a digest retry send through here again. Only
  14425. // the call the caller made reports a failure, once, with its request.
  14426. auto outermost = send_depth_++ == 0;
  14427. auto se = detail::scope_exit([&] { send_depth_--; });
  14428. if (outermost) {
  14429. error = Error::Success;
  14430. stop_requested_ = false;
  14431. }
  14432. auto ret = send_(req, res, error);
  14433. if (error == Error::SSLPeerCouldBeClosed_) {
  14434. assert(!ret);
  14435. ret = send_(req, res, error);
  14436. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  14437. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  14438. }
  14439. // Also an answer that carries an error, such as a proxy's 407
  14440. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  14441. return ret;
  14442. }
  14443. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  14444. #ifdef CPPHTTPLIB_SSL_ENABLED
  14445. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  14446. // client that failed to set up its TLS context keeps reporting why.
  14447. if (is_valid()) {
  14448. last_ssl_error_ = 0;
  14449. last_backend_error_ = 0;
  14450. }
  14451. #endif
  14452. {
  14453. std::unique_lock<std::mutex> guard(socket_mutex_);
  14454. // Set this to false immediately - if it ever gets set to true by the end
  14455. // of the request, we know another thread instructed us to close the
  14456. // socket.
  14457. socket_should_be_closed_when_request_is_done_ = false;
  14458. auto success = true;
  14459. if (!prepare_socket(guard, req.start_time_, res, success, error)) {
  14460. return success;
  14461. }
  14462. // Mark the current socket as being in use so that it cannot be closed by
  14463. // anyone else while this request is ongoing, even though we will be
  14464. // releasing the mutex.
  14465. if (socket_requests_in_flight_ > 1) {
  14466. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  14467. }
  14468. socket_requests_in_flight_ += 1;
  14469. socket_requests_are_from_thread_ = std::this_thread::get_id();
  14470. }
  14471. for (const auto &header : default_headers_) {
  14472. if (req.headers.find(header.first) == req.headers.end()) {
  14473. req.headers.insert(header);
  14474. }
  14475. }
  14476. auto ret = false;
  14477. auto close_connection = !keep_alive_;
  14478. auto se = detail::scope_exit([&]() {
  14479. // Briefly lock mutex in order to mark that a request is no longer ongoing
  14480. std::lock_guard<std::mutex> guard(socket_mutex_);
  14481. socket_requests_in_flight_ -= 1;
  14482. if (socket_requests_in_flight_ <= 0) {
  14483. assert(socket_requests_in_flight_ == 0);
  14484. socket_requests_are_from_thread_ = std::thread::id();
  14485. }
  14486. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  14487. !ret) {
  14488. disconnect(/*gracefully=*/true);
  14489. }
  14490. });
  14491. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  14492. strm.set_read_interrupt(stop_interrupt());
  14493. return handle_request(strm, req, res, close_connection, error);
  14494. });
  14495. if (!ret) {
  14496. if (error == Error::Success) { error = Error::Unknown; }
  14497. }
  14498. return ret;
  14499. }
  14500. inline Result ClientImpl::send(const Request &req) {
  14501. auto req2 = req;
  14502. return send_(std::move(req2));
  14503. }
  14504. inline Result ClientImpl::send_(Request &&req) {
  14505. auto res = detail::make_unique<Response>();
  14506. auto error = Error::Success;
  14507. #ifdef CPPHTTPLIB_SSL_ENABLED
  14508. // Hold the request lock until the Result has read this request's TLS error
  14509. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14510. #endif
  14511. auto ret = send(req, *res, error);
  14512. #ifdef CPPHTTPLIB_SSL_ENABLED
  14513. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  14514. last_ssl_error_, last_backend_error_};
  14515. #else
  14516. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  14517. #endif
  14518. }
  14519. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  14520. const std::string &ct) {
  14521. (void)for_stream;
  14522. // Default headers are meant for the origin and may carry its credentials, so
  14523. // keep them off the CONNECT request the proxy reads.
  14524. if (r.method != "CONNECT") {
  14525. for (const auto &header : default_headers_) {
  14526. if (!r.has_header(header.first)) { r.headers.insert(header); }
  14527. }
  14528. }
  14529. // RFC 9110 5.3 recommends sending control data such as Host first, so
  14530. // prepend it rather than appending it after the caller's own fields.
  14531. if (!r.has_header("Host")) {
  14532. r.headers.emplace_front(
  14533. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  14534. address_family_));
  14535. }
  14536. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  14537. if (!r.content_receiver) {
  14538. if (!r.has_header("Accept-Encoding")) {
  14539. std::string accept_encoding;
  14540. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  14541. accept_encoding = "br";
  14542. #endif
  14543. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  14544. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  14545. accept_encoding += "gzip, deflate";
  14546. #endif
  14547. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  14548. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  14549. accept_encoding += "zstd";
  14550. #endif
  14551. r.set_header("Accept-Encoding", accept_encoding);
  14552. }
  14553. detail::add_default_user_agent_header(r);
  14554. }
  14555. if (!r.body.empty()) {
  14556. if (!ct.empty() && !r.has_header("Content-Type")) {
  14557. r.headers.emplace("Content-Type", ct);
  14558. }
  14559. if (!r.has_header("Content-Length")) {
  14560. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  14561. }
  14562. }
  14563. }
  14564. inline ClientImpl::StreamHandle
  14565. ClientImpl::open_stream(const std::string &method, const std::string &path,
  14566. const Params &params, const Headers &headers,
  14567. const std::string &body,
  14568. const std::string &content_type) {
  14569. // Encode the target exactly like the buffered send path does, so that the
  14570. // same `path` produces the same request line through either API.
  14571. auto raw_query_path =
  14572. params.empty() ? path : append_query_params(path, params);
  14573. Request req;
  14574. req.method = method;
  14575. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  14576. req.headers = headers;
  14577. req.body = body;
  14578. prepare_default_headers(req, true, content_type);
  14579. auto handle = open_stream_(req);
  14580. // Like a buffered request, a stream that fails to open is reported once
  14581. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  14582. return handle;
  14583. }
  14584. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  14585. StreamHandle handle;
  14586. handle.response = detail::make_unique<Response>();
  14587. handle.error = Error::Success;
  14588. handle.connection_ = detail::make_unique<ClientConnection>();
  14589. {
  14590. // A request in flight uses socket_ without holding socket_mutex_
  14591. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14592. if (send_depth_ == 0) { stop_requested_ = false; }
  14593. std::unique_lock<std::mutex> guard(socket_mutex_);
  14594. auto success = true;
  14595. if (!prepare_socket(guard, std::chrono::steady_clock::now(),
  14596. *handle.response, success, handle.error)) {
  14597. if (!success) { handle.response.reset(); }
  14598. return handle;
  14599. }
  14600. transfer_socket_ownership_to_handle(handle);
  14601. }
  14602. #ifdef CPPHTTPLIB_SSL_ENABLED
  14603. if (is_ssl() && handle.connection_->session) {
  14604. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  14605. handle.connection_->sock, handle.connection_->session,
  14606. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14607. write_timeout_usec_);
  14608. } else {
  14609. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  14610. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  14611. write_timeout_sec_, write_timeout_usec_);
  14612. }
  14613. #else
  14614. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  14615. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  14616. write_timeout_sec_, write_timeout_usec_);
  14617. #endif
  14618. handle.stream_ = handle.socket_stream_.get();
  14619. auto &strm = *handle.stream_;
  14620. // Only for the head, as the handle may outlive this client
  14621. strm.set_read_interrupt(stop_interrupt());
  14622. auto release_interrupt =
  14623. detail::scope_exit([&] { strm.set_read_interrupt(nullptr); });
  14624. // After connecting, as for a buffered request
  14625. add_credential_headers(req);
  14626. // Build the request line and headers in memory first, like write_request()
  14627. // does, so that a rejected header leaves nothing on the wire.
  14628. {
  14629. detail::BufferStream bstrm;
  14630. // The path follows the authority in absolute-form, so one that does not
  14631. // begin with '/' (e.g. "@evil.example/x") would name another host.
  14632. auto prefix = proxy_target_prefix();
  14633. if ((!prefix.empty() && req.path[0] != '/') ||
  14634. detail::write_request_line(bstrm, req.method, prefix + req.path) < 0) {
  14635. handle.error = Error::Write;
  14636. handle.response.reset();
  14637. return handle;
  14638. }
  14639. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14640. handle.error)) {
  14641. handle.response.reset();
  14642. return handle;
  14643. }
  14644. const auto &data = bstrm.get_buffer();
  14645. if (!detail::write_data(strm, data.data(), data.size())) {
  14646. handle.error = Error::Write;
  14647. handle.response.reset();
  14648. return handle;
  14649. }
  14650. }
  14651. if (!req.body.empty()) {
  14652. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14653. handle.error = Error::Write;
  14654. handle.response.reset();
  14655. return handle;
  14656. }
  14657. }
  14658. if (!read_response_line(strm, req, *handle.response) ||
  14659. !detail::read_headers(strm, handle.response->headers)) {
  14660. handle.error = Error::Read;
  14661. handle.response.reset();
  14662. return handle;
  14663. }
  14664. handle.body_reader_.stream = handle.stream_;
  14665. handle.body_reader_.payload_max_length = payload_max_length_;
  14666. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  14667. // header section, so none of its framing or coding headers apply.
  14668. if (req.method == "HEAD" ||
  14669. handle.response->status == StatusCode::NoContent_204 ||
  14670. handle.response->status == StatusCode::NotModified_304) {
  14671. handle.body_reader_.eof = true;
  14672. return handle;
  14673. }
  14674. // Same framing check as ClientImpl::process_request()
  14675. if (detail::has_conflicting_content_length(handle.response->headers)) {
  14676. handle.error = Error::Read;
  14677. handle.response.reset();
  14678. return handle;
  14679. }
  14680. if (handle.response->has_header("Content-Length")) {
  14681. bool is_invalid = false;
  14682. auto content_length = detail::get_header_value_u64(
  14683. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  14684. if (is_invalid) {
  14685. handle.error = Error::Read;
  14686. handle.response.reset();
  14687. return handle;
  14688. }
  14689. handle.body_reader_.has_content_length = true;
  14690. handle.body_reader_.content_length = content_length;
  14691. }
  14692. handle.body_reader_.chunked =
  14693. detail::is_chunked_transfer_encoding(handle.response->headers);
  14694. auto content_encoding = detail::get_combined_header_value(
  14695. handle.response->headers, "Content-Encoding");
  14696. if (decompress_ && !content_encoding.empty()) {
  14697. // Same policy as prepare_content_receiver(): reject a coding we know about
  14698. // but were not built with, pass an unrecognized one through as-is.
  14699. handle.decompressor_ = detail::create_decompressor(content_encoding);
  14700. if (!handle.decompressor_) {
  14701. if (detail::is_known_content_encoding(content_encoding)) {
  14702. handle.error = Error::UnsupportedContentEncoding;
  14703. handle.response.reset();
  14704. return handle;
  14705. }
  14706. } else if (!handle.decompressor_->is_valid()) {
  14707. handle.error = Error::Compression;
  14708. handle.response.reset();
  14709. return handle;
  14710. }
  14711. }
  14712. return handle;
  14713. }
  14714. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  14715. if (!is_valid() || !response) { return -1; }
  14716. auto n = decompressor_
  14717. ? read_with_decompression(buf, len)
  14718. : detail::read_body_content(stream_, body_reader_, buf, len);
  14719. if (n == 0) { parse_trailers_if_needed(); }
  14720. return n;
  14721. }
  14722. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  14723. size_t len) {
  14724. if (decompress_offset_ < decompress_buffer_.size()) {
  14725. auto available = decompress_buffer_.size() - decompress_offset_;
  14726. auto to_copy = (std::min)(len, available);
  14727. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  14728. decompress_offset_ += to_copy;
  14729. decompressed_bytes_read_ += to_copy;
  14730. return static_cast<ssize_t>(to_copy);
  14731. }
  14732. decompress_buffer_.clear();
  14733. decompress_offset_ = 0;
  14734. constexpr size_t kDecompressionBufferSize = 8192;
  14735. char compressed_buf[kDecompressionBufferSize];
  14736. while (true) {
  14737. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  14738. sizeof(compressed_buf));
  14739. if (n <= 0) { return n; }
  14740. auto exceeded = false;
  14741. bool decompress_ok = decompressor_->decompress(
  14742. compressed_buf, static_cast<size_t>(n),
  14743. [&](const char *data, size_t data_len) {
  14744. decompress_buffer_.append(data, data_len);
  14745. auto limit = body_reader_.payload_max_length;
  14746. exceeded =
  14747. limit > 0 &&
  14748. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  14749. return !exceeded;
  14750. });
  14751. if (!decompress_ok) {
  14752. body_reader_.last_error =
  14753. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  14754. return -1;
  14755. }
  14756. if (!decompress_buffer_.empty()) { break; }
  14757. }
  14758. auto to_copy = (std::min)(len, decompress_buffer_.size());
  14759. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  14760. decompress_offset_ = to_copy;
  14761. decompressed_bytes_read_ += to_copy;
  14762. return static_cast<ssize_t>(to_copy);
  14763. }
  14764. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  14765. // The trailers follow the last chunk, so there are none before it
  14766. auto &decoder = body_reader_.chunked_decoder;
  14767. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  14768. return;
  14769. }
  14770. trailers_parsed_ = true;
  14771. decoder->parse_trailers_into(response->trailers, response->headers);
  14772. }
  14773. namespace detail {
  14774. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  14775. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  14776. size_t &out_chunk_offset,
  14777. size_t &out_chunk_total) {
  14778. if (finished) { return 0; }
  14779. if (chunk_remaining == 0) {
  14780. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14781. if (!lr.getline()) { return -1; }
  14782. // Everything below is bounded by eol rather than by the buffer's NUL, so
  14783. // the line terminator is never mistaken for line content.
  14784. const char *eol = lr.ptr() + lr.size();
  14785. if (lr.end_with_crlf()) {
  14786. eol -= 2;
  14787. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  14788. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  14789. // getline() ends the line on a bare LF. That LF is the terminator, so it
  14790. // has to come off here or the check below would reject the line.
  14791. eol -= 1;
  14792. }
  14793. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  14794. const char *p = lr.ptr();
  14795. int v = 0;
  14796. if (p == eol || !is_hex(*p, v)) { return -1; }
  14797. size_t chunk_len = 0;
  14798. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  14799. for (; p < eol && is_hex(*p, v); ++p) {
  14800. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  14801. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  14802. }
  14803. while (p < eol && is_space_or_tab(*p)) {
  14804. ++p;
  14805. }
  14806. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  14807. // terminator, and it is built from tokens and quoted-strings, so it never
  14808. // holds a CR, LF or any other control character. getline() reads up to the
  14809. // CRLF, so a bare LF left in here would be swallowed as extension text
  14810. // while an intermediary that ends the line on it delimits the chunks
  14811. // differently, and the two disagree on where the body ends (request
  14812. // smuggling).
  14813. if (p < eol && *p != ';') { return -1; }
  14814. for (; p < eol; ++p) {
  14815. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  14816. }
  14817. // The bytes around the data are no payload, so they are counted on their
  14818. // own, as Go does: each chunk may spend 16 bytes and twice its data on
  14819. // them, which lets a stream send a byte at a time, and what goes past that
  14820. // in padding, leading zeros and extensions builds up to one header field.
  14821. overhead += lr.size() + 2;
  14822. overhead = overhead > 16 ? overhead - 16 : 0;
  14823. overhead = chunk_len > overhead / 2 ? 0 : overhead - 2 * chunk_len;
  14824. if (overhead > CPPHTTPLIB_HEADER_MAX_LENGTH) { return -1; }
  14825. if (chunk_len == 0) {
  14826. chunk_remaining = 0;
  14827. finished = true;
  14828. out_chunk_offset = 0;
  14829. out_chunk_total = 0;
  14830. return 0;
  14831. }
  14832. chunk_remaining = chunk_len;
  14833. last_chunk_total = chunk_remaining;
  14834. last_chunk_offset = 0;
  14835. }
  14836. auto to_read = (std::min)(chunk_remaining, len);
  14837. auto n = strm.read(buf, to_read);
  14838. if (n <= 0) { return -1; }
  14839. auto offset_before = last_chunk_offset;
  14840. last_chunk_offset += static_cast<size_t>(n);
  14841. chunk_remaining -= static_cast<size_t>(n);
  14842. out_chunk_offset = offset_before;
  14843. out_chunk_total = last_chunk_total;
  14844. if (chunk_remaining == 0) {
  14845. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14846. if (!lr.getline()) { return -1; }
  14847. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  14848. }
  14849. return n;
  14850. }
  14851. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  14852. const Headers &src_headers) {
  14853. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  14854. if (!lr.getline()) { return false; }
  14855. return parse_trailers(lr, dest, src_headers);
  14856. }
  14857. // Only 301, 302, 303, 307 and 308 redirect. Any other 3xx, such as a 304, or
  14858. // a redirect without a Location, is a final response.
  14859. inline bool is_redirect(const Response &res) {
  14860. switch (res.status) {
  14861. case StatusCode::MovedPermanently_301:
  14862. case StatusCode::Found_302:
  14863. case StatusCode::SeeOther_303:
  14864. case StatusCode::TemporaryRedirect_307:
  14865. case StatusCode::PermanentRedirect_308:
  14866. return !res.get_header_value("Location").empty();
  14867. default: return false;
  14868. }
  14869. }
  14870. } // namespace detail
  14871. inline void
  14872. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  14873. handle.connection_->sock = socket_.sock;
  14874. #ifdef CPPHTTPLIB_SSL_ENABLED
  14875. handle.connection_->session = socket_.ssl;
  14876. socket_.ssl = nullptr;
  14877. #endif
  14878. socket_.sock = INVALID_SOCKET;
  14879. }
  14880. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  14881. inline std::string ClientImpl::proxy_target_prefix() const {
  14882. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  14883. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  14884. }
  14885. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  14886. Response &res, bool close_connection,
  14887. Error &error) {
  14888. if (req.path.empty()) {
  14889. error = Error::Connection;
  14890. return false;
  14891. }
  14892. auto req_save = req;
  14893. bool ret;
  14894. auto prefix = proxy_target_prefix();
  14895. if (!prefix.empty()) {
  14896. // The path follows the authority in absolute-form, so one that does not
  14897. // begin with '/' (e.g. "@evil.example/x") would name another host.
  14898. if (req.path[0] != '/') {
  14899. error = Error::Write;
  14900. return false;
  14901. }
  14902. auto req2 = req;
  14903. req2.path = prefix + req.path;
  14904. ret = process_request(strm, req2, res, close_connection, error);
  14905. req = std::move(req2);
  14906. req.path = req_save.path;
  14907. } else {
  14908. ret = process_request(strm, req, res, close_connection, error);
  14909. }
  14910. if (!ret) { return false; }
  14911. {
  14912. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  14913. // for this to be safe.
  14914. // This is safe to call because handle_request is only called by send_
  14915. // which locks the request mutex during the process. It would be a bug
  14916. // to call it from a different thread since it's a thread-safety issue
  14917. // to do these things to the socket if another thread is using the socket.
  14918. std::lock_guard<std::mutex> guard(socket_mutex_);
  14919. // Also when the request asked for it (e.g. a body that was never sent,
  14920. // or "Connection: close") or bytes follow the response (RFC 9112 9.2), so
  14921. // that a redirect or an auth retry below does not reuse the socket.
  14922. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  14923. strm.is_readable() ||
  14924. detail::has_header_token(res.headers, "Connection", "close") ||
  14925. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  14926. disconnect(/*gracefully=*/true);
  14927. }
  14928. }
  14929. if (follow_location_ && detail::is_redirect(res)) {
  14930. req = std::move(req_save);
  14931. // The client that followed the redirect has answered any challenge it
  14932. // could. Retrying below would sign another host's challenge and send it
  14933. // here.
  14934. return redirect(req, res, error);
  14935. }
  14936. #ifdef CPPHTTPLIB_SSL_ENABLED
  14937. if ((res.status == StatusCode::Unauthorized_401 ||
  14938. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  14939. req.authorization_count_ < 5) {
  14940. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  14941. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  14942. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  14943. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  14944. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  14945. return ret;
  14946. }
  14947. const auto &username =
  14948. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  14949. const auto &password =
  14950. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  14951. if (!username.empty() && !password.empty()) {
  14952. std::map<std::string, std::string> auth;
  14953. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  14954. Request new_req = req;
  14955. new_req.authorization_count_ += 1;
  14956. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  14957. : "Authorization");
  14958. new_req.headers.insert(detail::make_digest_authentication_header(
  14959. req, make_request_target(req), auth, new_req.authorization_count_,
  14960. detail::random_string(10), username, password, is_proxy));
  14961. Response new_res;
  14962. ret = send(new_req, new_res, error);
  14963. if (ret) { res = std::move(new_res); }
  14964. }
  14965. }
  14966. }
  14967. #endif
  14968. return ret;
  14969. }
  14970. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  14971. if (req.redirect_count_ == 0) {
  14972. error = Error::ExceedRedirectCount;
  14973. return false;
  14974. }
  14975. auto location = res.get_header_value("location");
  14976. if (location.empty()) { return false; }
  14977. auto next_url = detail::resolve_relative_location(location, req.path);
  14978. detail::UrlComponents uc;
  14979. if (!detail::parse_url(next_url, uc)) { return false; }
  14980. // Follow only http/https URLs and references starting with '/'
  14981. if (next_url[0] != '/' && uc.scheme != "http" && uc.scheme != "https") {
  14982. return false;
  14983. }
  14984. auto scheme = is_ssl() ? "https" : "http";
  14985. auto next_scheme = std::move(uc.scheme);
  14986. auto next_host = std::move(uc.host);
  14987. auto port_str = std::move(uc.port);
  14988. auto next_path = std::move(uc.path);
  14989. auto next_query = std::move(uc.query);
  14990. auto next_port = port_;
  14991. if (!port_str.empty()) {
  14992. if (!detail::parse_port(port_str, next_port)) { return false; }
  14993. } else if (!next_scheme.empty()) {
  14994. next_port = next_scheme == "https" ? 443 : 80;
  14995. }
  14996. if (next_scheme.empty()) { next_scheme = scheme; }
  14997. if (next_host.empty()) { next_host = host_; }
  14998. if (next_path.empty()) { next_path = "/"; }
  14999. // An absolute or absolute-path location can have dot segments too.
  15000. if (next_path[0] == '/') {
  15001. next_path = detail::remove_dot_segments(next_path);
  15002. }
  15003. auto path = std::move(next_path) + next_query;
  15004. // A Unix socket client sends "Host: localhost", so a Location naming
  15005. // localhost names this client too.
  15006. auto is_same_host = next_host == host_ ||
  15007. (address_family_ == AF_UNIX && next_host == "localhost");
  15008. // Same host redirect - use current client
  15009. if (next_scheme == scheme && is_same_host && next_port == port_) {
  15010. return detail::redirect(*this, req, res, path, location, error);
  15011. }
  15012. // Cross-host/scheme redirect - create new client with robust setup
  15013. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  15014. path, location, error);
  15015. }
  15016. // New method for robust redirect client creation
  15017. inline bool ClientImpl::create_redirect_client(
  15018. const std::string &scheme, const std::string &host, int port, Request &req,
  15019. Response &res, const std::string &path, const std::string &location,
  15020. Error &error) {
  15021. // Determine if we need SSL
  15022. auto need_ssl = (scheme == "https");
  15023. // Clean up request headers that are host/client specific
  15024. // Remove headers that should not be carried over to new host
  15025. auto headers_to_remove = std::vector<std::string>{
  15026. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  15027. for (const auto &header_name : headers_to_remove) {
  15028. auto it = req.headers.find(header_name);
  15029. while (it != req.headers.end()) {
  15030. it = req.headers.erase(it);
  15031. it = req.headers.find(header_name);
  15032. }
  15033. }
  15034. // Create appropriate client type and handle redirect
  15035. if (need_ssl) {
  15036. #ifdef CPPHTTPLIB_SSL_ENABLED
  15037. // Create SSL client for HTTPS redirect
  15038. SSLClient redirect_client(host, port);
  15039. // Setup basic client configuration first
  15040. setup_redirect_client(redirect_client);
  15041. redirect_client.enable_server_certificate_verification(
  15042. server_certificate_verification_);
  15043. redirect_client.enable_server_hostname_verification(
  15044. server_hostname_verification_);
  15045. redirect_client.system_ca_mode_ = system_ca_mode_;
  15046. // Transfer CA certificate to redirect client
  15047. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  15048. if (is_ssl()) {
  15049. auto &self = static_cast<SSLClient &>(*this);
  15050. // A store given to set_ca_cert_store() lives only in this client's
  15051. // context, which then holds all that is trusted.
  15052. if (self.ca_cert_store_set_) {
  15053. std::string pem;
  15054. {
  15055. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  15056. pem = detail::ca_certs_to_pem(self.ctx_);
  15057. }
  15058. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  15059. redirect_client.ca_cert_store_set_ = true;
  15060. } else if (self.custom_ca_loaded_) {
  15061. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  15062. ca_cert_pem_.size());
  15063. }
  15064. redirect_client.set_session_verifier(self.session_verifier_);
  15065. if (self.server_certificate_verifier_) {
  15066. redirect_client.set_server_certificate_verifier(
  15067. self.server_certificate_verifier_);
  15068. }
  15069. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15070. redirect_client.enable_windows_cert_verification_ =
  15071. self.enable_windows_cert_verification_;
  15072. #endif
  15073. }
  15074. // Client certificates are set through constructor for SSLClient
  15075. // NOTE: SSLClient constructor already takes client_cert_path and
  15076. // client_key_path so we need to create it properly if client certs are
  15077. // needed
  15078. // Execute the redirect
  15079. return detail::redirect(redirect_client, req, res, path, location, error);
  15080. #else
  15081. // SSL not supported - set appropriate error
  15082. error = Error::SSLConnection;
  15083. return false;
  15084. #endif
  15085. } else {
  15086. // HTTP redirect
  15087. ClientImpl redirect_client(host, port);
  15088. // Setup client with robust configuration
  15089. setup_redirect_client(redirect_client);
  15090. // Execute the redirect
  15091. return detail::redirect(redirect_client, req, res, path, location, error);
  15092. }
  15093. }
  15094. // New method for robust client setup (based on basic_manual_redirect.cpp
  15095. // logic)
  15096. template <typename ClientType>
  15097. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  15098. // Copy basic settings first
  15099. client.set_connection_timeout(connection_timeout_sec_,
  15100. connection_timeout_usec_);
  15101. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  15102. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  15103. client.set_max_timeout(max_timeout_msec_);
  15104. if (has_payload_max_length_) {
  15105. client.set_payload_max_length(payload_max_length_);
  15106. }
  15107. client.set_keep_alive(keep_alive_);
  15108. client.set_follow_location(
  15109. true); // Enable redirects to handle multi-step redirects
  15110. client.set_path_encode(path_encode_);
  15111. client.set_compress(compress_);
  15112. client.set_decompress(decompress_);
  15113. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  15114. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  15115. // 15.4, credentials must not be forwarded when redirecting to a different
  15116. // host. This function is only called for cross-host redirects; same-host
  15117. // redirects are handled directly in ClientImpl::redirect().
  15118. // Copy the proxy configuration unconditionally; the per-target bypass is
  15119. // re-evaluated at send time, so a later hop to a non-bypassed host can
  15120. // still use the proxy.
  15121. client.no_proxy_entries_ = no_proxy_entries_;
  15122. if (!proxy_host_.empty() && proxy_port_ != -1) {
  15123. client.set_proxy(proxy_host_, proxy_port_);
  15124. if (!proxy_basic_auth_username_.empty() ||
  15125. !proxy_basic_auth_password_.empty()) {
  15126. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  15127. proxy_basic_auth_password_);
  15128. }
  15129. if (!proxy_bearer_token_auth_token_.empty()) {
  15130. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  15131. }
  15132. #ifdef CPPHTTPLIB_SSL_ENABLED
  15133. if (!proxy_digest_auth_username_.empty()) {
  15134. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  15135. proxy_digest_auth_password_);
  15136. }
  15137. #endif
  15138. }
  15139. // Copy network and socket settings
  15140. client.addr_map_ = addr_map_;
  15141. client.tunnel_addr_map_ = tunnel_addr_map_;
  15142. // A Unix socket client reaches every host through its own socket, as curl's
  15143. // --unix-socket does, unless the caller mapped that host elsewhere. The
  15144. // Location's host is never taken as a socket path.
  15145. if (address_family_ == AF_UNIX) {
  15146. auto &target = client.addr_map_[client.host()];
  15147. if (target.empty()) { target = detail::addr_map_target(addr_map_, host_); }
  15148. }
  15149. client.set_address_family(address_family_);
  15150. client.set_tcp_nodelay(tcp_nodelay_);
  15151. client.set_ipv6_v6only(ipv6_v6only_);
  15152. if (socket_options_) { client.set_socket_options(socket_options_); }
  15153. if (!interface_.empty()) { client.set_interface(interface_); }
  15154. // Copy logging and headers. Not the error logger: a failure comes back to
  15155. // this client's send(), which reports it with the caller's request.
  15156. if (logger_) { client.set_logger(logger_); }
  15157. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  15158. // Each new client should generate its own headers based on its target host
  15159. }
  15160. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  15161. const Request &req,
  15162. Error &error) const {
  15163. auto is_shutting_down = []() { return false; };
  15164. if (req.is_chunked_content_provider_) {
  15165. auto compressor = compress_ ? detail::create_compressor().first
  15166. : std::unique_ptr<detail::compressor>();
  15167. if (!compressor) {
  15168. compressor = detail::make_unique<detail::nocompressor>();
  15169. }
  15170. return detail::write_content_chunked(strm, req.content_provider_,
  15171. is_shutting_down, *compressor, error);
  15172. } else {
  15173. return detail::write_content_with_progress(
  15174. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  15175. req.upload_progress, error);
  15176. }
  15177. }
  15178. // What goes on the request line for req: its path, encoded and without the
  15179. // fragment, with `req.params` as the query when the path has none.
  15180. inline std::string ClientImpl::make_request_target(const Request &req) const {
  15181. auto target = detail::encode_request_target(req.path, path_encode_);
  15182. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  15183. target = append_query_params(target, req.params);
  15184. }
  15185. return target;
  15186. }
  15187. inline void ClientImpl::add_credential_headers(Request &req) {
  15188. // A CONNECT request is read by the proxy; everything sent through the tunnel
  15189. // it opens is read by the origin. Each credential goes only to its own hop.
  15190. auto is_connect = req.method == "CONNECT";
  15191. if (!is_connect) {
  15192. detail::add_authorization_header(req, basic_auth_username_,
  15193. basic_auth_password_,
  15194. bearer_token_auth_token_, false);
  15195. }
  15196. // Proxy-Authorization is only sent when the proxy reads this message —
  15197. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  15198. // would leak proxy credentials to the destination server.
  15199. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  15200. detail::add_authorization_header(req, proxy_basic_auth_username_,
  15201. proxy_basic_auth_password_,
  15202. proxy_bearer_token_auth_token_, true);
  15203. }
  15204. }
  15205. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  15206. bool close_connection, Error &error,
  15207. bool skip_body, bool &rejected_locally) {
  15208. rejected_locally = false;
  15209. // Prepare additional headers
  15210. if (close_connection) {
  15211. if (!req.has_header("Connection")) {
  15212. req.set_header("Connection", "close");
  15213. }
  15214. }
  15215. std::string ct_for_defaults;
  15216. if (!req.has_header("Content-Type") && !req.body.empty()) {
  15217. ct_for_defaults = "text/plain";
  15218. }
  15219. prepare_default_headers(req, false, ct_for_defaults);
  15220. if (req.body.empty()) {
  15221. if (req.content_provider_) {
  15222. if (!req.is_chunked_content_provider_) {
  15223. if (!req.has_header("Content-Length")) {
  15224. auto length = std::to_string(req.content_length_);
  15225. req.set_header("Content-Length", length);
  15226. }
  15227. }
  15228. } else {
  15229. if (req.method == "POST" || req.method == "PUT" ||
  15230. req.method == "PATCH") {
  15231. req.set_header("Content-Length", "0");
  15232. }
  15233. }
  15234. }
  15235. add_credential_headers(req);
  15236. // Request line and headers
  15237. {
  15238. detail::BufferStream bstrm;
  15239. auto path_with_query = make_request_target(req);
  15240. // The query already came in through `req.path`; still populate
  15241. // `req.params` for handlers/users who read them.
  15242. auto query_part = detail::query_of(req.path);
  15243. if (!query_part.empty()) {
  15244. detail::parse_query_text(query_part, req.params);
  15245. }
  15246. // Write request line and headers
  15247. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  15248. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  15249. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  15250. // fail the request cleanly instead of emitting a request-line-less,
  15251. // header-injecting request.
  15252. error = Error::Write;
  15253. rejected_locally = true;
  15254. return false;
  15255. }
  15256. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  15257. error)) {
  15258. rejected_locally = true;
  15259. return false;
  15260. }
  15261. // Flush buffer
  15262. auto &data = bstrm.get_buffer();
  15263. if (!detail::write_data(strm, data.data(), data.size())) {
  15264. error = Error::Write;
  15265. return false;
  15266. }
  15267. }
  15268. // After sending request line and headers, wait briefly for an early server
  15269. // response (e.g. 4xx) and avoid sending a potentially large request body
  15270. // unnecessarily. This workaround is only enabled on Windows because Unix
  15271. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  15272. // buffering can accept large writes even when the peer already responded.
  15273. // Check the stream first (which covers SSL via `is_readable()`), then
  15274. // fall back to select on the socket. Only perform the wait for very large
  15275. // request bodies to avoid interfering with normal small requests and
  15276. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  15277. // response. Skip this check when using Expect: 100-continue, as the protocol
  15278. // handles early responses properly.
  15279. #if defined(_WIN32)
  15280. if (!skip_body &&
  15281. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  15282. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  15283. auto start = std::chrono::high_resolution_clock::now();
  15284. for (;;) {
  15285. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  15286. // from SSL internals. If the underlying socket is readable, assume an
  15287. // early response may be present.
  15288. auto sock = strm.socket();
  15289. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  15290. return false;
  15291. }
  15292. // Fallback to stream-level check for non-socket streams or when the
  15293. // socket isn't reporting readable. Avoid using `is_readable()` for
  15294. // SSL, since `SSL_pending()` may report buffered records that do not
  15295. // indicate a complete application-level response yet.
  15296. if (!is_ssl() && strm.is_readable()) { return false; }
  15297. auto now = std::chrono::high_resolution_clock::now();
  15298. auto elapsed =
  15299. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  15300. .count();
  15301. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  15302. break;
  15303. }
  15304. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  15305. }
  15306. }
  15307. #endif
  15308. // Body
  15309. if (skip_body) { return true; }
  15310. return write_request_body(strm, req, error);
  15311. }
  15312. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  15313. Error &error) {
  15314. if (req.body.empty()) {
  15315. return write_content_with_provider(strm, req, error);
  15316. }
  15317. if (req.upload_progress) {
  15318. auto body_size = req.body.size();
  15319. size_t written = 0;
  15320. auto data = req.body.data();
  15321. while (written < body_size) {
  15322. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  15323. if (!detail::write_data(strm, data + written, to_write)) {
  15324. error = Error::Write;
  15325. return false;
  15326. }
  15327. written += to_write;
  15328. if (!req.upload_progress(written, body_size)) {
  15329. error = Error::Canceled;
  15330. return false;
  15331. }
  15332. }
  15333. } else {
  15334. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  15335. error = Error::Write;
  15336. return false;
  15337. }
  15338. }
  15339. return true;
  15340. }
  15341. inline std::unique_ptr<Response>
  15342. ClientImpl::send_with_content_provider_and_receiver(
  15343. Request &req, const char *body, size_t content_length,
  15344. ContentProvider content_provider,
  15345. ContentProviderWithoutLength content_provider_without_length,
  15346. const std::string &content_type, ContentReceiver content_receiver,
  15347. Error &error) {
  15348. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15349. auto enc = compress_
  15350. ? detail::create_compressor()
  15351. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  15352. nullptr, nullptr);
  15353. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  15354. // A compressed or chunked body is framed by the library, not the caller
  15355. if (enc.second || content_provider_without_length) {
  15356. req.headers.erase("Content-Length");
  15357. }
  15358. if (enc.first && !content_provider_without_length) {
  15359. auto &compressor = enc.first;
  15360. if (content_provider) {
  15361. auto ok = true;
  15362. auto finished = false;
  15363. size_t offset = 0;
  15364. DataSink data_sink;
  15365. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  15366. if (ok) {
  15367. auto last = offset + data_len == content_length;
  15368. auto ret = compressor->compress(
  15369. data, data_len, last,
  15370. [&](const char *compressed_data, size_t compressed_data_len) {
  15371. req.body.append(compressed_data, compressed_data_len);
  15372. return true;
  15373. });
  15374. if (ret) {
  15375. offset += data_len;
  15376. } else {
  15377. ok = false;
  15378. }
  15379. }
  15380. return ok;
  15381. };
  15382. // As in detail::write_content_with_progress(): the body is framed by
  15383. // content_length, so a provider that finishes early has truncated it.
  15384. // Stop and report that instead of calling the provider forever.
  15385. data_sink.done = [&]() { finished = true; };
  15386. while (ok && !finished && offset < content_length) {
  15387. if (!content_provider(offset, content_length - offset, data_sink)) {
  15388. error = Error::Canceled;
  15389. output_error_log(error, &req);
  15390. return nullptr;
  15391. }
  15392. }
  15393. // A short body here means either the provider stopped early or the
  15394. // compressor gave up. The branch below reports a failing compressor as
  15395. // Error::Compression, so keep the two distinguishable.
  15396. if (offset < content_length) {
  15397. error = ok ? Error::Write : Error::Compression;
  15398. output_error_log(error, &req);
  15399. return nullptr;
  15400. }
  15401. } else {
  15402. if (!compressor->compress(body, content_length, true,
  15403. [&](const char *data, size_t data_len) {
  15404. req.body.append(data, data_len);
  15405. return true;
  15406. })) {
  15407. error = Error::Compression;
  15408. output_error_log(error, &req);
  15409. return nullptr;
  15410. }
  15411. }
  15412. } else {
  15413. if (content_provider) {
  15414. req.content_length_ = content_length;
  15415. req.content_provider_ = std::move(content_provider);
  15416. req.is_chunked_content_provider_ = false;
  15417. } else if (content_provider_without_length) {
  15418. req.content_length_ = 0;
  15419. req.content_provider_ = detail::ContentProviderAdapter(
  15420. std::move(content_provider_without_length));
  15421. req.is_chunked_content_provider_ = true;
  15422. req.set_header("Transfer-Encoding", "chunked");
  15423. } else {
  15424. req.body.assign(body, content_length);
  15425. }
  15426. }
  15427. if (content_receiver) {
  15428. req.content_receiver =
  15429. [content_receiver](const char *data, size_t data_length,
  15430. size_t /*offset*/, size_t /*total_length*/) {
  15431. return content_receiver(data, data_length);
  15432. };
  15433. }
  15434. auto res = detail::make_unique<Response>();
  15435. return send(req, *res, error) ? std::move(res) : nullptr;
  15436. }
  15437. inline Result ClientImpl::send_with_content_provider_and_receiver(
  15438. const std::string &method, const std::string &path, const Headers &headers,
  15439. const char *body, size_t content_length, ContentProvider content_provider,
  15440. ContentProviderWithoutLength content_provider_without_length,
  15441. const std::string &content_type, ContentReceiver content_receiver,
  15442. UploadProgress progress) {
  15443. Request req;
  15444. req.method = method;
  15445. req.headers = headers;
  15446. req.path = path;
  15447. req.upload_progress = std::move(progress);
  15448. if (max_timeout_msec_ > 0) {
  15449. req.start_time_ = std::chrono::steady_clock::now();
  15450. }
  15451. auto error = Error::Success;
  15452. #ifdef CPPHTTPLIB_SSL_ENABLED
  15453. // Hold the request lock until the Result has read this request's TLS error
  15454. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  15455. #endif
  15456. auto res = send_with_content_provider_and_receiver(
  15457. req, body, content_length, std::move(content_provider),
  15458. std::move(content_provider_without_length), content_type,
  15459. std::move(content_receiver), error);
  15460. #ifdef CPPHTTPLIB_SSL_ENABLED
  15461. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  15462. last_backend_error_};
  15463. #else
  15464. return Result{std::move(res), error, std::move(req.headers)};
  15465. #endif
  15466. }
  15467. inline void ClientImpl::output_log(const Request &req,
  15468. const Response &res) const {
  15469. if (logger_) {
  15470. std::lock_guard<std::mutex> guard(logger_mutex_);
  15471. logger_(req, res);
  15472. }
  15473. }
  15474. inline void ClientImpl::output_error_log(const Error &err,
  15475. const Request *req) const {
  15476. if (error_logger_) {
  15477. std::lock_guard<std::mutex> guard(logger_mutex_);
  15478. error_logger_(err, req);
  15479. }
  15480. }
  15481. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  15482. Response &res, bool close_connection,
  15483. Error &error) {
  15484. // Auto-add Expect: 100-continue for large bodies
  15485. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  15486. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  15487. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  15488. req.set_header("Expect", "100-continue");
  15489. }
  15490. }
  15491. // Check for Expect: 100-continue
  15492. auto expect_100_continue =
  15493. detail::has_header_token(req.headers, "Expect", "100-continue");
  15494. // Send request (skip body if using Expect: 100-continue)
  15495. auto rejected_locally = false;
  15496. auto write_request_success =
  15497. write_request(strm, req, close_connection, error, expect_100_continue,
  15498. rejected_locally);
  15499. // A failed write normally still reads the response below, since the server
  15500. // may have answered early (e.g. 413/414) and closed while the body was being
  15501. // sent. A request rejected before any byte reached the socket gets no such
  15502. // response, and waiting for one would block until the read timeout.
  15503. if (rejected_locally) { return false; }
  15504. #ifdef CPPHTTPLIB_SSL_ENABLED
  15505. if (is_ssl() && !expect_100_continue) {
  15506. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  15507. if (!is_proxy_enabled) {
  15508. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  15509. error = Error::SSLPeerCouldBeClosed_;
  15510. return false;
  15511. }
  15512. }
  15513. }
  15514. #endif
  15515. // Handle Expect: 100-continue.
  15516. //
  15517. // Wait for an interim/early response by attempting to read the status line
  15518. // under a short timeout, instead of trusting raw socket readability. Over
  15519. // TLS, post-handshake records (e.g. session tickets) make the socket
  15520. // readable without any HTTP response being available; relying on
  15521. // `select_read` there caused the body to be withheld forever and the
  15522. // request to fail with `Read` (#2458). If no status line arrives within the
  15523. // timeout, send the body anyway (matching curl's behavior).
  15524. auto status_line_read = false;
  15525. if (expect_100_continue && write_request_success) {
  15526. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  15527. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  15528. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  15529. strm.set_read_timeout(sec, usec);
  15530. status_line_read = read_response_line(strm, req, res, false);
  15531. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  15532. }
  15533. if (!status_line_read) {
  15534. // No interim response within the timeout: send the body and handle the
  15535. // response as usual.
  15536. if (!write_request_body(strm, req, error)) { return false; }
  15537. expect_100_continue = false; // Switch to normal response handling
  15538. }
  15539. }
  15540. // Receive response and headers
  15541. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  15542. if ((!status_line_read &&
  15543. !read_response_line(strm, req, res, !expect_100_continue)) ||
  15544. !detail::read_headers(strm, res.headers)) {
  15545. if (write_request_success) { error = Error::Read; }
  15546. return false;
  15547. }
  15548. if (!write_request_success) { return false; }
  15549. // Handle Expect: 100-continue response
  15550. if (expect_100_continue) {
  15551. if (res.status == StatusCode::Continue_100) {
  15552. // Server accepted, send the body
  15553. if (!write_request_body(strm, req, error)) { return false; }
  15554. // Read the actual response
  15555. res.headers.clear();
  15556. res.body.clear();
  15557. if (!read_response_line(strm, req, res) ||
  15558. !detail::read_headers(strm, res.headers)) {
  15559. error = Error::Read;
  15560. return false;
  15561. }
  15562. } else {
  15563. // A final response came first, so the body this request declared was
  15564. // never sent, and the server may still be waiting for it. The
  15565. // connection cannot carry another request.
  15566. std::lock_guard<std::mutex> guard(socket_mutex_);
  15567. socket_should_be_closed_when_request_is_done_ = true;
  15568. }
  15569. }
  15570. // Body
  15571. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  15572. req.method != "CONNECT") {
  15573. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  15574. // whose final transfer coding is not chunked is not ambiguous: its body
  15575. // runs until the server closes the connection, so it is not rejected.
  15576. // HEAD/204 are excluded above and a 304 carries no body.
  15577. if (res.status != StatusCode::NotModified_304) {
  15578. if (detail::has_conflicting_content_length(res.headers)) {
  15579. error = Error::Read;
  15580. return false;
  15581. }
  15582. if (detail::has_faulty_transfer_encoding(res)) {
  15583. std::lock_guard<std::mutex> guard(socket_mutex_);
  15584. socket_should_be_closed_when_request_is_done_ = true;
  15585. }
  15586. }
  15587. auto redirect = follow_location_ && detail::is_redirect(res);
  15588. if (req.response_handler && !redirect) {
  15589. if (!req.response_handler(res)) {
  15590. error = Error::Canceled;
  15591. return false;
  15592. }
  15593. }
  15594. auto out =
  15595. req.content_receiver
  15596. ? static_cast<ContentReceiverWithProgress>(
  15597. [&](const char *buf, size_t n, size_t off, size_t len) {
  15598. if (redirect) { return true; }
  15599. auto ret = req.content_receiver(buf, n, off, len);
  15600. if (!ret) { error = Error::Canceled; }
  15601. return ret;
  15602. })
  15603. : static_cast<ContentReceiverWithProgress>(
  15604. [&](const char *buf, size_t n, size_t /*off*/,
  15605. size_t /*len*/) {
  15606. assert(res.body.size() + n <= res.body.max_size());
  15607. if (payload_max_length_ > 0 &&
  15608. (res.body.size() >= payload_max_length_ ||
  15609. n > payload_max_length_ - res.body.size())) {
  15610. return false;
  15611. }
  15612. res.body.append(buf, n);
  15613. return true;
  15614. });
  15615. auto progress = [&](size_t current, size_t total) {
  15616. if (!req.download_progress || redirect) { return true; }
  15617. auto ret = req.download_progress(current, total);
  15618. if (!ret) { error = Error::Canceled; }
  15619. return ret;
  15620. };
  15621. if (res.has_header("Content-Length")) {
  15622. if (!req.content_receiver) {
  15623. auto len = res.get_header_value_u64("Content-Length");
  15624. if (len > res.body.max_size()) {
  15625. error = Error::Read;
  15626. return false;
  15627. }
  15628. // Content-Length is only the server's claim, so reserve no more than
  15629. // payload_max_length_ allows, nor more than 1 MiB before any of the
  15630. // body has arrived. A longer body grows as it is read.
  15631. auto reserve_len =
  15632. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  15633. if (payload_max_length_ > 0) {
  15634. reserve_len = (std::min)(reserve_len, payload_max_length_);
  15635. }
  15636. res.body.reserve(reserve_len);
  15637. }
  15638. }
  15639. if (res.status != StatusCode::NotModified_304) {
  15640. auto content_status = 0;
  15641. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  15642. ? (std::numeric_limits<size_t>::max)()
  15643. : payload_max_length_;
  15644. if (!detail::read_content(strm, res, max_length, content_status,
  15645. std::move(progress), std::move(out),
  15646. decompress_)) {
  15647. if (error != Error::Canceled) {
  15648. // Tell the caller apart from a plain read failure when the body was
  15649. // over the payload limit or could not be decoded because of its
  15650. // Content-Encoding.
  15651. switch (content_status) {
  15652. case StatusCode::PayloadTooLarge_413:
  15653. error = Error::ExceedMaxPayloadSize;
  15654. break;
  15655. case StatusCode::UnsupportedMediaType_415:
  15656. error = Error::UnsupportedContentEncoding;
  15657. break;
  15658. case StatusCode::InternalServerError_500:
  15659. error = Error::Compression;
  15660. break;
  15661. default: error = Error::Read; break;
  15662. }
  15663. }
  15664. return false;
  15665. }
  15666. }
  15667. }
  15668. // Log
  15669. output_log(req, res);
  15670. return true;
  15671. }
  15672. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  15673. const std::string &boundary, const UploadFormDataItems &items,
  15674. const FormDataProviderItems &provider_items) const {
  15675. size_t cur_item = 0;
  15676. size_t cur_start = 0;
  15677. // cur_item and cur_start are copied to within the std::function and
  15678. // maintain state between successive calls
  15679. return [&, cur_item, cur_start](size_t offset,
  15680. DataSink &sink) mutable -> bool {
  15681. if (!offset && !items.empty()) {
  15682. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  15683. return true;
  15684. } else if (cur_item < provider_items.size()) {
  15685. if (!cur_start) {
  15686. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  15687. provider_items[cur_item], boundary);
  15688. offset += begin.size();
  15689. cur_start = offset;
  15690. sink.os << begin;
  15691. }
  15692. DataSink cur_sink;
  15693. auto has_data = true;
  15694. cur_sink.write = sink.write;
  15695. // Forward is_writable so a provider item asking whether it may keep
  15696. // going gets the outer sink's answer rather than the default `true`.
  15697. cur_sink.is_writable = sink.is_writable;
  15698. cur_sink.done = [&]() { has_data = false; };
  15699. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  15700. return false;
  15701. }
  15702. if (!has_data) {
  15703. sink.os << detail::serialize_multipart_formdata_item_end();
  15704. cur_item++;
  15705. cur_start = 0;
  15706. }
  15707. return true;
  15708. } else {
  15709. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  15710. sink.done();
  15711. return true;
  15712. }
  15713. };
  15714. }
  15715. inline bool ClientImpl::process_socket(
  15716. const Socket &socket,
  15717. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15718. std::function<bool(Stream &strm)> callback) {
  15719. return detail::process_client_socket(
  15720. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  15721. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  15722. }
  15723. inline bool ClientImpl::is_ssl() const { return false; }
  15724. inline Result ClientImpl::Get(const std::string &path,
  15725. DownloadProgress progress) {
  15726. return Get(path, Headers(), std::move(progress));
  15727. }
  15728. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  15729. DownloadProgress progress) {
  15730. return Get(path, params, Headers(), std::move(progress));
  15731. }
  15732. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  15733. const Headers &headers,
  15734. DownloadProgress progress) {
  15735. if (params.empty()) { return Get(path, headers); }
  15736. std::string path_with_query = append_query_params(path, params);
  15737. return Get(path_with_query, headers, std::move(progress));
  15738. }
  15739. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  15740. DownloadProgress progress) {
  15741. Request req;
  15742. req.method = "GET";
  15743. req.path = path;
  15744. req.headers = headers;
  15745. req.download_progress = std::move(progress);
  15746. if (max_timeout_msec_ > 0) {
  15747. req.start_time_ = std::chrono::steady_clock::now();
  15748. }
  15749. return send_(std::move(req));
  15750. }
  15751. inline Result ClientImpl::Get(const std::string &path,
  15752. ContentReceiver content_receiver,
  15753. DownloadProgress progress) {
  15754. return Get(path, Headers(), nullptr, std::move(content_receiver),
  15755. std::move(progress));
  15756. }
  15757. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  15758. ContentReceiver content_receiver,
  15759. DownloadProgress progress) {
  15760. return Get(path, headers, nullptr, std::move(content_receiver),
  15761. std::move(progress));
  15762. }
  15763. inline Result ClientImpl::Get(const std::string &path,
  15764. ResponseHandler response_handler,
  15765. ContentReceiver content_receiver,
  15766. DownloadProgress progress) {
  15767. return Get(path, Headers(), std::move(response_handler),
  15768. std::move(content_receiver), std::move(progress));
  15769. }
  15770. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  15771. ResponseHandler response_handler,
  15772. ContentReceiver content_receiver,
  15773. DownloadProgress progress) {
  15774. Request req;
  15775. req.method = "GET";
  15776. req.path = path;
  15777. req.headers = headers;
  15778. req.response_handler = std::move(response_handler);
  15779. req.content_receiver =
  15780. [content_receiver](const char *data, size_t data_length,
  15781. size_t /*offset*/, size_t /*total_length*/) {
  15782. return content_receiver(data, data_length);
  15783. };
  15784. req.download_progress = std::move(progress);
  15785. if (max_timeout_msec_ > 0) {
  15786. req.start_time_ = std::chrono::steady_clock::now();
  15787. }
  15788. return send_(std::move(req));
  15789. }
  15790. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  15791. const Headers &headers,
  15792. ContentReceiver content_receiver,
  15793. DownloadProgress progress) {
  15794. return Get(path, params, headers, nullptr, std::move(content_receiver),
  15795. std::move(progress));
  15796. }
  15797. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  15798. const Headers &headers,
  15799. ResponseHandler response_handler,
  15800. ContentReceiver content_receiver,
  15801. DownloadProgress progress) {
  15802. if (params.empty()) {
  15803. return Get(path, headers, std::move(response_handler),
  15804. std::move(content_receiver), std::move(progress));
  15805. }
  15806. std::string path_with_query = append_query_params(path, params);
  15807. return Get(path_with_query, headers, std::move(response_handler),
  15808. std::move(content_receiver), std::move(progress));
  15809. }
  15810. inline Result ClientImpl::Head(const std::string &path) {
  15811. return Head(path, Headers());
  15812. }
  15813. inline Result ClientImpl::Head(const std::string &path,
  15814. const Headers &headers) {
  15815. Request req;
  15816. req.method = "HEAD";
  15817. req.headers = headers;
  15818. req.path = path;
  15819. if (max_timeout_msec_ > 0) {
  15820. req.start_time_ = std::chrono::steady_clock::now();
  15821. }
  15822. return send_(std::move(req));
  15823. }
  15824. inline Result ClientImpl::Post(const std::string &path) {
  15825. return Post(path, std::string(), std::string());
  15826. }
  15827. inline Result ClientImpl::Post(const std::string &path,
  15828. const Headers &headers) {
  15829. return Post(path, headers, nullptr, 0, std::string());
  15830. }
  15831. inline Result ClientImpl::Post(const std::string &path, const char *body,
  15832. size_t content_length,
  15833. const std::string &content_type,
  15834. UploadProgress progress) {
  15835. return Post(path, Headers(), body, content_length, content_type, progress);
  15836. }
  15837. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  15838. const std::string &content_type,
  15839. UploadProgress progress) {
  15840. return Post(path, Headers(), body, content_type, progress);
  15841. }
  15842. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  15843. return Post(path, Headers(), params);
  15844. }
  15845. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  15846. ContentProvider content_provider,
  15847. const std::string &content_type,
  15848. UploadProgress progress) {
  15849. return Post(path, Headers(), content_length, std::move(content_provider),
  15850. content_type, progress);
  15851. }
  15852. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  15853. ContentProvider content_provider,
  15854. const std::string &content_type,
  15855. ContentReceiver content_receiver,
  15856. UploadProgress progress) {
  15857. return Post(path, Headers(), content_length, std::move(content_provider),
  15858. content_type, std::move(content_receiver), progress);
  15859. }
  15860. inline Result ClientImpl::Post(const std::string &path,
  15861. ContentProviderWithoutLength content_provider,
  15862. const std::string &content_type,
  15863. UploadProgress progress) {
  15864. return Post(path, Headers(), std::move(content_provider), content_type,
  15865. progress);
  15866. }
  15867. inline Result ClientImpl::Post(const std::string &path,
  15868. ContentProviderWithoutLength content_provider,
  15869. const std::string &content_type,
  15870. ContentReceiver content_receiver,
  15871. UploadProgress progress) {
  15872. return Post(path, Headers(), std::move(content_provider), content_type,
  15873. std::move(content_receiver), progress);
  15874. }
  15875. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15876. const Params &params) {
  15877. auto query = detail::params_to_query_str(params);
  15878. return Post(path, headers, query, "application/x-www-form-urlencoded");
  15879. }
  15880. inline Result ClientImpl::Post(const std::string &path,
  15881. const UploadFormDataItems &items,
  15882. UploadProgress progress) {
  15883. return Post(path, Headers(), items, progress);
  15884. }
  15885. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15886. const UploadFormDataItems &items,
  15887. UploadProgress progress) {
  15888. const auto &boundary = detail::make_multipart_data_boundary();
  15889. const auto &content_type =
  15890. detail::serialize_multipart_formdata_get_content_type(boundary);
  15891. auto content_length = detail::get_multipart_content_length(items, boundary);
  15892. return Post(path, headers, content_length,
  15893. detail::make_multipart_content_provider(items, boundary),
  15894. content_type, progress);
  15895. }
  15896. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15897. const UploadFormDataItems &items,
  15898. const std::string &boundary,
  15899. UploadProgress progress) {
  15900. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15901. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15902. }
  15903. const auto &content_type =
  15904. detail::serialize_multipart_formdata_get_content_type(boundary);
  15905. auto content_length = detail::get_multipart_content_length(items, boundary);
  15906. return Post(path, headers, content_length,
  15907. detail::make_multipart_content_provider(items, boundary),
  15908. content_type, progress);
  15909. }
  15910. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15911. const char *body, size_t content_length,
  15912. const std::string &content_type,
  15913. UploadProgress progress) {
  15914. return send_with_content_provider_and_receiver(
  15915. "POST", path, headers, body, content_length, nullptr, nullptr,
  15916. content_type, nullptr, progress);
  15917. }
  15918. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15919. const std::string &body,
  15920. const std::string &content_type,
  15921. UploadProgress progress) {
  15922. return send_with_content_provider_and_receiver(
  15923. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  15924. content_type, nullptr, progress);
  15925. }
  15926. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15927. size_t content_length,
  15928. ContentProvider content_provider,
  15929. const std::string &content_type,
  15930. UploadProgress progress) {
  15931. return send_with_content_provider_and_receiver(
  15932. "POST", path, headers, nullptr, content_length,
  15933. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15934. }
  15935. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15936. size_t content_length,
  15937. ContentProvider content_provider,
  15938. const std::string &content_type,
  15939. ContentReceiver content_receiver,
  15940. DownloadProgress progress) {
  15941. return send_with_content_provider_and_receiver(
  15942. "POST", path, headers, nullptr, content_length,
  15943. std::move(content_provider), nullptr, content_type,
  15944. std::move(content_receiver), std::move(progress));
  15945. }
  15946. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15947. ContentProviderWithoutLength content_provider,
  15948. const std::string &content_type,
  15949. UploadProgress progress) {
  15950. return send_with_content_provider_and_receiver(
  15951. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15952. content_type, nullptr, progress);
  15953. }
  15954. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15955. ContentProviderWithoutLength content_provider,
  15956. const std::string &content_type,
  15957. ContentReceiver content_receiver,
  15958. DownloadProgress progress) {
  15959. return send_with_content_provider_and_receiver(
  15960. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15961. content_type, std::move(content_receiver), std::move(progress));
  15962. }
  15963. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15964. const UploadFormDataItems &items,
  15965. const FormDataProviderItems &provider_items,
  15966. UploadProgress progress) {
  15967. const auto &boundary = detail::make_multipart_data_boundary();
  15968. const auto &content_type =
  15969. detail::serialize_multipart_formdata_get_content_type(boundary);
  15970. return send_with_content_provider_and_receiver(
  15971. "POST", path, headers, nullptr, 0, nullptr,
  15972. get_multipart_content_provider(boundary, items, provider_items),
  15973. content_type, nullptr, progress);
  15974. }
  15975. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15976. const std::string &body,
  15977. const std::string &content_type,
  15978. ContentReceiver content_receiver,
  15979. DownloadProgress progress) {
  15980. Request req;
  15981. req.method = "POST";
  15982. req.path = path;
  15983. req.headers = headers;
  15984. req.body = body;
  15985. req.content_receiver =
  15986. [content_receiver](const char *data, size_t data_length,
  15987. size_t /*offset*/, size_t /*total_length*/) {
  15988. return content_receiver(data, data_length);
  15989. };
  15990. req.download_progress = std::move(progress);
  15991. if (max_timeout_msec_ > 0) {
  15992. req.start_time_ = std::chrono::steady_clock::now();
  15993. }
  15994. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15995. return send_(std::move(req));
  15996. }
  15997. inline Result ClientImpl::Put(const std::string &path) {
  15998. return Put(path, std::string(), std::string());
  15999. }
  16000. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  16001. return Put(path, headers, nullptr, 0, std::string());
  16002. }
  16003. inline Result ClientImpl::Put(const std::string &path, const char *body,
  16004. size_t content_length,
  16005. const std::string &content_type,
  16006. UploadProgress progress) {
  16007. return Put(path, Headers(), body, content_length, content_type, progress);
  16008. }
  16009. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  16010. const std::string &content_type,
  16011. UploadProgress progress) {
  16012. return Put(path, Headers(), body, content_type, progress);
  16013. }
  16014. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  16015. return Put(path, Headers(), params);
  16016. }
  16017. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  16018. ContentProvider content_provider,
  16019. const std::string &content_type,
  16020. UploadProgress progress) {
  16021. return Put(path, Headers(), content_length, std::move(content_provider),
  16022. content_type, progress);
  16023. }
  16024. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  16025. ContentProvider content_provider,
  16026. const std::string &content_type,
  16027. ContentReceiver content_receiver,
  16028. UploadProgress progress) {
  16029. return Put(path, Headers(), content_length, std::move(content_provider),
  16030. content_type, std::move(content_receiver), progress);
  16031. }
  16032. inline Result ClientImpl::Put(const std::string &path,
  16033. ContentProviderWithoutLength content_provider,
  16034. const std::string &content_type,
  16035. UploadProgress progress) {
  16036. return Put(path, Headers(), std::move(content_provider), content_type,
  16037. progress);
  16038. }
  16039. inline Result ClientImpl::Put(const std::string &path,
  16040. ContentProviderWithoutLength content_provider,
  16041. const std::string &content_type,
  16042. ContentReceiver content_receiver,
  16043. UploadProgress progress) {
  16044. return Put(path, Headers(), std::move(content_provider), content_type,
  16045. std::move(content_receiver), progress);
  16046. }
  16047. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  16048. const Params &params) {
  16049. auto query = detail::params_to_query_str(params);
  16050. return Put(path, headers, query, "application/x-www-form-urlencoded");
  16051. }
  16052. inline Result ClientImpl::Put(const std::string &path,
  16053. const UploadFormDataItems &items,
  16054. UploadProgress progress) {
  16055. return Put(path, Headers(), items, progress);
  16056. }
  16057. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  16058. const UploadFormDataItems &items,
  16059. UploadProgress progress) {
  16060. const auto &boundary = detail::make_multipart_data_boundary();
  16061. const auto &content_type =
  16062. detail::serialize_multipart_formdata_get_content_type(boundary);
  16063. auto content_length = detail::get_multipart_content_length(items, boundary);
  16064. return Put(path, headers, content_length,
  16065. detail::make_multipart_content_provider(items, boundary),
  16066. content_type, progress);
  16067. }
  16068. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  16069. const UploadFormDataItems &items,
  16070. const std::string &boundary,
  16071. UploadProgress progress) {
  16072. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  16073. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  16074. }
  16075. const auto &content_type =
  16076. detail::serialize_multipart_formdata_get_content_type(boundary);
  16077. auto content_length = detail::get_multipart_content_length(items, boundary);
  16078. return Put(path, headers, content_length,
  16079. detail::make_multipart_content_provider(items, boundary),
  16080. content_type, progress);
  16081. }
  16082. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  16083. const char *body, size_t content_length,
  16084. const std::string &content_type,
  16085. UploadProgress progress) {
  16086. return send_with_content_provider_and_receiver(
  16087. "PUT", path, headers, body, content_length, nullptr, nullptr,
  16088. content_type, nullptr, progress);
  16089. }
  16090. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  16091. const std::string &body,
  16092. const std::string &content_type,
  16093. UploadProgress progress) {
  16094. return send_with_content_provider_and_receiver(
  16095. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  16096. content_type, nullptr, progress);
  16097. }
  16098. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  16099. size_t content_length,
  16100. ContentProvider content_provider,
  16101. const std::string &content_type,
  16102. UploadProgress progress) {
  16103. return send_with_content_provider_and_receiver(
  16104. "PUT", path, headers, nullptr, content_length,
  16105. std::move(content_provider), nullptr, content_type, nullptr, progress);
  16106. }
  16107. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  16108. size_t content_length,
  16109. ContentProvider content_provider,
  16110. const std::string &content_type,
  16111. ContentReceiver content_receiver,
  16112. UploadProgress progress) {
  16113. return send_with_content_provider_and_receiver(
  16114. "PUT", path, headers, nullptr, content_length,
  16115. std::move(content_provider), nullptr, content_type,
  16116. std::move(content_receiver), progress);
  16117. }
  16118. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  16119. ContentProviderWithoutLength content_provider,
  16120. const std::string &content_type,
  16121. UploadProgress progress) {
  16122. return send_with_content_provider_and_receiver(
  16123. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  16124. content_type, nullptr, progress);
  16125. }
  16126. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  16127. ContentProviderWithoutLength content_provider,
  16128. const std::string &content_type,
  16129. ContentReceiver content_receiver,
  16130. UploadProgress progress) {
  16131. return send_with_content_provider_and_receiver(
  16132. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  16133. content_type, std::move(content_receiver), progress);
  16134. }
  16135. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  16136. const UploadFormDataItems &items,
  16137. const FormDataProviderItems &provider_items,
  16138. UploadProgress progress) {
  16139. const auto &boundary = detail::make_multipart_data_boundary();
  16140. const auto &content_type =
  16141. detail::serialize_multipart_formdata_get_content_type(boundary);
  16142. return send_with_content_provider_and_receiver(
  16143. "PUT", path, headers, nullptr, 0, nullptr,
  16144. get_multipart_content_provider(boundary, items, provider_items),
  16145. content_type, nullptr, progress);
  16146. }
  16147. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  16148. const std::string &body,
  16149. const std::string &content_type,
  16150. ContentReceiver content_receiver,
  16151. DownloadProgress progress) {
  16152. Request req;
  16153. req.method = "PUT";
  16154. req.path = path;
  16155. req.headers = headers;
  16156. req.body = body;
  16157. req.content_receiver =
  16158. [content_receiver](const char *data, size_t data_length,
  16159. size_t /*offset*/, size_t /*total_length*/) {
  16160. return content_receiver(data, data_length);
  16161. };
  16162. req.download_progress = std::move(progress);
  16163. if (max_timeout_msec_ > 0) {
  16164. req.start_time_ = std::chrono::steady_clock::now();
  16165. }
  16166. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  16167. return send_(std::move(req));
  16168. }
  16169. inline Result ClientImpl::Patch(const std::string &path) {
  16170. return Patch(path, std::string(), std::string());
  16171. }
  16172. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  16173. UploadProgress progress) {
  16174. return Patch(path, headers, nullptr, 0, std::string(), progress);
  16175. }
  16176. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  16177. size_t content_length,
  16178. const std::string &content_type,
  16179. UploadProgress progress) {
  16180. return Patch(path, Headers(), body, content_length, content_type, progress);
  16181. }
  16182. inline Result ClientImpl::Patch(const std::string &path,
  16183. const std::string &body,
  16184. const std::string &content_type,
  16185. UploadProgress progress) {
  16186. return Patch(path, Headers(), body, content_type, progress);
  16187. }
  16188. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  16189. return Patch(path, Headers(), params);
  16190. }
  16191. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  16192. ContentProvider content_provider,
  16193. const std::string &content_type,
  16194. UploadProgress progress) {
  16195. return Patch(path, Headers(), content_length, std::move(content_provider),
  16196. content_type, progress);
  16197. }
  16198. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  16199. ContentProvider content_provider,
  16200. const std::string &content_type,
  16201. ContentReceiver content_receiver,
  16202. UploadProgress progress) {
  16203. return Patch(path, Headers(), content_length, std::move(content_provider),
  16204. content_type, std::move(content_receiver), progress);
  16205. }
  16206. inline Result ClientImpl::Patch(const std::string &path,
  16207. ContentProviderWithoutLength content_provider,
  16208. const std::string &content_type,
  16209. UploadProgress progress) {
  16210. return Patch(path, Headers(), std::move(content_provider), content_type,
  16211. progress);
  16212. }
  16213. inline Result ClientImpl::Patch(const std::string &path,
  16214. ContentProviderWithoutLength content_provider,
  16215. const std::string &content_type,
  16216. ContentReceiver content_receiver,
  16217. UploadProgress progress) {
  16218. return Patch(path, Headers(), std::move(content_provider), content_type,
  16219. std::move(content_receiver), progress);
  16220. }
  16221. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  16222. const Params &params) {
  16223. auto query = detail::params_to_query_str(params);
  16224. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  16225. }
  16226. inline Result ClientImpl::Patch(const std::string &path,
  16227. const UploadFormDataItems &items,
  16228. UploadProgress progress) {
  16229. return Patch(path, Headers(), items, progress);
  16230. }
  16231. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  16232. const UploadFormDataItems &items,
  16233. UploadProgress progress) {
  16234. const auto &boundary = detail::make_multipart_data_boundary();
  16235. const auto &content_type =
  16236. detail::serialize_multipart_formdata_get_content_type(boundary);
  16237. auto content_length = detail::get_multipart_content_length(items, boundary);
  16238. return Patch(path, headers, content_length,
  16239. detail::make_multipart_content_provider(items, boundary),
  16240. content_type, progress);
  16241. }
  16242. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  16243. const UploadFormDataItems &items,
  16244. const std::string &boundary,
  16245. UploadProgress progress) {
  16246. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  16247. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  16248. }
  16249. const auto &content_type =
  16250. detail::serialize_multipart_formdata_get_content_type(boundary);
  16251. auto content_length = detail::get_multipart_content_length(items, boundary);
  16252. return Patch(path, headers, content_length,
  16253. detail::make_multipart_content_provider(items, boundary),
  16254. content_type, progress);
  16255. }
  16256. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  16257. const char *body, size_t content_length,
  16258. const std::string &content_type,
  16259. UploadProgress progress) {
  16260. return send_with_content_provider_and_receiver(
  16261. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  16262. content_type, nullptr, progress);
  16263. }
  16264. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  16265. const std::string &body,
  16266. const std::string &content_type,
  16267. UploadProgress progress) {
  16268. return send_with_content_provider_and_receiver(
  16269. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  16270. content_type, nullptr, progress);
  16271. }
  16272. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  16273. size_t content_length,
  16274. ContentProvider content_provider,
  16275. const std::string &content_type,
  16276. UploadProgress progress) {
  16277. return send_with_content_provider_and_receiver(
  16278. "PATCH", path, headers, nullptr, content_length,
  16279. std::move(content_provider), nullptr, content_type, nullptr, progress);
  16280. }
  16281. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  16282. size_t content_length,
  16283. ContentProvider content_provider,
  16284. const std::string &content_type,
  16285. ContentReceiver content_receiver,
  16286. UploadProgress progress) {
  16287. return send_with_content_provider_and_receiver(
  16288. "PATCH", path, headers, nullptr, content_length,
  16289. std::move(content_provider), nullptr, content_type,
  16290. std::move(content_receiver), progress);
  16291. }
  16292. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  16293. ContentProviderWithoutLength content_provider,
  16294. const std::string &content_type,
  16295. UploadProgress progress) {
  16296. return send_with_content_provider_and_receiver(
  16297. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  16298. content_type, nullptr, progress);
  16299. }
  16300. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  16301. ContentProviderWithoutLength content_provider,
  16302. const std::string &content_type,
  16303. ContentReceiver content_receiver,
  16304. UploadProgress progress) {
  16305. return send_with_content_provider_and_receiver(
  16306. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  16307. content_type, std::move(content_receiver), progress);
  16308. }
  16309. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  16310. const UploadFormDataItems &items,
  16311. const FormDataProviderItems &provider_items,
  16312. UploadProgress progress) {
  16313. const auto &boundary = detail::make_multipart_data_boundary();
  16314. const auto &content_type =
  16315. detail::serialize_multipart_formdata_get_content_type(boundary);
  16316. return send_with_content_provider_and_receiver(
  16317. "PATCH", path, headers, nullptr, 0, nullptr,
  16318. get_multipart_content_provider(boundary, items, provider_items),
  16319. content_type, nullptr, progress);
  16320. }
  16321. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  16322. const std::string &body,
  16323. const std::string &content_type,
  16324. ContentReceiver content_receiver,
  16325. DownloadProgress progress) {
  16326. Request req;
  16327. req.method = "PATCH";
  16328. req.path = path;
  16329. req.headers = headers;
  16330. req.body = body;
  16331. req.content_receiver =
  16332. [content_receiver](const char *data, size_t data_length,
  16333. size_t /*offset*/, size_t /*total_length*/) {
  16334. return content_receiver(data, data_length);
  16335. };
  16336. req.download_progress = std::move(progress);
  16337. if (max_timeout_msec_ > 0) {
  16338. req.start_time_ = std::chrono::steady_clock::now();
  16339. }
  16340. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  16341. return send_(std::move(req));
  16342. }
  16343. inline Result ClientImpl::Delete(const std::string &path,
  16344. DownloadProgress progress) {
  16345. return Delete(path, Headers(), std::string(), std::string(), progress);
  16346. }
  16347. inline Result ClientImpl::Delete(const std::string &path,
  16348. const Headers &headers,
  16349. DownloadProgress progress) {
  16350. return Delete(path, headers, std::string(), std::string(), progress);
  16351. }
  16352. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  16353. size_t content_length,
  16354. const std::string &content_type,
  16355. DownloadProgress progress) {
  16356. return Delete(path, Headers(), body, content_length, content_type, progress);
  16357. }
  16358. inline Result ClientImpl::Delete(const std::string &path,
  16359. const std::string &body,
  16360. const std::string &content_type,
  16361. DownloadProgress progress) {
  16362. return Delete(path, Headers(), body.data(), body.size(), content_type,
  16363. progress);
  16364. }
  16365. inline Result ClientImpl::Delete(const std::string &path,
  16366. const Headers &headers,
  16367. const std::string &body,
  16368. const std::string &content_type,
  16369. DownloadProgress progress) {
  16370. return Delete(path, headers, body.data(), body.size(), content_type,
  16371. progress);
  16372. }
  16373. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  16374. DownloadProgress progress) {
  16375. return Delete(path, Headers(), params, progress);
  16376. }
  16377. inline Result ClientImpl::Delete(const std::string &path,
  16378. const Headers &headers, const Params &params,
  16379. DownloadProgress progress) {
  16380. auto query = detail::params_to_query_str(params);
  16381. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  16382. progress);
  16383. }
  16384. inline Result ClientImpl::Delete(const std::string &path,
  16385. const Headers &headers, const char *body,
  16386. size_t content_length,
  16387. const std::string &content_type,
  16388. DownloadProgress progress) {
  16389. Request req;
  16390. req.method = "DELETE";
  16391. req.headers = headers;
  16392. req.path = path;
  16393. req.download_progress = std::move(progress);
  16394. if (max_timeout_msec_ > 0) {
  16395. req.start_time_ = std::chrono::steady_clock::now();
  16396. }
  16397. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  16398. req.body.assign(body, content_length);
  16399. return send_(std::move(req));
  16400. }
  16401. inline Result ClientImpl::Options(const std::string &path) {
  16402. return Options(path, Headers());
  16403. }
  16404. inline Result ClientImpl::Options(const std::string &path,
  16405. const Headers &headers) {
  16406. Request req;
  16407. req.method = "OPTIONS";
  16408. req.headers = headers;
  16409. req.path = path;
  16410. if (max_timeout_msec_ > 0) {
  16411. req.start_time_ = std::chrono::steady_clock::now();
  16412. }
  16413. return send_(std::move(req));
  16414. }
  16415. inline void ClientImpl::stop() {
  16416. std::lock_guard<std::mutex> guard(socket_mutex_);
  16417. stop_requested_ = true;
  16418. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  16419. // do is to shutdown_socket, so that threads using this socket suddenly
  16420. // discover they can't read/write any more and error out. Everything else
  16421. // (closing the socket, shutting ssl down) is unsafe because these actions
  16422. // are not thread-safe.
  16423. if (socket_requests_in_flight_ > 0) {
  16424. shutdown_socket(socket_);
  16425. // Aside from that, we set a flag for the socket to be closed when we're
  16426. // done.
  16427. socket_should_be_closed_when_request_is_done_ = true;
  16428. return;
  16429. }
  16430. disconnect(/*gracefully=*/true);
  16431. }
  16432. inline std::string ClientImpl::host() const { return host_; }
  16433. inline int ClientImpl::port() const { return port_; }
  16434. inline size_t ClientImpl::is_socket_open() const {
  16435. std::lock_guard<std::mutex> guard(socket_mutex_);
  16436. return socket_.is_open();
  16437. }
  16438. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  16439. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  16440. connection_timeout_sec_ = sec;
  16441. connection_timeout_usec_ = usec;
  16442. }
  16443. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  16444. read_timeout_sec_ = sec;
  16445. read_timeout_usec_ = usec;
  16446. }
  16447. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  16448. write_timeout_sec_ = sec;
  16449. write_timeout_usec_ = usec;
  16450. }
  16451. inline void ClientImpl::set_max_timeout(time_t msec) {
  16452. max_timeout_msec_ = msec;
  16453. }
  16454. inline void ClientImpl::set_basic_auth(const std::string &username,
  16455. const std::string &password) {
  16456. basic_auth_username_ = username;
  16457. basic_auth_password_ = password;
  16458. }
  16459. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  16460. bearer_token_auth_token_ = token;
  16461. }
  16462. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  16463. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  16464. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  16465. inline void
  16466. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  16467. set_direct_hostname_addr_map(std::move(addr_map));
  16468. }
  16469. inline void ClientImpl::set_direct_hostname_addr_map(
  16470. std::map<std::string, std::string> addr_map) {
  16471. addr_map_ = std::move(addr_map);
  16472. }
  16473. inline void ClientImpl::set_tunnel_hostname_addr_map(
  16474. std::map<std::string, std::string> addr_map) {
  16475. tunnel_addr_map_ = std::move(addr_map);
  16476. }
  16477. inline void ClientImpl::set_default_headers(Headers headers) {
  16478. default_headers_ = std::move(headers);
  16479. }
  16480. inline void ClientImpl::set_header_writer(
  16481. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16482. header_writer_ = writer;
  16483. }
  16484. inline void ClientImpl::set_address_family(int family) {
  16485. address_family_ = family;
  16486. }
  16487. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  16488. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  16489. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  16490. socket_options_ = std::move(socket_options);
  16491. }
  16492. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  16493. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  16494. inline void ClientImpl::set_payload_max_length(size_t length) {
  16495. payload_max_length_ = length;
  16496. has_payload_max_length_ = true;
  16497. }
  16498. inline void ClientImpl::set_interface(const std::string &intf) {
  16499. interface_ = intf;
  16500. }
  16501. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  16502. proxy_host_ = host;
  16503. proxy_port_ = port;
  16504. std::lock_guard<std::mutex> guard(socket_mutex_);
  16505. disconnect(/*gracefully=*/true);
  16506. }
  16507. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  16508. const std::string &password) {
  16509. proxy_basic_auth_username_ = username;
  16510. proxy_basic_auth_password_ = password;
  16511. }
  16512. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  16513. proxy_bearer_token_auth_token_ = token;
  16514. }
  16515. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  16516. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  16517. std::lock_guard<std::mutex> guard(socket_mutex_);
  16518. disconnect(/*gracefully=*/true);
  16519. }
  16520. #ifdef CPPHTTPLIB_SSL_ENABLED
  16521. inline void ClientImpl::set_digest_auth(const std::string &username,
  16522. const std::string &password) {
  16523. digest_auth_username_ = username;
  16524. digest_auth_password_ = password;
  16525. }
  16526. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  16527. const std::string &ca_cert_dir_path) {
  16528. ca_cert_file_path_ = ca_cert_file_path;
  16529. ca_cert_dir_path_ = ca_cert_dir_path;
  16530. }
  16531. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  16532. const std::string &password) {
  16533. proxy_digest_auth_username_ = username;
  16534. proxy_digest_auth_password_ = password;
  16535. }
  16536. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  16537. if (server_certificate_verification_ == enabled) { return; }
  16538. server_certificate_verification_ = enabled;
  16539. tls_settings_changed();
  16540. }
  16541. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  16542. if (server_hostname_verification_ == enabled) { return; }
  16543. server_hostname_verification_ = enabled;
  16544. tls_settings_changed();
  16545. }
  16546. inline void ClientImpl::enable_system_ca(bool enabled) {
  16547. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  16548. }
  16549. #endif
  16550. inline void ClientImpl::set_logger(Logger logger) {
  16551. logger_ = std::move(logger);
  16552. }
  16553. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  16554. error_logger_ = std::move(error_logger);
  16555. }
  16556. /*
  16557. * SSL/TLS Common Implementation
  16558. */
  16559. inline ClientConnection::~ClientConnection() {
  16560. #ifdef CPPHTTPLIB_SSL_ENABLED
  16561. if (session) {
  16562. tls::shutdown(session, true);
  16563. tls::free_session(session);
  16564. session = nullptr;
  16565. }
  16566. #endif
  16567. if (sock != INVALID_SOCKET) {
  16568. detail::close_socket(sock);
  16569. sock = INVALID_SOCKET;
  16570. }
  16571. }
  16572. // Universal client implementation
  16573. inline Client::Client(const std::string &scheme_host_port)
  16574. : Client(scheme_host_port, std::string(), std::string()) {}
  16575. inline Client::Client(const std::string &scheme_host_port,
  16576. const std::string &client_cert_path,
  16577. const std::string &client_key_path) {
  16578. detail::UrlComponents uc;
  16579. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  16580. auto &scheme = uc.scheme;
  16581. #ifdef CPPHTTPLIB_SSL_ENABLED
  16582. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  16583. #else
  16584. if (!scheme.empty() && scheme != "http") {
  16585. #endif
  16586. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  16587. std::string msg = "'" + scheme + "' scheme is not supported.";
  16588. throw std::invalid_argument(msg);
  16589. #endif
  16590. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  16591. return;
  16592. }
  16593. auto is_ssl = scheme == "https";
  16594. auto host = std::move(uc.host);
  16595. auto port = is_ssl ? 443 : 80;
  16596. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  16597. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  16598. return;
  16599. }
  16600. if (is_ssl) {
  16601. #ifdef CPPHTTPLIB_SSL_ENABLED
  16602. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  16603. client_key_path);
  16604. is_ssl_ = is_ssl;
  16605. #endif
  16606. } else {
  16607. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  16608. client_key_path);
  16609. }
  16610. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  16611. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  16612. // A URL, but not one this client can use, such as one with userinfo. A
  16613. // Unix socket path may have "//" further on.
  16614. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  16615. } else {
  16616. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  16617. // if port param below changes.
  16618. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  16619. client_cert_path, client_key_path);
  16620. }
  16621. }
  16622. inline Client::Client(const std::string &host, int port)
  16623. : Client(host, port, std::string(), std::string()) {}
  16624. inline Client::Client(const std::string &host, int port,
  16625. const std::string &client_cert_path,
  16626. const std::string &client_key_path)
  16627. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  16628. client_key_path)) {}
  16629. inline Client::~Client() = default;
  16630. inline bool Client::is_valid() const {
  16631. return cli_ != nullptr && cli_->is_valid();
  16632. }
  16633. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  16634. return cli_->Get(path, std::move(progress));
  16635. }
  16636. inline Result Client::Get(const std::string &path, const Headers &headers,
  16637. DownloadProgress progress) {
  16638. return cli_->Get(path, headers, std::move(progress));
  16639. }
  16640. inline Result Client::Get(const std::string &path,
  16641. ContentReceiver content_receiver,
  16642. DownloadProgress progress) {
  16643. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  16644. }
  16645. inline Result Client::Get(const std::string &path, const Headers &headers,
  16646. ContentReceiver content_receiver,
  16647. DownloadProgress progress) {
  16648. return cli_->Get(path, headers, std::move(content_receiver),
  16649. std::move(progress));
  16650. }
  16651. inline Result Client::Get(const std::string &path,
  16652. ResponseHandler response_handler,
  16653. ContentReceiver content_receiver,
  16654. DownloadProgress progress) {
  16655. return cli_->Get(path, std::move(response_handler),
  16656. std::move(content_receiver), std::move(progress));
  16657. }
  16658. inline Result Client::Get(const std::string &path, const Headers &headers,
  16659. ResponseHandler response_handler,
  16660. ContentReceiver content_receiver,
  16661. DownloadProgress progress) {
  16662. return cli_->Get(path, headers, std::move(response_handler),
  16663. std::move(content_receiver), std::move(progress));
  16664. }
  16665. inline Result Client::Get(const std::string &path, const Params &params,
  16666. DownloadProgress progress) {
  16667. return cli_->Get(path, params, std::move(progress));
  16668. }
  16669. inline Result Client::Get(const std::string &path, const Params &params,
  16670. const Headers &headers, DownloadProgress progress) {
  16671. return cli_->Get(path, params, headers, std::move(progress));
  16672. }
  16673. inline Result Client::Get(const std::string &path, const Params &params,
  16674. const Headers &headers,
  16675. ContentReceiver content_receiver,
  16676. DownloadProgress progress) {
  16677. return cli_->Get(path, params, headers, std::move(content_receiver),
  16678. std::move(progress));
  16679. }
  16680. inline Result Client::Get(const std::string &path, const Params &params,
  16681. const Headers &headers,
  16682. ResponseHandler response_handler,
  16683. ContentReceiver content_receiver,
  16684. DownloadProgress progress) {
  16685. return cli_->Get(path, params, headers, std::move(response_handler),
  16686. std::move(content_receiver), std::move(progress));
  16687. }
  16688. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  16689. inline Result Client::Head(const std::string &path, const Headers &headers) {
  16690. return cli_->Head(path, headers);
  16691. }
  16692. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  16693. inline Result Client::Post(const std::string &path, const Headers &headers) {
  16694. return cli_->Post(path, headers);
  16695. }
  16696. inline Result Client::Post(const std::string &path, const char *body,
  16697. size_t content_length,
  16698. const std::string &content_type,
  16699. UploadProgress progress) {
  16700. return cli_->Post(path, body, content_length, content_type, progress);
  16701. }
  16702. inline Result Client::Post(const std::string &path, const Headers &headers,
  16703. const char *body, size_t content_length,
  16704. const std::string &content_type,
  16705. UploadProgress progress) {
  16706. return cli_->Post(path, headers, body, content_length, content_type,
  16707. progress);
  16708. }
  16709. inline Result Client::Post(const std::string &path, const std::string &body,
  16710. const std::string &content_type,
  16711. UploadProgress progress) {
  16712. return cli_->Post(path, body, content_type, progress);
  16713. }
  16714. inline Result Client::Post(const std::string &path, const Headers &headers,
  16715. const std::string &body,
  16716. const std::string &content_type,
  16717. UploadProgress progress) {
  16718. return cli_->Post(path, headers, body, content_type, progress);
  16719. }
  16720. inline Result Client::Post(const std::string &path, size_t content_length,
  16721. ContentProvider content_provider,
  16722. const std::string &content_type,
  16723. UploadProgress progress) {
  16724. return cli_->Post(path, content_length, std::move(content_provider),
  16725. content_type, progress);
  16726. }
  16727. inline Result Client::Post(const std::string &path, size_t content_length,
  16728. ContentProvider content_provider,
  16729. const std::string &content_type,
  16730. ContentReceiver content_receiver,
  16731. UploadProgress progress) {
  16732. return cli_->Post(path, content_length, std::move(content_provider),
  16733. content_type, std::move(content_receiver), progress);
  16734. }
  16735. inline Result Client::Post(const std::string &path,
  16736. ContentProviderWithoutLength content_provider,
  16737. const std::string &content_type,
  16738. UploadProgress progress) {
  16739. return cli_->Post(path, std::move(content_provider), content_type, progress);
  16740. }
  16741. inline Result Client::Post(const std::string &path,
  16742. ContentProviderWithoutLength content_provider,
  16743. const std::string &content_type,
  16744. ContentReceiver content_receiver,
  16745. UploadProgress progress) {
  16746. return cli_->Post(path, std::move(content_provider), content_type,
  16747. std::move(content_receiver), progress);
  16748. }
  16749. inline Result Client::Post(const std::string &path, const Headers &headers,
  16750. size_t content_length,
  16751. ContentProvider content_provider,
  16752. const std::string &content_type,
  16753. UploadProgress progress) {
  16754. return cli_->Post(path, headers, content_length, std::move(content_provider),
  16755. content_type, progress);
  16756. }
  16757. inline Result Client::Post(const std::string &path, const Headers &headers,
  16758. size_t content_length,
  16759. ContentProvider content_provider,
  16760. const std::string &content_type,
  16761. ContentReceiver content_receiver,
  16762. DownloadProgress progress) {
  16763. return cli_->Post(path, headers, content_length, std::move(content_provider),
  16764. content_type, std::move(content_receiver), progress);
  16765. }
  16766. inline Result Client::Post(const std::string &path, const Headers &headers,
  16767. ContentProviderWithoutLength content_provider,
  16768. const std::string &content_type,
  16769. UploadProgress progress) {
  16770. return cli_->Post(path, headers, std::move(content_provider), content_type,
  16771. progress);
  16772. }
  16773. inline Result Client::Post(const std::string &path, const Headers &headers,
  16774. ContentProviderWithoutLength content_provider,
  16775. const std::string &content_type,
  16776. ContentReceiver content_receiver,
  16777. DownloadProgress progress) {
  16778. return cli_->Post(path, headers, std::move(content_provider), content_type,
  16779. std::move(content_receiver), progress);
  16780. }
  16781. inline Result Client::Post(const std::string &path, const Params &params) {
  16782. return cli_->Post(path, params);
  16783. }
  16784. inline Result Client::Post(const std::string &path, const Headers &headers,
  16785. const Params &params) {
  16786. return cli_->Post(path, headers, params);
  16787. }
  16788. inline Result Client::Post(const std::string &path,
  16789. const UploadFormDataItems &items,
  16790. UploadProgress progress) {
  16791. return cli_->Post(path, items, progress);
  16792. }
  16793. inline Result Client::Post(const std::string &path, const Headers &headers,
  16794. const UploadFormDataItems &items,
  16795. UploadProgress progress) {
  16796. return cli_->Post(path, headers, items, progress);
  16797. }
  16798. inline Result Client::Post(const std::string &path, const Headers &headers,
  16799. const UploadFormDataItems &items,
  16800. const std::string &boundary,
  16801. UploadProgress progress) {
  16802. return cli_->Post(path, headers, items, boundary, progress);
  16803. }
  16804. inline Result Client::Post(const std::string &path, const Headers &headers,
  16805. const UploadFormDataItems &items,
  16806. const FormDataProviderItems &provider_items,
  16807. UploadProgress progress) {
  16808. return cli_->Post(path, headers, items, provider_items, progress);
  16809. }
  16810. inline Result Client::Post(const std::string &path, const Headers &headers,
  16811. const std::string &body,
  16812. const std::string &content_type,
  16813. ContentReceiver content_receiver,
  16814. DownloadProgress progress) {
  16815. return cli_->Post(path, headers, body, content_type,
  16816. std::move(content_receiver), progress);
  16817. }
  16818. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  16819. inline Result Client::Put(const std::string &path, const Headers &headers) {
  16820. return cli_->Put(path, headers);
  16821. }
  16822. inline Result Client::Put(const std::string &path, const char *body,
  16823. size_t content_length,
  16824. const std::string &content_type,
  16825. UploadProgress progress) {
  16826. return cli_->Put(path, body, content_length, content_type, progress);
  16827. }
  16828. inline Result Client::Put(const std::string &path, const Headers &headers,
  16829. const char *body, size_t content_length,
  16830. const std::string &content_type,
  16831. UploadProgress progress) {
  16832. return cli_->Put(path, headers, body, content_length, content_type, progress);
  16833. }
  16834. inline Result Client::Put(const std::string &path, const std::string &body,
  16835. const std::string &content_type,
  16836. UploadProgress progress) {
  16837. return cli_->Put(path, body, content_type, progress);
  16838. }
  16839. inline Result Client::Put(const std::string &path, const Headers &headers,
  16840. const std::string &body,
  16841. const std::string &content_type,
  16842. UploadProgress progress) {
  16843. return cli_->Put(path, headers, body, content_type, progress);
  16844. }
  16845. inline Result Client::Put(const std::string &path, size_t content_length,
  16846. ContentProvider content_provider,
  16847. const std::string &content_type,
  16848. UploadProgress progress) {
  16849. return cli_->Put(path, content_length, std::move(content_provider),
  16850. content_type, progress);
  16851. }
  16852. inline Result Client::Put(const std::string &path, size_t content_length,
  16853. ContentProvider content_provider,
  16854. const std::string &content_type,
  16855. ContentReceiver content_receiver,
  16856. UploadProgress progress) {
  16857. return cli_->Put(path, content_length, std::move(content_provider),
  16858. content_type, std::move(content_receiver), progress);
  16859. }
  16860. inline Result Client::Put(const std::string &path,
  16861. ContentProviderWithoutLength content_provider,
  16862. const std::string &content_type,
  16863. UploadProgress progress) {
  16864. return cli_->Put(path, std::move(content_provider), content_type, progress);
  16865. }
  16866. inline Result Client::Put(const std::string &path,
  16867. ContentProviderWithoutLength content_provider,
  16868. const std::string &content_type,
  16869. ContentReceiver content_receiver,
  16870. UploadProgress progress) {
  16871. return cli_->Put(path, std::move(content_provider), content_type,
  16872. std::move(content_receiver), progress);
  16873. }
  16874. inline Result Client::Put(const std::string &path, const Headers &headers,
  16875. size_t content_length,
  16876. ContentProvider content_provider,
  16877. const std::string &content_type,
  16878. UploadProgress progress) {
  16879. return cli_->Put(path, headers, content_length, std::move(content_provider),
  16880. content_type, progress);
  16881. }
  16882. inline Result Client::Put(const std::string &path, const Headers &headers,
  16883. size_t content_length,
  16884. ContentProvider content_provider,
  16885. const std::string &content_type,
  16886. ContentReceiver content_receiver,
  16887. UploadProgress progress) {
  16888. return cli_->Put(path, headers, content_length, std::move(content_provider),
  16889. content_type, std::move(content_receiver), progress);
  16890. }
  16891. inline Result Client::Put(const std::string &path, const Headers &headers,
  16892. ContentProviderWithoutLength content_provider,
  16893. const std::string &content_type,
  16894. UploadProgress progress) {
  16895. return cli_->Put(path, headers, std::move(content_provider), content_type,
  16896. progress);
  16897. }
  16898. inline Result Client::Put(const std::string &path, const Headers &headers,
  16899. ContentProviderWithoutLength content_provider,
  16900. const std::string &content_type,
  16901. ContentReceiver content_receiver,
  16902. UploadProgress progress) {
  16903. return cli_->Put(path, headers, std::move(content_provider), content_type,
  16904. std::move(content_receiver), progress);
  16905. }
  16906. inline Result Client::Put(const std::string &path, const Params &params) {
  16907. return cli_->Put(path, params);
  16908. }
  16909. inline Result Client::Put(const std::string &path, const Headers &headers,
  16910. const Params &params) {
  16911. return cli_->Put(path, headers, params);
  16912. }
  16913. inline Result Client::Put(const std::string &path,
  16914. const UploadFormDataItems &items,
  16915. UploadProgress progress) {
  16916. return cli_->Put(path, items, progress);
  16917. }
  16918. inline Result Client::Put(const std::string &path, const Headers &headers,
  16919. const UploadFormDataItems &items,
  16920. UploadProgress progress) {
  16921. return cli_->Put(path, headers, items, progress);
  16922. }
  16923. inline Result Client::Put(const std::string &path, const Headers &headers,
  16924. const UploadFormDataItems &items,
  16925. const std::string &boundary,
  16926. UploadProgress progress) {
  16927. return cli_->Put(path, headers, items, boundary, progress);
  16928. }
  16929. inline Result Client::Put(const std::string &path, const Headers &headers,
  16930. const UploadFormDataItems &items,
  16931. const FormDataProviderItems &provider_items,
  16932. UploadProgress progress) {
  16933. return cli_->Put(path, headers, items, provider_items, progress);
  16934. }
  16935. inline Result Client::Put(const std::string &path, const Headers &headers,
  16936. const std::string &body,
  16937. const std::string &content_type,
  16938. ContentReceiver content_receiver,
  16939. DownloadProgress progress) {
  16940. return cli_->Put(path, headers, body, content_type, content_receiver,
  16941. progress);
  16942. }
  16943. inline Result Client::Patch(const std::string &path) {
  16944. return cli_->Patch(path);
  16945. }
  16946. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  16947. return cli_->Patch(path, headers);
  16948. }
  16949. inline Result Client::Patch(const std::string &path, const char *body,
  16950. size_t content_length,
  16951. const std::string &content_type,
  16952. UploadProgress progress) {
  16953. return cli_->Patch(path, body, content_length, content_type, progress);
  16954. }
  16955. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16956. const char *body, size_t content_length,
  16957. const std::string &content_type,
  16958. UploadProgress progress) {
  16959. return cli_->Patch(path, headers, body, content_length, content_type,
  16960. progress);
  16961. }
  16962. inline Result Client::Patch(const std::string &path, const std::string &body,
  16963. const std::string &content_type,
  16964. UploadProgress progress) {
  16965. return cli_->Patch(path, body, content_type, progress);
  16966. }
  16967. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16968. const std::string &body,
  16969. const std::string &content_type,
  16970. UploadProgress progress) {
  16971. return cli_->Patch(path, headers, body, content_type, progress);
  16972. }
  16973. inline Result Client::Patch(const std::string &path, size_t content_length,
  16974. ContentProvider content_provider,
  16975. const std::string &content_type,
  16976. UploadProgress progress) {
  16977. return cli_->Patch(path, content_length, std::move(content_provider),
  16978. content_type, progress);
  16979. }
  16980. inline Result Client::Patch(const std::string &path, size_t content_length,
  16981. ContentProvider content_provider,
  16982. const std::string &content_type,
  16983. ContentReceiver content_receiver,
  16984. UploadProgress progress) {
  16985. return cli_->Patch(path, content_length, std::move(content_provider),
  16986. content_type, std::move(content_receiver), progress);
  16987. }
  16988. inline Result Client::Patch(const std::string &path,
  16989. ContentProviderWithoutLength content_provider,
  16990. const std::string &content_type,
  16991. UploadProgress progress) {
  16992. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  16993. }
  16994. inline Result Client::Patch(const std::string &path,
  16995. ContentProviderWithoutLength content_provider,
  16996. const std::string &content_type,
  16997. ContentReceiver content_receiver,
  16998. UploadProgress progress) {
  16999. return cli_->Patch(path, std::move(content_provider), content_type,
  17000. std::move(content_receiver), progress);
  17001. }
  17002. inline Result Client::Patch(const std::string &path, const Headers &headers,
  17003. size_t content_length,
  17004. ContentProvider content_provider,
  17005. const std::string &content_type,
  17006. UploadProgress progress) {
  17007. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  17008. content_type, progress);
  17009. }
  17010. inline Result Client::Patch(const std::string &path, const Headers &headers,
  17011. size_t content_length,
  17012. ContentProvider content_provider,
  17013. const std::string &content_type,
  17014. ContentReceiver content_receiver,
  17015. UploadProgress progress) {
  17016. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  17017. content_type, std::move(content_receiver), progress);
  17018. }
  17019. inline Result Client::Patch(const std::string &path, const Headers &headers,
  17020. ContentProviderWithoutLength content_provider,
  17021. const std::string &content_type,
  17022. UploadProgress progress) {
  17023. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  17024. progress);
  17025. }
  17026. inline Result Client::Patch(const std::string &path, const Headers &headers,
  17027. ContentProviderWithoutLength content_provider,
  17028. const std::string &content_type,
  17029. ContentReceiver content_receiver,
  17030. UploadProgress progress) {
  17031. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  17032. std::move(content_receiver), progress);
  17033. }
  17034. inline Result Client::Patch(const std::string &path, const Params &params) {
  17035. return cli_->Patch(path, params);
  17036. }
  17037. inline Result Client::Patch(const std::string &path, const Headers &headers,
  17038. const Params &params) {
  17039. return cli_->Patch(path, headers, params);
  17040. }
  17041. inline Result Client::Patch(const std::string &path,
  17042. const UploadFormDataItems &items,
  17043. UploadProgress progress) {
  17044. return cli_->Patch(path, items, progress);
  17045. }
  17046. inline Result Client::Patch(const std::string &path, const Headers &headers,
  17047. const UploadFormDataItems &items,
  17048. UploadProgress progress) {
  17049. return cli_->Patch(path, headers, items, progress);
  17050. }
  17051. inline Result Client::Patch(const std::string &path, const Headers &headers,
  17052. const UploadFormDataItems &items,
  17053. const std::string &boundary,
  17054. UploadProgress progress) {
  17055. return cli_->Patch(path, headers, items, boundary, progress);
  17056. }
  17057. inline Result Client::Patch(const std::string &path, const Headers &headers,
  17058. const UploadFormDataItems &items,
  17059. const FormDataProviderItems &provider_items,
  17060. UploadProgress progress) {
  17061. return cli_->Patch(path, headers, items, provider_items, progress);
  17062. }
  17063. inline Result Client::Patch(const std::string &path, const Headers &headers,
  17064. const std::string &body,
  17065. const std::string &content_type,
  17066. ContentReceiver content_receiver,
  17067. DownloadProgress progress) {
  17068. return cli_->Patch(path, headers, body, content_type, content_receiver,
  17069. progress);
  17070. }
  17071. inline Result Client::Delete(const std::string &path,
  17072. DownloadProgress progress) {
  17073. return cli_->Delete(path, progress);
  17074. }
  17075. inline Result Client::Delete(const std::string &path, const Headers &headers,
  17076. DownloadProgress progress) {
  17077. return cli_->Delete(path, headers, progress);
  17078. }
  17079. inline Result Client::Delete(const std::string &path, const char *body,
  17080. size_t content_length,
  17081. const std::string &content_type,
  17082. DownloadProgress progress) {
  17083. return cli_->Delete(path, body, content_length, content_type, progress);
  17084. }
  17085. inline Result Client::Delete(const std::string &path, const Headers &headers,
  17086. const char *body, size_t content_length,
  17087. const std::string &content_type,
  17088. DownloadProgress progress) {
  17089. return cli_->Delete(path, headers, body, content_length, content_type,
  17090. progress);
  17091. }
  17092. inline Result Client::Delete(const std::string &path, const std::string &body,
  17093. const std::string &content_type,
  17094. DownloadProgress progress) {
  17095. return cli_->Delete(path, body, content_type, progress);
  17096. }
  17097. inline Result Client::Delete(const std::string &path, const Headers &headers,
  17098. const std::string &body,
  17099. const std::string &content_type,
  17100. DownloadProgress progress) {
  17101. return cli_->Delete(path, headers, body, content_type, progress);
  17102. }
  17103. inline Result Client::Delete(const std::string &path, const Params &params,
  17104. DownloadProgress progress) {
  17105. return cli_->Delete(path, params, progress);
  17106. }
  17107. inline Result Client::Delete(const std::string &path, const Headers &headers,
  17108. const Params &params, DownloadProgress progress) {
  17109. return cli_->Delete(path, headers, params, progress);
  17110. }
  17111. inline Result Client::Options(const std::string &path) {
  17112. return cli_->Options(path);
  17113. }
  17114. inline Result Client::Options(const std::string &path, const Headers &headers) {
  17115. return cli_->Options(path, headers);
  17116. }
  17117. inline ClientImpl::StreamHandle
  17118. Client::open_stream(const std::string &method, const std::string &path,
  17119. const Params &params, const Headers &headers,
  17120. const std::string &body, const std::string &content_type) {
  17121. return cli_->open_stream(method, path, params, headers, body, content_type);
  17122. }
  17123. inline bool Client::send(Request &req, Response &res, Error &error) {
  17124. return cli_->send(req, res, error);
  17125. }
  17126. inline Result Client::send(const Request &req) { return cli_->send(req); }
  17127. inline void Client::stop() { cli_->stop(); }
  17128. inline std::string Client::host() const { return cli_->host(); }
  17129. inline int Client::port() const { return cli_->port(); }
  17130. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  17131. inline socket_t Client::socket() const { return cli_->socket(); }
  17132. inline void
  17133. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  17134. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  17135. }
  17136. inline void Client::set_direct_hostname_addr_map(
  17137. std::map<std::string, std::string> addr_map) {
  17138. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  17139. }
  17140. inline void Client::set_tunnel_hostname_addr_map(
  17141. std::map<std::string, std::string> addr_map) {
  17142. cli_->set_tunnel_hostname_addr_map(std::move(addr_map));
  17143. }
  17144. inline void Client::set_default_headers(Headers headers) {
  17145. cli_->set_default_headers(std::move(headers));
  17146. }
  17147. inline void Client::set_header_writer(
  17148. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  17149. cli_->set_header_writer(writer);
  17150. }
  17151. inline void Client::set_address_family(int family) {
  17152. cli_->set_address_family(family);
  17153. }
  17154. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  17155. inline void Client::set_socket_options(SocketOptions socket_options) {
  17156. cli_->set_socket_options(std::move(socket_options));
  17157. }
  17158. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  17159. cli_->set_connection_timeout(sec, usec);
  17160. }
  17161. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  17162. cli_->set_read_timeout(sec, usec);
  17163. }
  17164. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  17165. cli_->set_write_timeout(sec, usec);
  17166. }
  17167. inline void Client::set_basic_auth(const std::string &username,
  17168. const std::string &password) {
  17169. cli_->set_basic_auth(username, password);
  17170. }
  17171. inline void Client::set_bearer_token_auth(const std::string &token) {
  17172. cli_->set_bearer_token_auth(token);
  17173. }
  17174. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  17175. inline void Client::set_follow_location(bool on) {
  17176. cli_->set_follow_location(on);
  17177. }
  17178. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  17179. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  17180. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  17181. inline void Client::set_payload_max_length(size_t length) {
  17182. cli_->set_payload_max_length(length);
  17183. }
  17184. inline void Client::set_interface(const std::string &intf) {
  17185. cli_->set_interface(intf);
  17186. }
  17187. inline void Client::set_proxy(const std::string &host, int port) {
  17188. cli_->set_proxy(host, port);
  17189. }
  17190. inline void Client::set_proxy_basic_auth(const std::string &username,
  17191. const std::string &password) {
  17192. cli_->set_proxy_basic_auth(username, password);
  17193. }
  17194. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  17195. cli_->set_proxy_bearer_token_auth(token);
  17196. }
  17197. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  17198. cli_->set_no_proxy(patterns);
  17199. }
  17200. inline void Client::set_logger(Logger logger) {
  17201. cli_->set_logger(std::move(logger));
  17202. }
  17203. inline void Client::set_error_logger(ErrorLogger error_logger) {
  17204. cli_->set_error_logger(std::move(error_logger));
  17205. }
  17206. /*
  17207. * Group 6: SSL Server and Client implementation
  17208. */
  17209. #ifdef CPPHTTPLIB_SSL_ENABLED
  17210. // SSL HTTP server implementation
  17211. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  17212. const char *client_ca_cert_file_path,
  17213. const char *client_ca_cert_dir_path,
  17214. const char *private_key_password) {
  17215. using namespace tls;
  17216. ctx_ = create_server_context();
  17217. if (!ctx_) { return; }
  17218. // Load server certificate and private key
  17219. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  17220. private_key_password)) {
  17221. last_ssl_error_ = static_cast<int>(get_error());
  17222. free_context(ctx_);
  17223. ctx_ = nullptr;
  17224. return;
  17225. }
  17226. // Load client CA certificates for client authentication
  17227. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  17228. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  17229. client_ca_cert_dir_path)) {
  17230. last_ssl_error_ = static_cast<int>(get_error());
  17231. free_context(ctx_);
  17232. ctx_ = nullptr;
  17233. return;
  17234. }
  17235. // Enable client certificate verification
  17236. set_verify_client(ctx_, true);
  17237. }
  17238. }
  17239. inline SSLServer::SSLServer(const PemMemory &pem) {
  17240. using namespace tls;
  17241. ctx_ = create_server_context();
  17242. if (ctx_) {
  17243. std::string cert_buf, key_buf;
  17244. if (!set_server_cert_pem(
  17245. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  17246. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  17247. pem.private_key_password)) {
  17248. last_ssl_error_ = static_cast<int>(get_error());
  17249. free_context(ctx_);
  17250. ctx_ = nullptr;
  17251. } else if (pem.client_ca_pem) {
  17252. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  17253. : strlen(pem.client_ca_pem);
  17254. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  17255. last_ssl_error_ = static_cast<int>(get_error());
  17256. free_context(ctx_);
  17257. ctx_ = nullptr;
  17258. } else {
  17259. set_verify_client(ctx_, true);
  17260. }
  17261. }
  17262. }
  17263. }
  17264. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  17265. using namespace tls;
  17266. ctx_ = create_server_context();
  17267. if (ctx_) {
  17268. if (!setup_callback(ctx_)) {
  17269. free_context(ctx_);
  17270. ctx_ = nullptr;
  17271. }
  17272. }
  17273. }
  17274. inline SSLServer::~SSLServer() {
  17275. if (ctx_) { tls::free_context(ctx_); }
  17276. }
  17277. inline bool SSLServer::is_valid() const {
  17278. return ctx_ != nullptr && Server::is_valid();
  17279. }
  17280. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17281. namespace detail {
  17282. // Before these, SSL_free_buffers() could free a buffer that a record whose
  17283. // body has not arrived yet still uses (CVE-2024-4741). `version` is
  17284. // OpenSSL_version_num().
  17285. inline bool ssl_free_buffers_is_safe(unsigned long version) {
  17286. if (version >= 0x30400000UL) { return true; }
  17287. if (version >= 0x30300000UL) { return version >= 0x30300010UL; } // 3.3.1
  17288. if (version >= 0x30200000UL) { return version >= 0x30200020UL; } // 3.2.2
  17289. if (version >= 0x30100000UL) { return version >= 0x30100060UL; } // 3.1.6
  17290. return version >= 0x300000e0UL; // 3.0.14
  17291. }
  17292. } // namespace detail
  17293. #endif
  17294. // A connection that keep-alive parking keeps for SSLServer. The worker that
  17295. // first resumes it runs the handshake, so one that has not sent its
  17296. // ClientHello yet waits in the event loop like an idle connection.
  17297. struct SSLServer::TlsConnection final : Server::KeepAliveConnection {
  17298. TlsConnection(socket_t s, SSLServer &server)
  17299. : KeepAliveConnection(s, server), ssl_svr(server) {}
  17300. ~TlsConnection() override { tls::free_session(session); }
  17301. bool open() override {
  17302. // A handshake would hold up the stop() that is under way.
  17303. if (ssl_svr.is_stopping()) { return false; }
  17304. session = ssl_svr.start_session(sock);
  17305. if (!session) { return false; }
  17306. // The handshake has read what the event loop saw, so a client that sends
  17307. // nothing after it is parked instead of being waited for.
  17308. turn.woken = false;
  17309. return true;
  17310. }
  17311. // The session, not the stream, holds what a pipelined request has left.
  17312. bool serve() override {
  17313. detail::SSLSocketStream strm(
  17314. sock, session, ssl_svr.read_timeout_sec_, ssl_svr.read_timeout_usec_,
  17315. ssl_svr.write_timeout_sec_, ssl_svr.write_timeout_usec_);
  17316. return serve_on(strm, [this](Request &req) { req.ssl = session; });
  17317. }
  17318. void release_buffers() override {
  17319. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  17320. !defined(LIBRESSL_VERSION_NUMBER)
  17321. // The record buffers are most of an idle session's memory, and the next
  17322. // read makes new ones. The library that runs decides whether that is safe.
  17323. static const auto safe =
  17324. detail::ssl_free_buffers_is_safe(OpenSSL_version_num());
  17325. if (safe) { SSL_free_buffers(static_cast<SSL *>(session)); }
  17326. #endif
  17327. }
  17328. void shut_down(bool graceful) override { tls::shutdown(session, graceful); }
  17329. SSLServer &ssl_svr;
  17330. tls::session_t session = nullptr;
  17331. };
  17332. inline std::shared_ptr<Server::KeepAliveConnection>
  17333. SSLServer::new_keep_alive_connection(socket_t sock) {
  17334. return std::make_shared<TlsConnection>(sock, *this);
  17335. }
  17336. inline tls::session_t SSLServer::start_session(socket_t sock) {
  17337. using namespace tls;
  17338. session_t session = nullptr;
  17339. {
  17340. std::unique_lock<std::mutex> lock(ctx_mutex_);
  17341. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  17342. session = create_session(static_cast<ctx_t>(ctx_), sock);
  17343. if (session) { handshakes_in_progress_++; }
  17344. }
  17345. if (!session) {
  17346. last_ssl_error_ = static_cast<int>(get_error());
  17347. return nullptr;
  17348. }
  17349. // Frees the session on all paths but success (including exceptions)
  17350. auto accepted = false;
  17351. auto cleanup = detail::scope_exit([&] {
  17352. if (!accepted) { free_session(session); }
  17353. });
  17354. // Perform TLS accept handshake with timeout
  17355. TlsError tls_err;
  17356. {
  17357. auto handshake_left = detail::scope_exit([&] {
  17358. std::lock_guard<std::mutex> guard(ctx_mutex_);
  17359. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  17360. });
  17361. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  17362. read_timeout_usec_, &tls_err);
  17363. }
  17364. if (!accepted) {
  17365. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17366. // Map TlsError to legacy ssl_error for backward compatibility
  17367. if (tls_err.code == ErrorCode::WantRead) {
  17368. last_ssl_error_ = SSL_ERROR_WANT_READ;
  17369. } else if (tls_err.code == ErrorCode::WantWrite) {
  17370. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  17371. } else {
  17372. last_ssl_error_ = SSL_ERROR_SSL;
  17373. }
  17374. #else
  17375. last_ssl_error_ = static_cast<int>(get_error());
  17376. #endif
  17377. return nullptr;
  17378. }
  17379. return session;
  17380. }
  17381. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  17382. auto session = start_session(sock);
  17383. if (!session) {
  17384. detail::shutdown_socket(sock);
  17385. detail::close_socket(sock);
  17386. return false;
  17387. }
  17388. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  17389. bool ret = false;
  17390. bool websocket_upgraded = false;
  17391. auto cleanup = detail::scope_exit([&] {
  17392. tls::shutdown(session, !websocket_upgraded && ret);
  17393. tls::free_session(session);
  17394. detail::drain_and_close_socket(sock);
  17395. });
  17396. std::string remote_addr;
  17397. int remote_port = 0;
  17398. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  17399. std::string local_addr;
  17400. int local_port = 0;
  17401. detail::get_local_ip_and_port(sock, local_addr, local_port);
  17402. ret = serve_guarded([&]() {
  17403. return detail::process_server_socket_ssl(
  17404. svr_sock_, session, sock, keep_alive_max_count_,
  17405. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  17406. write_timeout_sec_, write_timeout_usec_,
  17407. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  17408. return process_request(
  17409. strm, remote_addr, remote_port, local_addr, local_port,
  17410. close_connection, connection_closed,
  17411. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  17412. });
  17413. });
  17414. return ret;
  17415. }
  17416. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  17417. const char *key_pem,
  17418. const char *client_ca_pem,
  17419. const char *password) {
  17420. if (!ctx_) { return false; }
  17421. std::unique_lock<std::mutex> lock(ctx_mutex_);
  17422. updates_pending_++;
  17423. auto se = detail::scope_exit([&] {
  17424. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  17425. });
  17426. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  17427. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  17428. return false;
  17429. }
  17430. if (client_ca_pem) {
  17431. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  17432. // As in the constructors, a client CA makes client certificates required
  17433. tls::set_verify_client(ctx_, true);
  17434. }
  17435. return true;
  17436. }
  17437. // SSL HTTP client implementation
  17438. inline SSLClient::~SSLClient() {
  17439. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  17440. // base function rather than the derived function once we get to the
  17441. // base class destructor, and won't free the SSL (causing a leak).
  17442. // This must happen before the context is freed below: some backends
  17443. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  17444. // context, so freeing the context first leaves close_notify reading
  17445. // freed memory.
  17446. shutdown_ssl_impl(socket_, true);
  17447. if (ctx_) {
  17448. tls::free_context(ctx_);
  17449. ctx_ = nullptr;
  17450. }
  17451. }
  17452. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  17453. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  17454. shutdown_ssl_impl(socket, shutdown_gracefully);
  17455. }
  17456. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  17457. bool shutdown_gracefully) {
  17458. if (socket.sock == INVALID_SOCKET) {
  17459. assert(socket.ssl == nullptr);
  17460. return;
  17461. }
  17462. if (socket.ssl) {
  17463. tls::shutdown(socket.ssl, shutdown_gracefully);
  17464. {
  17465. std::lock_guard<std::mutex> guard(ctx_mutex_);
  17466. tls::free_session(socket.ssl);
  17467. }
  17468. socket.ssl = nullptr;
  17469. }
  17470. assert(socket.ssl == nullptr);
  17471. }
  17472. inline bool SSLClient::process_socket(
  17473. const Socket &socket,
  17474. std::chrono::time_point<std::chrono::steady_clock> start_time,
  17475. std::function<bool(Stream &strm)> callback) {
  17476. assert(socket.ssl);
  17477. return detail::process_client_socket_ssl(
  17478. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  17479. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  17480. [&](detail::SSLSocketStream &strm) {
  17481. auto ret = callback(strm);
  17482. // A request that failed after the handshake reports Error::Read or
  17483. // Error::Write; keep the TLS error behind it, such as a fatal alert
  17484. // from the server, for Result::ssl_error() and ssl_backend_error()
  17485. const auto &tls_error = strm.tls_error();
  17486. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  17487. last_ssl_error_ = static_cast<int>(tls_error.code);
  17488. last_backend_error_ = tls_error.backend_code;
  17489. }
  17490. return ret;
  17491. });
  17492. }
  17493. inline bool SSLClient::is_ssl() const { return true; }
  17494. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  17495. if (!is_valid()) {
  17496. error = Error::SSLConnection;
  17497. return false;
  17498. }
  17499. return ClientImpl::create_and_connect_socket(socket, error);
  17500. }
  17501. inline bool SSLClient::setup_proxy_connection(
  17502. Socket &socket,
  17503. std::chrono::time_point<std::chrono::steady_clock> start_time,
  17504. Response &res, bool &success, Error &error) {
  17505. if (!is_proxy_enabled_for_host(host_)) { return true; }
  17506. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  17507. return false;
  17508. }
  17509. if (!initialize_ssl(socket, error)) {
  17510. shutdown_socket(socket);
  17511. close_socket(socket);
  17512. success = false;
  17513. return false;
  17514. }
  17515. return true;
  17516. }
  17517. // Assumes that socket is a connection being opened, which no other thread uses
  17518. inline bool SSLClient::connect_with_proxy(
  17519. Socket &socket,
  17520. std::chrono::time_point<std::chrono::steady_clock> start_time,
  17521. Response &res, bool &success, Error &error) {
  17522. success = true;
  17523. auto connect_target =
  17524. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  17525. auto retargeted = connect_target !=
  17526. detail::make_host_and_port_string_always_port(host_, port_);
  17527. Response proxy_res;
  17528. if (!detail::process_client_socket(
  17529. socket.sock, read_timeout_sec_, read_timeout_usec_,
  17530. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  17531. start_time, [&](Stream &strm) {
  17532. strm.set_read_interrupt(stop_interrupt());
  17533. Request req2;
  17534. req2.method = "CONNECT";
  17535. req2.path = connect_target;
  17536. if (retargeted) { req2.set_header("Host", connect_target); }
  17537. if (max_timeout_msec_ > 0) {
  17538. req2.start_time_ = std::chrono::steady_clock::now();
  17539. }
  17540. return process_request(strm, req2, proxy_res, false, error);
  17541. })) {
  17542. // Thread-safe to close everything because we are assuming there are no
  17543. // requests in flight
  17544. shutdown_ssl(socket, true);
  17545. shutdown_socket(socket);
  17546. close_socket(socket);
  17547. success = false;
  17548. return false;
  17549. }
  17550. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  17551. if (!proxy_digest_auth_username_.empty() &&
  17552. !proxy_digest_auth_password_.empty()) {
  17553. std::map<std::string, std::string> auth;
  17554. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  17555. // Close the current socket and create a new one for the authenticated
  17556. // request
  17557. shutdown_ssl(socket, true);
  17558. shutdown_socket(socket);
  17559. close_socket(socket);
  17560. // Create a new socket for the authenticated CONNECT request
  17561. if (!ensure_socket_connection(socket, error)) {
  17562. success = false;
  17563. return false;
  17564. }
  17565. proxy_res = Response();
  17566. if (!detail::process_client_socket(
  17567. socket.sock, read_timeout_sec_, read_timeout_usec_,
  17568. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  17569. start_time, [&](Stream &strm) {
  17570. strm.set_read_interrupt(stop_interrupt());
  17571. Request req3;
  17572. req3.method = "CONNECT";
  17573. req3.path = connect_target;
  17574. if (retargeted) { req3.set_header("Host", connect_target); }
  17575. req3.headers.insert(detail::make_digest_authentication_header(
  17576. req3, make_request_target(req3), auth, 1,
  17577. detail::random_string(10), proxy_digest_auth_username_,
  17578. proxy_digest_auth_password_, true));
  17579. if (max_timeout_msec_ > 0) {
  17580. req3.start_time_ = std::chrono::steady_clock::now();
  17581. }
  17582. return process_request(strm, req3, proxy_res, false, error);
  17583. })) {
  17584. // Thread-safe to close everything because we are assuming there are
  17585. // no requests in flight
  17586. shutdown_ssl(socket, true);
  17587. shutdown_socket(socket);
  17588. close_socket(socket);
  17589. success = false;
  17590. return false;
  17591. }
  17592. }
  17593. }
  17594. }
  17595. // If status code is not 200, proxy request is failed.
  17596. // Set error to ProxyConnection. A 407 is returned as the response of the
  17597. // request, so the caller sees the proxy asks for credentials; any other
  17598. // status would read as the answer of the origin, which it never reached.
  17599. if (proxy_res.status != StatusCode::OK_200) {
  17600. error = Error::ProxyConnection;
  17601. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  17602. res = std::move(proxy_res);
  17603. } else {
  17604. success = false;
  17605. }
  17606. // Thread-safe to close everything because we are assuming there are
  17607. // no requests in flight
  17608. shutdown_ssl(socket, true);
  17609. shutdown_socket(socket);
  17610. close_socket(socket);
  17611. return false;
  17612. }
  17613. return true;
  17614. }
  17615. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  17616. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  17617. if (is_proxy_enabled_for_host(host_)) { return true; }
  17618. if (!initialize_ssl(socket, error)) {
  17619. shutdown_socket(socket);
  17620. close_socket(socket);
  17621. return false;
  17622. }
  17623. return true;
  17624. }
  17625. // SSL HTTP client implementation
  17626. inline SSLClient::SSLClient(const std::string &host)
  17627. : SSLClient(host, 443, std::string(), std::string()) {}
  17628. inline SSLClient::SSLClient(const std::string &host, int port)
  17629. : SSLClient(host, port, std::string(), std::string()) {}
  17630. inline void SSLClient::init_ctx() {
  17631. ctx_ = tls::create_client_context();
  17632. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  17633. }
  17634. inline void SSLClient::reset_ctx_on_error() {
  17635. last_backend_error_ = tls::get_error();
  17636. tls::free_context(ctx_);
  17637. ctx_ = nullptr;
  17638. }
  17639. inline SSLClient::SSLClient(const std::string &host, int port,
  17640. const std::string &client_cert_path,
  17641. const std::string &client_key_path,
  17642. const std::string &private_key_password)
  17643. : ClientImpl(host, port, client_cert_path, client_key_path) {
  17644. init_ctx();
  17645. if (!ctx_) { return; }
  17646. if (!client_cert_path.empty() && !client_key_path.empty()) {
  17647. const char *password =
  17648. private_key_password.empty() ? nullptr : private_key_password.c_str();
  17649. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  17650. client_key_path.c_str(), password)) {
  17651. reset_ctx_on_error();
  17652. }
  17653. }
  17654. }
  17655. inline SSLClient::SSLClient(const std::string &host, int port,
  17656. const PemMemory &pem)
  17657. : ClientImpl(host, port) {
  17658. init_ctx();
  17659. if (!ctx_) { return; }
  17660. if (pem.cert_pem && pem.key_pem) {
  17661. std::string cert_buf, key_buf;
  17662. if (!tls::set_client_cert_pem(
  17663. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  17664. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  17665. pem.private_key_password)) {
  17666. reset_ctx_on_error();
  17667. }
  17668. }
  17669. }
  17670. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  17671. if (ca_cert_store && ctx_) {
  17672. // set_ca_store takes ownership of ca_cert_store
  17673. tls::set_ca_store(ctx_, ca_cert_store);
  17674. ca_cert_store_set_ = true;
  17675. } else if (ca_cert_store) {
  17676. tls::free_ca_store(ca_cert_store);
  17677. }
  17678. custom_ca_loaded_ = true;
  17679. tls_settings_changed();
  17680. }
  17681. inline void
  17682. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  17683. if (!ctx_) { return; }
  17684. server_certificate_verifier_ = verifier;
  17685. {
  17686. // Under the lock that creating a session from ctx_ takes
  17687. std::lock_guard<std::mutex> guard(ctx_mutex_);
  17688. tls::set_verify_callback(ctx_, std::move(verifier));
  17689. }
  17690. tls_settings_changed();
  17691. }
  17692. inline void SSLClient::set_session_verifier(
  17693. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  17694. session_verifier_ = std::move(verifier);
  17695. tls_settings_changed();
  17696. }
  17697. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  17698. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  17699. if (enable_windows_cert_verification_ == enabled) { return; }
  17700. enable_windows_cert_verification_ = enabled;
  17701. tls_settings_changed();
  17702. }
  17703. #endif
  17704. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  17705. std::size_t size) {
  17706. if (ctx_ && ca_cert && size > 0) {
  17707. // Every PEM loaded, for redirect transfer
  17708. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  17709. ca_cert_pem_ += '\n';
  17710. }
  17711. ca_cert_pem_.append(ca_cert, size);
  17712. tls::load_ca_pem(ctx_, ca_cert, size);
  17713. }
  17714. custom_ca_loaded_ = true;
  17715. tls_settings_changed();
  17716. }
  17717. inline bool SSLClient::load_certs() {
  17718. auto ret = true;
  17719. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  17720. // one client is shared across concurrent requests here.
  17721. std::call_once(initialize_cert_, [&]() {
  17722. std::lock_guard<std::mutex> guard(ctx_mutex_);
  17723. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  17724. ca_cert_dir_path_, custom_ca_loaded_,
  17725. system_ca_mode_, last_backend_error_);
  17726. });
  17727. return ret;
  17728. }
  17729. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  17730. // Load CA certificates if server verification is enabled
  17731. if (server_certificate_verification_) {
  17732. if (!load_certs()) {
  17733. error = Error::SSLLoadingCerts;
  17734. return false;
  17735. }
  17736. }
  17737. detail::ClientTlsSessionOptions options;
  17738. options.server_hostname_verification = server_hostname_verification_;
  17739. options.session_verifier = session_verifier_;
  17740. options.interrupted = stop_interrupt();
  17741. options.ctx_mutex = &ctx_mutex_;
  17742. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  17743. options.windows_cert_verification = detail::use_windows_cert_verification(
  17744. enable_windows_cert_verification_, ca_cert_file_path_, ca_cert_dir_path_,
  17745. custom_ca_loaded_, system_ca_mode_);
  17746. // Only a verifier set through set_server_certificate_verifier() is seen
  17747. // here, not one installed with tls::set_verify_callback() directly.
  17748. options.server_certificate_verifier_set =
  17749. static_cast<bool>(server_certificate_verifier_);
  17750. #endif
  17751. tls::session_t session = nullptr;
  17752. // Use scope_exit to ensure session is freed on error paths
  17753. bool success = false;
  17754. auto session_guard = detail::scope_exit([&] {
  17755. if (!success) { tls::free_session(session); }
  17756. });
  17757. detail::ClientTlsSessionError tls_error;
  17758. if (!detail::setup_client_tls_session(
  17759. host_, ctx_, session, socket.sock, server_certificate_verification_,
  17760. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  17761. options)) {
  17762. error = tls_error.error;
  17763. last_ssl_error_ = tls_error.ssl_error;
  17764. last_backend_error_ = tls_error.backend_error;
  17765. return false;
  17766. }
  17767. success = true;
  17768. socket.ssl = session;
  17769. return true;
  17770. }
  17771. inline void Client::set_digest_auth(const std::string &username,
  17772. const std::string &password) {
  17773. cli_->set_digest_auth(username, password);
  17774. }
  17775. inline void Client::set_proxy_digest_auth(const std::string &username,
  17776. const std::string &password) {
  17777. cli_->set_proxy_digest_auth(username, password);
  17778. }
  17779. inline void Client::enable_server_certificate_verification(bool enabled) {
  17780. cli_->enable_server_certificate_verification(enabled);
  17781. }
  17782. inline void Client::enable_server_hostname_verification(bool enabled) {
  17783. cli_->enable_server_hostname_verification(enabled);
  17784. }
  17785. inline void Client::enable_system_ca(bool enabled) {
  17786. cli_->enable_system_ca(enabled);
  17787. }
  17788. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  17789. inline void Client::enable_windows_certificate_verification(bool enabled) {
  17790. if (is_ssl_) {
  17791. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  17792. enabled);
  17793. }
  17794. }
  17795. #endif
  17796. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  17797. const std::string &ca_cert_dir_path) {
  17798. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  17799. }
  17800. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  17801. if (is_ssl_) {
  17802. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  17803. } else if (ca_cert_store) {
  17804. tls::free_ca_store(ca_cert_store);
  17805. }
  17806. }
  17807. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  17808. if (is_ssl_) {
  17809. // Use the PEM-based path so the CA data is retained for redirect transfer
  17810. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  17811. }
  17812. }
  17813. inline void
  17814. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  17815. if (is_ssl_) {
  17816. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  17817. std::move(verifier));
  17818. }
  17819. }
  17820. inline void Client::set_session_verifier(
  17821. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  17822. if (is_ssl_) {
  17823. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  17824. }
  17825. }
  17826. inline tls::ctx_t Client::tls_context() const {
  17827. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  17828. return nullptr;
  17829. }
  17830. #endif // CPPHTTPLIB_SSL_ENABLED
  17831. /*
  17832. * Group 7: TLS abstraction layer - Common API
  17833. */
  17834. #ifdef CPPHTTPLIB_SSL_ENABLED
  17835. namespace tls {
  17836. // Helper for PeerCert construction
  17837. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  17838. return PeerCert(get_peer_cert(session));
  17839. }
  17840. namespace impl {
  17841. // set_verify_callback() can replace a callback while handshakes on other
  17842. // threads run it, so they share it, and take their reference under this lock.
  17843. inline std::mutex &verify_callback_mutex() {
  17844. static std::mutex mutex;
  17845. return mutex;
  17846. }
  17847. // The TLS libraries are C, so an exception from a verify callback must not
  17848. // unwind through them. It rejects the certificate instead.
  17849. inline bool run_verify_callback(const VerifyCallback &callback,
  17850. const VerifyContext &ctx) {
  17851. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  17852. return callback(ctx);
  17853. #else
  17854. try {
  17855. return callback(ctx);
  17856. } catch (...) { return false; }
  17857. #endif
  17858. }
  17859. // Check if a string is an IPv4 address
  17860. inline bool is_ipv4_address(const std::string &str) {
  17861. int dots = 0;
  17862. for (char c : str) {
  17863. if (c == '.') {
  17864. dots++;
  17865. } else if (!detail::is_ascii_digit(c)) {
  17866. return false;
  17867. }
  17868. }
  17869. return dots == 3;
  17870. }
  17871. // Parse IPv4 address string to bytes
  17872. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  17873. const char *p = str.c_str();
  17874. for (int i = 0; i < 4; i++) {
  17875. if (i > 0) {
  17876. if (*p != '.') { return false; }
  17877. p++;
  17878. }
  17879. int val = 0;
  17880. int digits = 0;
  17881. while (detail::is_ascii_digit(*p)) {
  17882. val = val * 10 + (*p - '0');
  17883. if (val > 255) { return false; }
  17884. p++;
  17885. digits++;
  17886. }
  17887. if (digits == 0) { return false; }
  17888. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  17889. if (digits > 1 && *(p - digits) == '0') { return false; }
  17890. out[i] = static_cast<unsigned char>(val);
  17891. }
  17892. return *p == '\0';
  17893. }
  17894. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  17895. // `out` must have room for at least 16 bytes. Returns the address length
  17896. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  17897. // literal. Used to match a host against iPAddress SANs the same way the
  17898. // OpenSSL backend does via X509_check_ip.
  17899. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  17900. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  17901. struct in6_addr addr6 = {};
  17902. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  17903. memcpy(out, &addr6, 16);
  17904. return 16;
  17905. }
  17906. return 0;
  17907. }
  17908. #ifdef _WIN32
  17909. // Enumerate Windows system certificates and call callback with DER data
  17910. template <typename Callback>
  17911. inline bool enumerate_windows_system_certs(Callback cb) {
  17912. bool loaded = false;
  17913. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17914. for (auto store_name : store_names) {
  17915. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  17916. if (hStore) {
  17917. PCCERT_CONTEXT pContext = nullptr;
  17918. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17919. nullptr) {
  17920. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  17921. loaded = true;
  17922. }
  17923. }
  17924. CertCloseStore(hStore, 0);
  17925. }
  17926. }
  17927. return loaded;
  17928. }
  17929. #endif
  17930. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17931. // The trust a certificate's Trust Settings give it for SSL server
  17932. // verification (SecTrustSettings.h). An empty array trusts it as a root.
  17933. // Otherwise the first usage-constraints dictionary that applies decides: one
  17934. // naming a policy other than SSL, a host name or an application does not
  17935. // apply, and a result left out means TrustRoot. Keychain Access writes "Never
  17936. // Trust" as kSecTrustSettingsResultDeny.
  17937. inline SecTrustSettingsResult
  17938. macos_ssl_trust_settings_result(CFArrayRef trust_settings) {
  17939. auto count = CFArrayGetCount(trust_settings);
  17940. if (count == 0) { return kSecTrustSettingsResultTrustRoot; }
  17941. for (CFIndex i = 0; i < count; i++) {
  17942. auto value = CFArrayGetValueAtIndex(trust_settings, i);
  17943. if (!value || CFGetTypeID(value) != CFDictionaryGetTypeID()) { continue; }
  17944. auto constraint = static_cast<CFDictionaryRef>(value);
  17945. auto policy_value =
  17946. CFDictionaryGetValue(constraint, kSecTrustSettingsPolicy);
  17947. if (policy_value) {
  17948. auto policy = static_cast<SecPolicyRef>(const_cast<void *>(policy_value));
  17949. auto is_ssl = false;
  17950. if (auto properties = SecPolicyCopyProperties(policy)) {
  17951. auto oid = CFDictionaryGetValue(properties, kSecPolicyOid);
  17952. is_ssl = oid && CFEqual(oid, kSecPolicyAppleSSL);
  17953. CFRelease(properties);
  17954. }
  17955. if (!is_ssl) { continue; }
  17956. }
  17957. if (CFDictionaryContainsKey(constraint, kSecTrustSettingsPolicyString) ||
  17958. CFDictionaryContainsKey(constraint, kSecTrustSettingsApplication)) {
  17959. continue;
  17960. }
  17961. auto result = kSecTrustSettingsResultTrustRoot;
  17962. auto number = static_cast<CFNumberRef>(
  17963. CFDictionaryGetValue(constraint, kSecTrustSettingsResult));
  17964. if (number) {
  17965. SInt32 number_value = 0;
  17966. if (!CFNumberGetValue(number, kCFNumberSInt32Type, &number_value)) {
  17967. continue;
  17968. }
  17969. result = static_cast<SecTrustSettingsResult>(number_value);
  17970. }
  17971. if (result == kSecTrustSettingsResultTrustRoot ||
  17972. result == kSecTrustSettingsResultTrustAsRoot ||
  17973. result == kSecTrustSettingsResultDeny) {
  17974. return result;
  17975. }
  17976. }
  17977. return kSecTrustSettingsResultUnspecified;
  17978. }
  17979. // Enumerate the macOS Keychain certificates trusted for SSL and call callback
  17980. // with DER data. A certificate with Trust Settings is not trusted just by
  17981. // having them: the settings say whether it is, and a per-user setting
  17982. // overrides the admin domain's, which overrides the system domain's (whose
  17983. // roots are all trusted). So a system root the user set to "Never Trust" is
  17984. // left out, as is one trusted only for S/MIME or code signing.
  17985. template <typename Callback>
  17986. inline bool enumerate_macos_keychain_certs(Callback cb) {
  17987. const SecTrustSettingsDomain domains[] = {
  17988. kSecTrustSettingsDomainUser,
  17989. kSecTrustSettingsDomainAdmin,
  17990. kSecTrustSettingsDomainSystem,
  17991. };
  17992. std::set<std::string> decided;
  17993. std::vector<std::string> trusted;
  17994. for (auto domain : domains) {
  17995. CFArrayRef certs = nullptr;
  17996. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  17997. if (status != errSecSuccess || !certs) {
  17998. if (certs) CFRelease(certs);
  17999. continue;
  18000. }
  18001. CFIndex count = CFArrayGetCount(certs);
  18002. for (CFIndex i = 0; i < count; i++) {
  18003. SecCertificateRef cert =
  18004. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  18005. CFDataRef data = SecCertificateCopyData(cert);
  18006. if (!data) { continue; }
  18007. std::string der(reinterpret_cast<const char *>(CFDataGetBytePtr(data)),
  18008. static_cast<size_t>(CFDataGetLength(data)));
  18009. CFRelease(data);
  18010. // Decided by a domain that overrides this one
  18011. if (decided.find(der) != decided.end()) { continue; }
  18012. auto result = kSecTrustSettingsResultTrustRoot;
  18013. if (domain != kSecTrustSettingsDomainSystem) {
  18014. result = kSecTrustSettingsResultUnspecified;
  18015. CFArrayRef trust_settings = nullptr;
  18016. if (SecTrustSettingsCopyTrustSettings(cert, domain, &trust_settings) ==
  18017. errSecSuccess &&
  18018. trust_settings) {
  18019. result = macos_ssl_trust_settings_result(trust_settings);
  18020. }
  18021. if (trust_settings) CFRelease(trust_settings);
  18022. }
  18023. // Neither trusted nor distrusted here; a domain below may decide
  18024. if (result == kSecTrustSettingsResultUnspecified) { continue; }
  18025. decided.insert(der);
  18026. if (result == kSecTrustSettingsResultTrustRoot ||
  18027. result == kSecTrustSettingsResultTrustAsRoot) {
  18028. trusted.push_back(std::move(der));
  18029. }
  18030. }
  18031. CFRelease(certs);
  18032. }
  18033. bool loaded = false;
  18034. for (const auto &der : trusted) {
  18035. if (cb(reinterpret_cast<const unsigned char *>(der.data()), der.size())) {
  18036. loaded = true;
  18037. }
  18038. }
  18039. return loaded;
  18040. }
  18041. #endif
  18042. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  18043. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  18044. // Common CA certificate file paths on Linux/Unix
  18045. inline const char **system_ca_paths() {
  18046. static const char *paths[] = {
  18047. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  18048. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  18049. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  18050. "/etc/pki/tls/cacert.pem", // OpenELEC
  18051. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  18052. nullptr};
  18053. return paths;
  18054. }
  18055. // Common CA certificate directory paths on Linux/Unix
  18056. inline const char **system_ca_dirs() {
  18057. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  18058. "/etc/pki/tls/certs", // RHEL/CentOS
  18059. "/usr/share/ca-certificates", // Other
  18060. nullptr};
  18061. return dirs;
  18062. }
  18063. #endif
  18064. } // namespace impl
  18065. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  18066. const char *ca_dir) {
  18067. if (!ctx) { return false; }
  18068. bool success = true;
  18069. if (ca_file && *ca_file) {
  18070. if (!load_ca_file(ctx, ca_file)) { success = false; }
  18071. }
  18072. if (ca_dir && *ca_dir) {
  18073. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  18074. }
  18075. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  18076. // Set CA list for client certificate request (CertificateRequest message)
  18077. if (ca_file && *ca_file) {
  18078. auto list = SSL_load_client_CA_file(ca_file);
  18079. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  18080. }
  18081. #endif
  18082. return success;
  18083. }
  18084. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18085. const char *password) {
  18086. return set_client_cert_pem(ctx, cert, key, password);
  18087. }
  18088. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  18089. const char *key_path, const char *password) {
  18090. return set_client_cert_file(ctx, cert_path, key_path, password);
  18091. }
  18092. // PeerCert implementation
  18093. inline PeerCert::PeerCert() = default;
  18094. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  18095. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  18096. other.cert_ = nullptr;
  18097. }
  18098. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  18099. if (this != &other) {
  18100. if (cert_) { free_cert(cert_); }
  18101. cert_ = other.cert_;
  18102. other.cert_ = nullptr;
  18103. }
  18104. return *this;
  18105. }
  18106. inline PeerCert::~PeerCert() {
  18107. if (cert_) { free_cert(cert_); }
  18108. }
  18109. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  18110. inline std::string PeerCert::subject_cn() const {
  18111. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  18112. }
  18113. inline std::string PeerCert::issuer_name() const {
  18114. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  18115. }
  18116. inline bool PeerCert::check_hostname(const char *hostname) const {
  18117. return cert_ ? verify_hostname(cert_, hostname) : false;
  18118. }
  18119. inline std::vector<SanEntry> PeerCert::sans() const {
  18120. std::vector<SanEntry> result;
  18121. if (cert_) { get_cert_sans(cert_, result); }
  18122. return result;
  18123. }
  18124. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  18125. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  18126. }
  18127. inline std::string PeerCert::serial() const {
  18128. return cert_ ? get_cert_serial(cert_) : std::string();
  18129. }
  18130. // VerifyContext method implementations
  18131. inline std::string VerifyContext::subject_cn() const {
  18132. return cert ? get_cert_subject_cn(cert) : std::string();
  18133. }
  18134. inline std::string VerifyContext::issuer_name() const {
  18135. return cert ? get_cert_issuer_name(cert) : std::string();
  18136. }
  18137. inline bool VerifyContext::check_hostname(const char *hostname) const {
  18138. return cert ? verify_hostname(cert, hostname) : false;
  18139. }
  18140. inline std::vector<SanEntry> VerifyContext::sans() const {
  18141. std::vector<SanEntry> result;
  18142. if (cert) { get_cert_sans(cert, result); }
  18143. return result;
  18144. }
  18145. inline bool VerifyContext::validity(time_t &not_before,
  18146. time_t &not_after) const {
  18147. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  18148. }
  18149. inline std::string VerifyContext::serial() const {
  18150. return cert ? get_cert_serial(cert) : std::string();
  18151. }
  18152. // TlsError static method implementation
  18153. inline std::string TlsError::verify_error_to_string(long error_code) {
  18154. return verify_error_string(error_code);
  18155. }
  18156. } // namespace tls
  18157. // Request::peer_cert() implementation
  18158. inline tls::PeerCert Request::peer_cert() const {
  18159. return tls::get_peer_cert_from_session(ssl);
  18160. }
  18161. // Request::sni() implementation
  18162. inline std::string Request::sni() const {
  18163. if (!ssl) { return std::string(); }
  18164. const char *s = tls::get_sni(ssl);
  18165. return s ? std::string(s) : std::string();
  18166. }
  18167. #endif // CPPHTTPLIB_SSL_ENABLED
  18168. /*
  18169. * Group 8: TLS abstraction layer - OpenSSL backend
  18170. */
  18171. /*
  18172. * OpenSSL Backend Implementation
  18173. */
  18174. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  18175. namespace tls {
  18176. namespace impl {
  18177. // Helper to map OpenSSL SSL_get_error to ErrorCode
  18178. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  18179. switch (ssl_error) {
  18180. case SSL_ERROR_NONE: return ErrorCode::Success;
  18181. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18182. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18183. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18184. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18185. case SSL_ERROR_SSL:
  18186. default: return ErrorCode::Fatal;
  18187. }
  18188. }
  18189. // Fills in a failed SSL_connect(). One that the server certificate's
  18190. // verification stopped reports the verify result, as the other backends and
  18191. // a check after the handshake do.
  18192. inline void fill_connect_error(SSL *ssl, int ret, TlsError &err) {
  18193. auto ssl_err = SSL_get_error(ssl, ret);
  18194. auto error = ERR_get_error();
  18195. err.code = map_ssl_error(ssl_err, err.sys_errno);
  18196. err.backend_code = error;
  18197. if (ssl_err != SSL_ERROR_SSL || ERR_GET_LIB(error) != ERR_LIB_SSL ||
  18198. ERR_GET_REASON(error) != SSL_R_CERTIFICATE_VERIFY_FAILED) {
  18199. return;
  18200. }
  18201. // A certificate only a verify callback turned down carries no verdict of
  18202. // its own, and fails as any other handshake does
  18203. auto verify_result = SSL_get_verify_result(ssl);
  18204. if (verify_result == X509_V_OK || verify_result == X509_V_ERR_UNSPECIFIED) {
  18205. return;
  18206. }
  18207. err.code = verify_result == X509_V_ERR_HOSTNAME_MISMATCH
  18208. ? ErrorCode::HostnameMismatch
  18209. : ErrorCode::CertVerifyFailed;
  18210. err.backend_code = static_cast<uint64_t>(verify_result);
  18211. }
  18212. // Helper: Create client CA list from PEM string
  18213. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  18214. // Caller takes ownership of returned list
  18215. inline STACK_OF(X509_NAME) *
  18216. create_client_ca_list_from_pem(const char *ca_pem) {
  18217. if (!ca_pem) { return nullptr; }
  18218. auto ca_list = sk_X509_NAME_new_null();
  18219. if (!ca_list) { return nullptr; }
  18220. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  18221. if (!bio) {
  18222. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  18223. return nullptr;
  18224. }
  18225. X509 *cert = nullptr;
  18226. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  18227. nullptr) {
  18228. const X509_NAME *name = X509_get_subject_name(cert);
  18229. if (name) {
  18230. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  18231. }
  18232. X509_free(cert);
  18233. }
  18234. BIO_free(bio);
  18235. return ca_list;
  18236. }
  18237. inline void free_verify_callback(void * /*parent*/, void *ptr,
  18238. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  18239. long /*argl*/, void * /*argp*/) {
  18240. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  18241. }
  18242. // The SSL_CTX owns its verify callback, so each client or server sees only
  18243. // its own, on whichever thread runs the handshake.
  18244. inline int verify_callback_index() {
  18245. static const auto index = SSL_CTX_get_ex_new_index(
  18246. 0, nullptr, nullptr, nullptr, free_verify_callback);
  18247. return index;
  18248. }
  18249. // OpenSSL verify callback wrapper
  18250. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  18251. // Get SSL object from X509_STORE_CTX
  18252. auto ssl = static_cast<SSL *>(
  18253. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  18254. if (!ssl) { return preverify_ok; }
  18255. std::shared_ptr<VerifyCallback> callback;
  18256. {
  18257. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  18258. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  18259. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  18260. if (stored) { callback = *stored; }
  18261. }
  18262. if (!callback) { return preverify_ok; }
  18263. // Get current certificate and depth
  18264. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  18265. int depth = X509_STORE_CTX_get_error_depth(ctx);
  18266. int error = X509_STORE_CTX_get_error(ctx);
  18267. // Build context
  18268. VerifyContext verify_ctx;
  18269. verify_ctx.session = static_cast<session_t>(ssl);
  18270. verify_ctx.cert = static_cast<cert_t>(cert);
  18271. verify_ctx.depth = depth;
  18272. verify_ctx.preverify_ok = (preverify_ok != 0);
  18273. verify_ctx.error_code = error;
  18274. verify_ctx.error_string =
  18275. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  18276. auto accepted = run_verify_callback(*callback, verify_ctx);
  18277. // A client verifying the server during the handshake, which is what
  18278. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  18279. if (!SSL_is_server(ssl) &&
  18280. (SSL_get_verify_mode(ssl) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  18281. accepted = accepted && preverify_ok;
  18282. }
  18283. return accepted ? 1 : 0;
  18284. }
  18285. // Sets the verify mode from whether the peer's certificate is required and
  18286. // whether a verify callback is set.
  18287. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  18288. auto has_callback =
  18289. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  18290. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  18291. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  18292. SSL_CTX_set_verify(ssl_ctx, mode,
  18293. has_callback ? openssl_verify_callback : nullptr);
  18294. }
  18295. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  18296. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  18297. // that must be released with release_store_objects
  18298. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  18299. OPENSSL_VERSION_NUMBER >= 0x30300000L
  18300. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  18301. #endif
  18302. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  18303. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  18304. return X509_STORE_get1_objects(store);
  18305. #else
  18306. return X509_STORE_get0_objects(store);
  18307. #endif
  18308. }
  18309. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  18310. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  18311. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  18312. #else
  18313. (void)objs; // get0 variant returns an internal pointer; nothing to free
  18314. #endif
  18315. }
  18316. } // namespace impl
  18317. inline ctx_t create_client_context() {
  18318. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  18319. if (ctx) {
  18320. // Disable auto-retry to properly handle non-blocking I/O
  18321. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  18322. // Set minimum TLS version
  18323. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  18324. }
  18325. return static_cast<ctx_t>(ctx);
  18326. }
  18327. inline void free_context(ctx_t ctx) {
  18328. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  18329. }
  18330. inline bool set_min_version(ctx_t ctx, Version version) {
  18331. if (!ctx) return false;
  18332. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  18333. static_cast<uint16_t>(version)) == 1;
  18334. }
  18335. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18336. if (!ctx || !pem || len == 0) return false;
  18337. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18338. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18339. if (!store) return false;
  18340. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  18341. if (!bio) return false;
  18342. bool ok = true;
  18343. X509 *cert = nullptr;
  18344. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  18345. nullptr) {
  18346. if (X509_STORE_add_cert(store, cert) != 1) {
  18347. // Ignore duplicate errors
  18348. auto err = ERR_peek_last_error();
  18349. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  18350. ok = false;
  18351. }
  18352. }
  18353. X509_free(cert);
  18354. if (!ok) break;
  18355. }
  18356. BIO_free(bio);
  18357. // Clear any "no more certificates" errors
  18358. ERR_clear_error();
  18359. return ok;
  18360. }
  18361. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18362. if (!ctx || !file_path) return false;
  18363. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  18364. nullptr) == 1;
  18365. }
  18366. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18367. if (!ctx || !dir_path) return false;
  18368. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  18369. dir_path) == 1;
  18370. }
  18371. inline bool load_system_certs(ctx_t ctx) {
  18372. if (!ctx) return false;
  18373. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18374. #ifdef _WIN32
  18375. // Windows: Load from system certificate store (ROOT and CA)
  18376. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18377. if (!store) return false;
  18378. bool loaded_any = false;
  18379. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  18380. for (auto store_name : store_names) {
  18381. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  18382. if (!hStore) continue;
  18383. PCCERT_CONTEXT pContext = nullptr;
  18384. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  18385. nullptr) {
  18386. const unsigned char *data = pContext->pbCertEncoded;
  18387. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  18388. if (x509) {
  18389. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  18390. X509_free(x509);
  18391. }
  18392. }
  18393. CertCloseStore(hStore, 0);
  18394. }
  18395. return loaded_any;
  18396. #elif defined(__APPLE__)
  18397. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  18398. // macOS: Load from Keychain
  18399. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18400. if (!store) return false;
  18401. auto loaded_any = impl::enumerate_macos_keychain_certs(
  18402. [&](const unsigned char *data, size_t len) {
  18403. auto x509 = d2i_X509(nullptr, &data, static_cast<long>(len));
  18404. if (!x509) { return false; }
  18405. auto added = X509_STORE_add_cert(store, x509) == 1;
  18406. X509_free(x509);
  18407. return added;
  18408. });
  18409. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  18410. #else
  18411. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  18412. #endif
  18413. #else
  18414. // Other Unix: use default verify paths
  18415. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  18416. #endif
  18417. }
  18418. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18419. const char *password) {
  18420. if (!ctx || !cert || !key) return false;
  18421. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18422. // Load certificate
  18423. auto cert_bio = BIO_new_mem_buf(cert, -1);
  18424. if (!cert_bio) return false;
  18425. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  18426. BIO_free(cert_bio);
  18427. if (!x509) return false;
  18428. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  18429. X509_free(x509);
  18430. if (!cert_ok) return false;
  18431. // Load private key
  18432. auto key_bio = BIO_new_mem_buf(key, -1);
  18433. if (!key_bio) return false;
  18434. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  18435. password ? const_cast<char *>(password)
  18436. : nullptr);
  18437. BIO_free(key_bio);
  18438. if (!pkey) return false;
  18439. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  18440. EVP_PKEY_free(pkey);
  18441. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  18442. }
  18443. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18444. const char *key_path, const char *password) {
  18445. if (!ctx || !cert_path || !key_path) return false;
  18446. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18447. if (password && password[0] != '\0') {
  18448. SSL_CTX_set_default_passwd_cb_userdata(
  18449. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  18450. }
  18451. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  18452. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  18453. }
  18454. inline ctx_t create_server_context() {
  18455. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  18456. if (ctx) {
  18457. // No renegotiation, as on the other backends: it would run a handshake
  18458. // that SSLServer::update_certs_pem() does not wait for
  18459. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  18460. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  18461. SSL_OP_NO_RENEGOTIATION);
  18462. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  18463. // Without one, a client resuming its session is sent a fatal alert once
  18464. // client certificates are verified.
  18465. static const unsigned char sid_ctx[] = "cpp-httplib";
  18466. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  18467. }
  18468. return static_cast<ctx_t>(ctx);
  18469. }
  18470. inline void set_verify_client(ctx_t ctx, bool require) {
  18471. if (!ctx) return;
  18472. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  18473. }
  18474. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18475. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  18476. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18477. SSL *ssl = SSL_new(ssl_ctx);
  18478. if (!ssl) return nullptr;
  18479. // Disable auto-retry for proper non-blocking I/O handling
  18480. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  18481. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  18482. if (!bio) {
  18483. SSL_free(ssl);
  18484. return nullptr;
  18485. }
  18486. SSL_set_bio(ssl, bio, bio);
  18487. return static_cast<session_t>(ssl);
  18488. }
  18489. inline void free_session(session_t session) {
  18490. if (session) { SSL_free(static_cast<SSL *>(session)); }
  18491. }
  18492. inline bool set_sni(session_t session, const char *hostname,
  18493. bool verify_hostname) {
  18494. if (!session || !hostname) return false;
  18495. auto ssl = static_cast<SSL *>(session);
  18496. // The handshake's chain verification then checks the name as well
  18497. if (verify_hostname) {
  18498. auto param = SSL_get0_param(ssl);
  18499. X509_VERIFY_PARAM_set_hostflags(param, X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
  18500. if (X509_VERIFY_PARAM_set1_host(param, hostname, strlen(hostname)) != 1) {
  18501. return false;
  18502. }
  18503. }
  18504. #if defined(OPENSSL_IS_BORINGSSL)
  18505. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  18506. #else
  18507. // Direct call instead of macro to suppress -Wold-style-cast warning
  18508. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  18509. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  18510. #endif
  18511. }
  18512. inline TlsError connect(session_t session) {
  18513. if (!session) { return TlsError(); }
  18514. auto ssl = static_cast<SSL *>(session);
  18515. auto ret = SSL_connect(ssl);
  18516. TlsError err;
  18517. if (ret == 1) {
  18518. err.code = ErrorCode::Success;
  18519. } else {
  18520. impl::fill_connect_error(ssl, ret, err);
  18521. }
  18522. return err;
  18523. }
  18524. inline TlsError accept(session_t session) {
  18525. if (!session) { return TlsError(); }
  18526. auto ssl = static_cast<SSL *>(session);
  18527. auto ret = SSL_accept(ssl);
  18528. TlsError err;
  18529. if (ret == 1) {
  18530. err.code = ErrorCode::Success;
  18531. } else {
  18532. auto ssl_err = SSL_get_error(ssl, ret);
  18533. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  18534. err.backend_code = ERR_get_error();
  18535. }
  18536. return err;
  18537. }
  18538. inline bool connect_nonblocking(session_t session, socket_t sock,
  18539. time_t timeout_sec, time_t timeout_usec,
  18540. TlsError *err,
  18541. const std::function<bool()> &interrupted) {
  18542. if (!session) {
  18543. if (err) { err->code = ErrorCode::Fatal; }
  18544. return false;
  18545. }
  18546. auto ssl = static_cast<SSL *>(session);
  18547. auto bio = SSL_get_rbio(ssl);
  18548. // Set non-blocking mode for handshake
  18549. detail::set_nonblocking(sock, true);
  18550. if (bio) { BIO_set_nbio(bio, 1); }
  18551. auto cleanup = detail::scope_exit([&]() {
  18552. // Restore blocking mode after handshake
  18553. if (bio) { BIO_set_nbio(bio, 0); }
  18554. detail::set_nonblocking(sock, false);
  18555. });
  18556. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18557. auto res = 0;
  18558. while ((res = SSL_connect(ssl)) != 1) {
  18559. auto ssl_err = SSL_get_error(ssl, res);
  18560. switch (ssl_err) {
  18561. case SSL_ERROR_WANT_READ:
  18562. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  18563. continue;
  18564. }
  18565. break;
  18566. case SSL_ERROR_WANT_WRITE:
  18567. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  18568. continue;
  18569. }
  18570. break;
  18571. default: break;
  18572. }
  18573. if (err) { impl::fill_connect_error(ssl, res, *err); }
  18574. return false;
  18575. }
  18576. if (err) { err->code = ErrorCode::Success; }
  18577. return true;
  18578. }
  18579. inline bool accept_nonblocking(session_t session, socket_t sock,
  18580. time_t timeout_sec, time_t timeout_usec,
  18581. TlsError *err) {
  18582. if (!session) {
  18583. if (err) { err->code = ErrorCode::Fatal; }
  18584. return false;
  18585. }
  18586. auto ssl = static_cast<SSL *>(session);
  18587. auto bio = SSL_get_rbio(ssl);
  18588. // Set non-blocking mode for handshake
  18589. detail::set_nonblocking(sock, true);
  18590. if (bio) { BIO_set_nbio(bio, 1); }
  18591. auto cleanup = detail::scope_exit([&]() {
  18592. // Restore blocking mode after handshake
  18593. if (bio) { BIO_set_nbio(bio, 0); }
  18594. detail::set_nonblocking(sock, false);
  18595. });
  18596. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18597. auto res = 0;
  18598. while ((res = SSL_accept(ssl)) != 1) {
  18599. auto ssl_err = SSL_get_error(ssl, res);
  18600. switch (ssl_err) {
  18601. case SSL_ERROR_WANT_READ:
  18602. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18603. break;
  18604. case SSL_ERROR_WANT_WRITE:
  18605. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18606. break;
  18607. default: break;
  18608. }
  18609. if (err) {
  18610. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  18611. err->backend_code = ERR_get_error();
  18612. }
  18613. return false;
  18614. }
  18615. if (err) { err->code = ErrorCode::Success; }
  18616. return true;
  18617. }
  18618. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18619. if (!session || !buf) {
  18620. err.code = ErrorCode::Fatal;
  18621. return -1;
  18622. }
  18623. auto ssl = static_cast<SSL *>(session);
  18624. constexpr auto max_len =
  18625. static_cast<size_t>((std::numeric_limits<int>::max)());
  18626. if (len > max_len) { len = max_len; }
  18627. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  18628. if (ret > 0) {
  18629. err.code = ErrorCode::Success;
  18630. return ret;
  18631. }
  18632. auto ssl_err = SSL_get_error(ssl, ret);
  18633. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  18634. if (err.code == ErrorCode::PeerClosed) {
  18635. return 0;
  18636. } // Gracefully handle the peer closed state.
  18637. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  18638. return -1;
  18639. }
  18640. inline ssize_t write(session_t session, const void *buf, size_t len,
  18641. TlsError &err) {
  18642. if (!session || !buf) {
  18643. err.code = ErrorCode::Fatal;
  18644. return -1;
  18645. }
  18646. auto ssl = static_cast<SSL *>(session);
  18647. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  18648. if (ret > 0) {
  18649. err.code = ErrorCode::Success;
  18650. return ret;
  18651. }
  18652. auto ssl_err = SSL_get_error(ssl, ret);
  18653. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  18654. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  18655. return -1;
  18656. }
  18657. inline int pending(const_session_t session) {
  18658. if (!session) return 0;
  18659. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  18660. }
  18661. inline void shutdown(session_t session, bool graceful) {
  18662. if (!session) return;
  18663. auto ssl = static_cast<SSL *>(session);
  18664. if (graceful) {
  18665. // Send close_notify without waiting for the peer's. The connection is
  18666. // closed right after this, so a unidirectional shutdown is enough, and an
  18667. // idle peer that never answers would otherwise hold this thread until the
  18668. // read timeout. The other backends do not wait either.
  18669. SSL_shutdown(ssl);
  18670. }
  18671. }
  18672. inline bool is_peer_closed(session_t session, socket_t sock) {
  18673. if (!session) return true;
  18674. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  18675. detail::set_nonblocking(sock, true);
  18676. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18677. auto ssl = static_cast<SSL *>(session);
  18678. char buf;
  18679. auto ret = SSL_peek(ssl, &buf, 1);
  18680. if (ret > 0) return false;
  18681. auto err = SSL_get_error(ssl, ret);
  18682. return err == SSL_ERROR_ZERO_RETURN;
  18683. }
  18684. inline cert_t get_peer_cert(const_session_t session) {
  18685. if (!session) return nullptr;
  18686. return static_cast<cert_t>(SSL_get1_peer_certificate(
  18687. static_cast<SSL *>(const_cast<void *>(session))));
  18688. }
  18689. inline size_t get_peer_certs(const_session_t session,
  18690. std::vector<cert_t> &certs) {
  18691. certs.clear();
  18692. if (!session) { return 0; }
  18693. auto ssl = static_cast<const SSL *>(session);
  18694. // On the server side, the chain leaves out the peer's own certificate
  18695. if (SSL_is_server(ssl)) {
  18696. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  18697. }
  18698. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  18699. auto count = sk_X509_num(sk);
  18700. for (decltype(count) i = 0; i < count; i++) {
  18701. auto x509 = sk_X509_value(sk, i);
  18702. X509_up_ref(x509);
  18703. certs.push_back(static_cast<cert_t>(x509));
  18704. }
  18705. }
  18706. return certs.size();
  18707. }
  18708. inline void free_cert(cert_t cert) {
  18709. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  18710. }
  18711. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18712. if (!cert || !hostname) return false;
  18713. auto x509 = static_cast<X509 *>(cert);
  18714. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  18715. if (detail::is_ip_address(hostname)) {
  18716. return X509_check_ip_asc(x509, hostname, 0) == 1;
  18717. }
  18718. return X509_check_host(x509, hostname, strlen(hostname),
  18719. X509_CHECK_FLAG_NEVER_CHECK_SUBJECT, nullptr) == 1;
  18720. }
  18721. inline uint64_t hostname_mismatch_code() {
  18722. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  18723. }
  18724. inline long get_verify_result(const_session_t session) {
  18725. if (!session) return X509_V_ERR_UNSPECIFIED;
  18726. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  18727. }
  18728. inline std::string get_cert_subject_cn(cert_t cert) {
  18729. if (!cert) return "";
  18730. auto x509 = static_cast<X509 *>(cert);
  18731. auto subject_name = X509_get_subject_name(x509);
  18732. if (!subject_name) return "";
  18733. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  18734. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  18735. if (idx < 0) return "";
  18736. auto entry = X509_NAME_get_entry(subject_name, idx);
  18737. if (!entry) return "";
  18738. auto data = X509_NAME_ENTRY_get_data(entry);
  18739. if (!data) return "";
  18740. return std::string(
  18741. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  18742. static_cast<size_t>(ASN1_STRING_length(data)));
  18743. }
  18744. inline std::string get_cert_issuer_name(cert_t cert) {
  18745. if (!cert) return "";
  18746. auto x509 = static_cast<X509 *>(cert);
  18747. auto issuer_name = X509_get_issuer_name(x509);
  18748. if (!issuer_name) return "";
  18749. char buf[256];
  18750. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  18751. return std::string(buf);
  18752. }
  18753. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18754. sans.clear();
  18755. if (!cert) return false;
  18756. auto x509 = static_cast<X509 *>(cert);
  18757. auto names = static_cast<GENERAL_NAMES *>(
  18758. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18759. if (!names) return true; // No SANs is valid
  18760. auto count = sk_GENERAL_NAME_num(names);
  18761. for (decltype(count) i = 0; i < count; i++) {
  18762. auto gen = sk_GENERAL_NAME_value(names, i);
  18763. if (!gen) continue;
  18764. SanEntry entry;
  18765. switch (gen->type) {
  18766. case GEN_DNS:
  18767. entry.type = SanType::DNS;
  18768. if (gen->d.dNSName) {
  18769. entry.value = std::string(
  18770. reinterpret_cast<const char *>(
  18771. ASN1_STRING_get0_data(gen->d.dNSName)),
  18772. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  18773. }
  18774. break;
  18775. case GEN_IPADD:
  18776. entry.type = SanType::IP;
  18777. if (gen->d.iPAddress) {
  18778. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  18779. auto len = ASN1_STRING_length(gen->d.iPAddress);
  18780. if (len == 4) {
  18781. // IPv4
  18782. char buf[INET_ADDRSTRLEN];
  18783. inet_ntop(AF_INET, data, buf, sizeof(buf));
  18784. entry.value = buf;
  18785. } else if (len == 16) {
  18786. // IPv6
  18787. char buf[INET6_ADDRSTRLEN];
  18788. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  18789. entry.value = buf;
  18790. }
  18791. }
  18792. break;
  18793. case GEN_EMAIL:
  18794. entry.type = SanType::EMAIL;
  18795. if (gen->d.rfc822Name) {
  18796. entry.value = std::string(
  18797. reinterpret_cast<const char *>(
  18798. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  18799. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  18800. }
  18801. break;
  18802. case GEN_URI:
  18803. entry.type = SanType::URI;
  18804. if (gen->d.uniformResourceIdentifier) {
  18805. entry.value = std::string(
  18806. reinterpret_cast<const char *>(
  18807. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  18808. static_cast<size_t>(
  18809. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  18810. }
  18811. break;
  18812. default: entry.type = SanType::OTHER; break;
  18813. }
  18814. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18815. }
  18816. GENERAL_NAMES_free(names);
  18817. return true;
  18818. }
  18819. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18820. time_t &not_after) {
  18821. if (!cert) return false;
  18822. auto x509 = static_cast<X509 *>(cert);
  18823. auto nb = X509_get0_notBefore(x509);
  18824. auto na = X509_get0_notAfter(x509);
  18825. if (!nb || !na) return false;
  18826. ASN1_TIME *epoch = ASN1_TIME_new();
  18827. if (!epoch) return false;
  18828. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  18829. if (!ASN1_TIME_set(epoch, 0)) return false;
  18830. int pday, psec;
  18831. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  18832. not_before = 86400 * (time_t)pday + psec;
  18833. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  18834. not_after = 86400 * (time_t)pday + psec;
  18835. return true;
  18836. }
  18837. inline std::string get_cert_serial(cert_t cert) {
  18838. if (!cert) return "";
  18839. auto x509 = static_cast<X509 *>(cert);
  18840. auto serial = X509_get_serialNumber(x509);
  18841. if (!serial) return "";
  18842. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  18843. if (!bn) return "";
  18844. auto hex = BN_bn2hex(bn);
  18845. BN_free(bn);
  18846. if (!hex) return "";
  18847. std::string result(hex);
  18848. OPENSSL_free(hex);
  18849. return result;
  18850. }
  18851. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18852. if (!cert) return false;
  18853. auto x509 = static_cast<X509 *>(cert);
  18854. auto len = i2d_X509(x509, nullptr);
  18855. if (len < 0) return false;
  18856. der.resize(static_cast<size_t>(len));
  18857. auto p = der.data();
  18858. i2d_X509(x509, &p);
  18859. return true;
  18860. }
  18861. inline const char *get_sni(const_session_t session) {
  18862. if (!session) return nullptr;
  18863. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  18864. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  18865. }
  18866. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  18867. inline uint64_t get_error() { return ERR_get_error(); }
  18868. inline std::string error_string(uint64_t code) {
  18869. char buf[256];
  18870. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  18871. sizeof(buf));
  18872. return std::string(buf);
  18873. }
  18874. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18875. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  18876. if (!mem) { return nullptr; }
  18877. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  18878. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  18879. if (!inf) { return nullptr; }
  18880. auto store = X509_STORE_new();
  18881. if (store) {
  18882. auto count = sk_X509_INFO_num(inf);
  18883. for (decltype(count) i = 0; i < count; i++) {
  18884. auto itmp = sk_X509_INFO_value(inf, i);
  18885. if (!itmp) { continue; }
  18886. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  18887. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  18888. }
  18889. }
  18890. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  18891. return static_cast<ca_store_t>(store);
  18892. }
  18893. inline void free_ca_store(ca_store_t store) {
  18894. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  18895. }
  18896. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18897. if (!ctx || !store) { return false; }
  18898. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18899. auto x509_store = static_cast<X509_STORE *>(store);
  18900. // Check if same store is already set
  18901. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  18902. // SSL_CTX_set_cert_store takes ownership and frees the old store
  18903. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  18904. return true;
  18905. }
  18906. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18907. certs.clear();
  18908. if (!ctx) { return 0; }
  18909. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18910. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18911. if (!store) { return 0; }
  18912. auto objs = impl::get_store_objects(store);
  18913. if (!objs) { return 0; }
  18914. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  18915. auto count = sk_X509_OBJECT_num(objs);
  18916. for (decltype(count) i = 0; i < count; i++) {
  18917. auto obj = sk_X509_OBJECT_value(objs, i);
  18918. if (!obj) { continue; }
  18919. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  18920. auto x509 = X509_OBJECT_get0_X509(obj);
  18921. if (x509) {
  18922. // Increment reference count so caller can free it
  18923. X509_up_ref(x509);
  18924. certs.push_back(static_cast<cert_t>(x509));
  18925. }
  18926. }
  18927. }
  18928. return certs.size();
  18929. }
  18930. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18931. std::vector<std::string> names;
  18932. if (!ctx) { return names; }
  18933. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18934. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  18935. if (!store) { return names; }
  18936. auto objs = impl::get_store_objects(store);
  18937. if (!objs) { return names; }
  18938. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  18939. auto count = sk_X509_OBJECT_num(objs);
  18940. for (decltype(count) i = 0; i < count; i++) {
  18941. auto obj = sk_X509_OBJECT_value(objs, i);
  18942. if (!obj) { continue; }
  18943. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  18944. auto x509 = X509_OBJECT_get0_X509(obj);
  18945. if (x509) {
  18946. auto subject = X509_get_subject_name(x509);
  18947. if (subject) {
  18948. char buf[512];
  18949. X509_NAME_oneline(subject, buf, sizeof(buf));
  18950. names.push_back(buf);
  18951. }
  18952. }
  18953. }
  18954. }
  18955. return names;
  18956. }
  18957. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18958. const char *key_pem, const char *password) {
  18959. if (!ctx || !cert_pem || !key_pem) { return false; }
  18960. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18961. // Load certificate from PEM
  18962. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  18963. if (!cert_bio) { return false; }
  18964. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  18965. BIO_free(cert_bio);
  18966. if (!cert) { return false; }
  18967. // Load private key from PEM
  18968. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  18969. if (!key_bio) {
  18970. X509_free(cert);
  18971. return false;
  18972. }
  18973. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  18974. password ? const_cast<char *>(password)
  18975. : nullptr);
  18976. BIO_free(key_bio);
  18977. if (!key) {
  18978. X509_free(cert);
  18979. return false;
  18980. }
  18981. // Update certificate and key
  18982. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  18983. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  18984. X509_free(cert);
  18985. EVP_PKEY_free(key);
  18986. return ret;
  18987. }
  18988. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18989. if (!ctx || !ca_pem) { return false; }
  18990. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18991. // Create new X509_STORE from PEM
  18992. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  18993. if (!store) { return false; }
  18994. // A resumed session is not verified again, so the ticket keys from before
  18995. // go, or a client verified under the old CAs could go on resuming.
  18996. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  18997. unsigned char ticket_keys[48];
  18998. #else
  18999. unsigned char ticket_keys[80];
  19000. #endif
  19001. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  19002. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  19003. sizeof(ticket_keys)) != 1) {
  19004. free_ca_store(store);
  19005. return false;
  19006. }
  19007. // SSL_CTX_set_cert_store takes ownership
  19008. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  19009. // Set client CA list for client certificate request
  19010. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  19011. if (ca_list) {
  19012. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  19013. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  19014. }
  19015. // The cached sessions go for the same reason.
  19016. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  19017. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  19018. #else
  19019. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  19020. #endif
  19021. return true;
  19022. }
  19023. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19024. if (!ctx) { return false; }
  19025. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  19026. auto index = impl::verify_callback_index();
  19027. if (index < 0) { return false; }
  19028. std::shared_ptr<VerifyCallback> *stored = nullptr;
  19029. if (callback) {
  19030. stored = new std::shared_ptr<VerifyCallback>(
  19031. std::make_shared<VerifyCallback>(std::move(callback)));
  19032. }
  19033. std::shared_ptr<VerifyCallback> *previous = nullptr;
  19034. {
  19035. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  19036. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  19037. SSL_CTX_get_ex_data(ssl_ctx, index));
  19038. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  19039. delete stored;
  19040. return false;
  19041. }
  19042. }
  19043. // A handshake running the previous callback keeps it until it returns.
  19044. delete previous;
  19045. // A resumed handshake shows no certificate to run the callback on.
  19046. if (stored) {
  19047. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  19048. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  19049. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  19050. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  19051. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  19052. #endif
  19053. }
  19054. // Keep requiring the peer's certificate if set_verify_client() asked for it
  19055. auto require =
  19056. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  19057. impl::apply_verify_mode(ssl_ctx, require);
  19058. return true;
  19059. }
  19060. inline long get_verify_error(const_session_t session) {
  19061. if (!session) { return -1; }
  19062. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  19063. return SSL_get_verify_result(ssl);
  19064. }
  19065. inline std::string verify_error_string(long error_code) {
  19066. if (error_code == X509_V_OK) { return ""; }
  19067. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  19068. return str ? str : "unknown error";
  19069. }
  19070. } // namespace tls
  19071. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  19072. /*
  19073. * Group 9: TLS abstraction layer - Mbed TLS backend
  19074. */
  19075. /*
  19076. * Mbed TLS Backend Implementation
  19077. */
  19078. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  19079. namespace tls {
  19080. namespace impl {
  19081. // Mbed TLS session wrapper
  19082. struct MbedTlsSession {
  19083. mbedtls_ssl_context ssl;
  19084. socket_t sock = INVALID_SOCKET;
  19085. std::string hostname; // For client: set via set_sni
  19086. std::string sni_hostname; // For server: received from client via SNI callback
  19087. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  19088. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  19089. // (e.g. a response that arrived while this side was still in its post-write
  19090. // check), the byte is pushed back here and served by the next read().
  19091. unsigned char peeked_byte = 0;
  19092. bool has_peeked_byte = false;
  19093. // Set by set_sni() when the caller disabled hostname verification, so the
  19094. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  19095. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  19096. // OpenSSL and wolfSSL keep them independent).
  19097. bool suppress_hostname_mismatch = false;
  19098. // Copied from the owning MbedTlsContext at creation, so a handshake only
  19099. // ever runs the callback of its own context.
  19100. VerifyCallback verify_callback;
  19101. bool is_server = false;
  19102. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  19103. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  19104. MbedTlsSession(const MbedTlsSession &) = delete;
  19105. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  19106. };
  19107. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  19108. // queue)
  19109. inline int &mbedtls_last_error() {
  19110. static thread_local int err = 0;
  19111. return err;
  19112. }
  19113. // Helper to map Mbed TLS error to ErrorCode
  19114. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  19115. uint32_t verify_flags) {
  19116. if (ret == 0) { return ErrorCode::Success; }
  19117. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  19118. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  19119. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  19120. return ErrorCode::PeerClosed;
  19121. }
  19122. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  19123. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  19124. out_errno = errno;
  19125. return ErrorCode::SyscallError;
  19126. }
  19127. if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
  19128. // EOF without close_notify
  19129. out_errno = 0;
  19130. return ErrorCode::SyscallError;
  19131. }
  19132. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  19133. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  19134. // the handshake's chain verification (see set_sni()); a mismatch there
  19135. // is reported the same way as any other verify_flags bit. Report it as
  19136. // HostnameMismatch, matching the other backends and the post-handshake
  19137. // identity check below, but only when naming is the sole problem -
  19138. // if the chain itself is also untrusted/expired/etc., that takes
  19139. // priority over the naming detail.
  19140. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  19141. return ErrorCode::HostnameMismatch;
  19142. }
  19143. return ErrorCode::CertVerifyFailed;
  19144. }
  19145. return ErrorCode::Fatal;
  19146. }
  19147. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  19148. // return value, including the verify-flags-dependent HostnameMismatch
  19149. // mapping; shared by connect() and connect_nonblocking() so the
  19150. // backend_code policy for that mapping only lives in one place.
  19151. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  19152. int ret) {
  19153. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  19154. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  19155. err.backend_code = err.code == ErrorCode::HostnameMismatch
  19156. ? static_cast<uint64_t>(verify_flags)
  19157. : static_cast<uint64_t>(-ret);
  19158. }
  19159. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  19160. // non-fatal notification delivered between records, not an error and not
  19161. // application data, so I/O calls that see it should just be retried. Kept in
  19162. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  19163. // splitting the closing brace across an #if.
  19164. inline bool mbedtls_is_session_ticket(int ret) {
  19165. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  19166. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  19167. #else
  19168. (void)ret;
  19169. return false;
  19170. #endif
  19171. }
  19172. // BIO-like send callback for Mbed TLS
  19173. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  19174. size_t len) {
  19175. auto sock = *static_cast<socket_t *>(ctx);
  19176. #ifdef _WIN32
  19177. auto ret =
  19178. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  19179. if (ret == SOCKET_ERROR) {
  19180. int err = WSAGetLastError();
  19181. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  19182. return MBEDTLS_ERR_NET_SEND_FAILED;
  19183. }
  19184. #else
  19185. auto ret = send(sock, buf, len, 0);
  19186. if (ret < 0) {
  19187. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  19188. return MBEDTLS_ERR_SSL_WANT_WRITE;
  19189. }
  19190. return MBEDTLS_ERR_NET_SEND_FAILED;
  19191. }
  19192. #endif
  19193. return static_cast<int>(ret);
  19194. }
  19195. // BIO-like recv callback for Mbed TLS
  19196. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  19197. auto sock = *static_cast<socket_t *>(ctx);
  19198. #ifdef _WIN32
  19199. auto ret =
  19200. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  19201. if (ret == SOCKET_ERROR) {
  19202. int err = WSAGetLastError();
  19203. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  19204. return MBEDTLS_ERR_NET_RECV_FAILED;
  19205. }
  19206. #else
  19207. auto ret = recv(sock, buf, len, 0);
  19208. if (ret < 0) {
  19209. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  19210. return MBEDTLS_ERR_SSL_WANT_READ;
  19211. }
  19212. return MBEDTLS_ERR_NET_RECV_FAILED;
  19213. }
  19214. #endif
  19215. // EOF is MBEDTLS_ERR_SSL_CONN_EOF; only a close_notify is a clean end
  19216. return static_cast<int>(ret);
  19217. }
  19218. // MbedTlsContext constructor/destructor implementations
  19219. inline MbedTlsContext::MbedTlsContext() {
  19220. mbedtls_ssl_config_init(&conf);
  19221. #ifndef CPPHTTPLIB_MBEDTLS_V4
  19222. mbedtls_entropy_init(&entropy);
  19223. mbedtls_ctr_drbg_init(&ctr_drbg);
  19224. #endif
  19225. mbedtls_x509_crt_init(&ca_chain);
  19226. mbedtls_x509_crt_init(&own_cert);
  19227. mbedtls_pk_init(&own_key);
  19228. }
  19229. inline MbedTlsContext::~MbedTlsContext() {
  19230. mbedtls_pk_free(&own_key);
  19231. mbedtls_x509_crt_free(&own_cert);
  19232. mbedtls_x509_crt_free(&ca_chain);
  19233. #ifndef CPPHTTPLIB_MBEDTLS_V4
  19234. mbedtls_ctr_drbg_free(&ctr_drbg);
  19235. mbedtls_entropy_free(&entropy);
  19236. #endif
  19237. mbedtls_ssl_config_free(&conf);
  19238. }
  19239. // Thread-local storage for SNI captured during handshake
  19240. // This is needed because the SNI callback doesn't have a way to pass
  19241. // session-specific data before the session is fully set up
  19242. inline std::string &mbedpending_sni() {
  19243. static thread_local std::string sni;
  19244. return sni;
  19245. }
  19246. // SNI callback for Mbed TLS server to capture client's SNI hostname
  19247. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  19248. const unsigned char *name, size_t name_len) {
  19249. (void)p_ctx;
  19250. (void)ssl;
  19251. // Store SNI name in thread-local storage
  19252. // It will be retrieved and stored in the session after handshake
  19253. if (name && name_len > 0) {
  19254. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  19255. } else {
  19256. mbedpending_sni().clear();
  19257. }
  19258. return 0; // Accept any SNI
  19259. }
  19260. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  19261. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  19262. }
  19263. // MbedTLS verify callback wrapper
  19264. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  19265. int cert_depth, uint32_t *flags) {
  19266. // data points to the MbedTlsSession
  19267. auto *session = static_cast<MbedTlsSession *>(data);
  19268. // set_sni() disabled hostname verification for this session: ignore the
  19269. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  19270. // pass/fail decision still comes from the remaining flags (and, below, from
  19271. // the user's own verify callback).
  19272. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  19273. const auto &callback = session->verify_callback;
  19274. if (!callback) { return 0; } // Continue with default verification
  19275. // Build context
  19276. VerifyContext verify_ctx;
  19277. verify_ctx.session = static_cast<session_t>(session);
  19278. verify_ctx.cert = static_cast<cert_t>(crt);
  19279. verify_ctx.depth = cert_depth;
  19280. verify_ctx.preverify_ok = (*flags == 0);
  19281. verify_ctx.error_code = static_cast<long>(*flags);
  19282. // Convert Mbed TLS flags to error string
  19283. static thread_local char error_buf[256];
  19284. if (*flags != 0) {
  19285. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  19286. verify_ctx.error_string = error_buf;
  19287. } else {
  19288. verify_ctx.error_string = nullptr;
  19289. }
  19290. bool accepted = run_verify_callback(callback, verify_ctx);
  19291. if (accepted) {
  19292. // Overrides the built-in verification only on a server, as on OpenSSL and
  19293. // wolfSSL, whose clients check the verify result after the handshake
  19294. if (session->is_server) { *flags = 0; }
  19295. return 0;
  19296. }
  19297. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  19298. }
  19299. // Sets the authentication mode from whether the peer's certificate is required
  19300. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  19301. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  19302. inline void apply_verify_mode(MbedTlsContext &mctx) {
  19303. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  19304. if (mctx.verify_client) {
  19305. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  19306. } else if (mctx.verify_callback) {
  19307. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  19308. }
  19309. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  19310. }
  19311. } // namespace impl
  19312. inline ctx_t create_client_context() {
  19313. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  19314. if (!ctx) { return nullptr; }
  19315. ctx->is_server = false;
  19316. #ifdef CPPHTTPLIB_MBEDTLS_V4
  19317. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  19318. if (!detail::ensure_mbedtls_psa_crypto()) {
  19319. delete ctx;
  19320. return nullptr;
  19321. }
  19322. int ret;
  19323. #else
  19324. // Seed the random number generator
  19325. const char *pers = "httplib_client";
  19326. int ret = mbedtls_ctr_drbg_seed(
  19327. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  19328. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  19329. if (ret != 0) {
  19330. impl::mbedtls_last_error() = ret;
  19331. delete ctx;
  19332. return nullptr;
  19333. }
  19334. #endif
  19335. // Set up SSL config for client
  19336. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  19337. MBEDTLS_SSL_TRANSPORT_STREAM,
  19338. MBEDTLS_SSL_PRESET_DEFAULT);
  19339. if (ret != 0) {
  19340. impl::mbedtls_last_error() = ret;
  19341. delete ctx;
  19342. return nullptr;
  19343. }
  19344. #ifndef CPPHTTPLIB_MBEDTLS_V4
  19345. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  19346. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  19347. #endif
  19348. // Default: verify peer certificate
  19349. ctx->verify_client = true;
  19350. impl::apply_verify_mode(*ctx);
  19351. // Set minimum TLS version to 1.2
  19352. #ifdef CPPHTTPLIB_MBEDTLS_V3
  19353. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  19354. #else
  19355. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  19356. MBEDTLS_SSL_MINOR_VERSION_3);
  19357. #endif
  19358. return static_cast<ctx_t>(ctx);
  19359. }
  19360. inline ctx_t create_server_context() {
  19361. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  19362. if (!ctx) { return nullptr; }
  19363. ctx->is_server = true;
  19364. #ifdef CPPHTTPLIB_MBEDTLS_V4
  19365. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  19366. if (!detail::ensure_mbedtls_psa_crypto()) {
  19367. delete ctx;
  19368. return nullptr;
  19369. }
  19370. int ret;
  19371. #else
  19372. // Seed the random number generator
  19373. const char *pers = "httplib_server";
  19374. int ret = mbedtls_ctr_drbg_seed(
  19375. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  19376. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  19377. if (ret != 0) {
  19378. impl::mbedtls_last_error() = ret;
  19379. delete ctx;
  19380. return nullptr;
  19381. }
  19382. #endif
  19383. // Set up SSL config for server
  19384. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  19385. MBEDTLS_SSL_TRANSPORT_STREAM,
  19386. MBEDTLS_SSL_PRESET_DEFAULT);
  19387. if (ret != 0) {
  19388. impl::mbedtls_last_error() = ret;
  19389. delete ctx;
  19390. return nullptr;
  19391. }
  19392. #ifndef CPPHTTPLIB_MBEDTLS_V4
  19393. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  19394. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  19395. #endif
  19396. // Default: don't verify client
  19397. impl::apply_verify_mode(*ctx);
  19398. // Set minimum TLS version to 1.2
  19399. #ifdef CPPHTTPLIB_MBEDTLS_V3
  19400. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  19401. #else
  19402. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  19403. MBEDTLS_SSL_MINOR_VERSION_3);
  19404. #endif
  19405. // Set SNI callback to capture client's SNI hostname
  19406. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  19407. return static_cast<ctx_t>(ctx);
  19408. }
  19409. inline void free_context(ctx_t ctx) {
  19410. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  19411. }
  19412. inline bool set_min_version(ctx_t ctx, Version version) {
  19413. if (!ctx) { return false; }
  19414. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19415. #ifdef CPPHTTPLIB_MBEDTLS_V3
  19416. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  19417. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  19418. if (version >= Version::TLS1_3) {
  19419. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  19420. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  19421. #endif
  19422. }
  19423. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  19424. #else
  19425. // Mbed TLS 2.x uses major/minor version numbers
  19426. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  19427. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  19428. if (version >= Version::TLS1_3) {
  19429. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  19430. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  19431. #else
  19432. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  19433. #endif
  19434. }
  19435. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  19436. #endif
  19437. return true;
  19438. }
  19439. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19440. if (!ctx || !pem) { return false; }
  19441. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19442. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  19443. // Add null terminator if not present
  19444. std::string pem_str(pem, len);
  19445. int ret = mbedtls_x509_crt_parse(
  19446. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  19447. pem_str.size() + 1);
  19448. if (ret != 0) {
  19449. impl::mbedtls_last_error() = ret;
  19450. return false;
  19451. }
  19452. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  19453. return true;
  19454. }
  19455. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19456. if (!ctx || !file_path) { return false; }
  19457. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19458. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  19459. if (ret != 0) {
  19460. impl::mbedtls_last_error() = ret;
  19461. return false;
  19462. }
  19463. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  19464. return true;
  19465. }
  19466. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19467. if (!ctx || !dir_path) { return false; }
  19468. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19469. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  19470. if (ret < 0) { // Returns number of certs on success, negative on error
  19471. impl::mbedtls_last_error() = ret;
  19472. return false;
  19473. }
  19474. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  19475. return true;
  19476. }
  19477. inline bool load_system_certs(ctx_t ctx) {
  19478. if (!ctx) { return false; }
  19479. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19480. bool loaded = false;
  19481. #ifdef _WIN32
  19482. loaded = impl::enumerate_windows_system_certs(
  19483. [&](const unsigned char *data, size_t len) {
  19484. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  19485. });
  19486. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19487. loaded = impl::enumerate_macos_keychain_certs(
  19488. [&](const unsigned char *data, size_t len) {
  19489. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  19490. });
  19491. #else
  19492. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19493. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  19494. loaded = true;
  19495. break;
  19496. }
  19497. }
  19498. if (!loaded) {
  19499. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19500. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  19501. loaded = true;
  19502. break;
  19503. }
  19504. }
  19505. }
  19506. #endif
  19507. if (loaded) {
  19508. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  19509. }
  19510. return loaded;
  19511. }
  19512. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19513. const char *password) {
  19514. if (!ctx || !cert || !key) { return false; }
  19515. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19516. // Parse certificate
  19517. std::string cert_str(cert);
  19518. int ret = mbedtls_x509_crt_parse(
  19519. &mctx->own_cert,
  19520. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  19521. cert_str.size() + 1);
  19522. if (ret != 0) {
  19523. impl::mbedtls_last_error() = ret;
  19524. return false;
  19525. }
  19526. // Parse private key
  19527. std::string key_str(key);
  19528. const unsigned char *pwd =
  19529. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  19530. size_t pwd_len = password ? strlen(password) : 0;
  19531. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19532. ret = mbedtls_pk_parse_key(
  19533. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  19534. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  19535. &mctx->ctr_drbg);
  19536. #else
  19537. ret = mbedtls_pk_parse_key(
  19538. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  19539. key_str.size() + 1, pwd, pwd_len);
  19540. #endif
  19541. if (ret != 0) {
  19542. impl::mbedtls_last_error() = ret;
  19543. return false;
  19544. }
  19545. // Verify that the certificate and private key match.
  19546. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  19547. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  19548. #ifndef CPPHTTPLIB_MBEDTLS_V4
  19549. #ifdef CPPHTTPLIB_MBEDTLS_V3
  19550. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  19551. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  19552. #else
  19553. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  19554. #endif
  19555. if (ret != 0) {
  19556. impl::mbedtls_last_error() = ret;
  19557. return false;
  19558. }
  19559. #endif
  19560. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  19561. if (ret != 0) {
  19562. impl::mbedtls_last_error() = ret;
  19563. return false;
  19564. }
  19565. return true;
  19566. }
  19567. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19568. const char *key_path, const char *password) {
  19569. if (!ctx || !cert_path || !key_path) { return false; }
  19570. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19571. // Parse certificate file
  19572. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  19573. if (ret != 0) {
  19574. impl::mbedtls_last_error() = ret;
  19575. return false;
  19576. }
  19577. // Parse private key file
  19578. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19579. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  19580. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  19581. #else
  19582. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  19583. #endif
  19584. if (ret != 0) {
  19585. impl::mbedtls_last_error() = ret;
  19586. return false;
  19587. }
  19588. // Verify that the certificate and private key match.
  19589. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  19590. #ifndef CPPHTTPLIB_MBEDTLS_V4
  19591. #ifdef CPPHTTPLIB_MBEDTLS_V3
  19592. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  19593. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  19594. #else
  19595. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  19596. #endif
  19597. if (ret != 0) {
  19598. impl::mbedtls_last_error() = ret;
  19599. return false;
  19600. }
  19601. #endif
  19602. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  19603. if (ret != 0) {
  19604. impl::mbedtls_last_error() = ret;
  19605. return false;
  19606. }
  19607. return true;
  19608. }
  19609. inline void set_verify_client(ctx_t ctx, bool require) {
  19610. if (!ctx) { return; }
  19611. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19612. mctx->verify_client = require;
  19613. impl::apply_verify_mode(*mctx);
  19614. }
  19615. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19616. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19617. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  19618. auto session = new (std::nothrow) impl::MbedTlsSession();
  19619. if (!session) { return nullptr; }
  19620. session->sock = sock;
  19621. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  19622. if (ret != 0) {
  19623. impl::mbedtls_last_error() = ret;
  19624. delete session;
  19625. return nullptr;
  19626. }
  19627. // Explicitly opt out of in-handshake hostname verification by default;
  19628. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  19629. // fails outright when no hostname was set. set_sni() installs the real
  19630. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  19631. // caller verifies the certificate identity post-handshake via
  19632. // verify_hostname().
  19633. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  19634. // Set BIO callbacks
  19635. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  19636. impl::mbedtls_net_recv_cb, nullptr);
  19637. // Installed always, as it also masks the hostname mismatch that set_sni()
  19638. // may ask for. The session runs its own copy of the user's callback, which
  19639. // set_verify_callback() cannot replace under a handshake.
  19640. session->verify_callback = mctx->verify_callback;
  19641. session->is_server = mctx->is_server;
  19642. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  19643. return static_cast<session_t>(session);
  19644. }
  19645. inline void free_session(session_t session) {
  19646. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  19647. }
  19648. inline bool set_sni(session_t session, const char *hostname,
  19649. bool verify_hostname) {
  19650. if (!session || !hostname) { return false; }
  19651. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19652. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  19653. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  19654. // independently, so a disabled hostname check is handled below by masking
  19655. // the resulting mismatch flag instead of skipping this call.
  19656. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  19657. if (ret != 0) {
  19658. impl::mbedtls_last_error() = ret;
  19659. return false;
  19660. }
  19661. msession->hostname = hostname;
  19662. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  19663. return true;
  19664. }
  19665. inline TlsError connect(session_t session) {
  19666. TlsError err;
  19667. if (!session) {
  19668. err.code = ErrorCode::Fatal;
  19669. return err;
  19670. }
  19671. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19672. int ret;
  19673. do {
  19674. ret = mbedtls_ssl_handshake(&msession->ssl);
  19675. } while (impl::mbedtls_is_session_ticket(ret));
  19676. if (ret == 0) {
  19677. err.code = ErrorCode::Success;
  19678. } else {
  19679. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  19680. impl::mbedtls_last_error() = ret;
  19681. }
  19682. return err;
  19683. }
  19684. inline TlsError accept(session_t session) {
  19685. // A failed handshake leaves its SNI behind, so start without it
  19686. impl::mbedpending_sni().clear();
  19687. // Same as connect for Mbed TLS - handshake works for both client and server
  19688. auto result = connect(session);
  19689. // After successful handshake, capture SNI from thread-local storage
  19690. if (result.code == ErrorCode::Success && session) {
  19691. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19692. msession->sni_hostname = std::move(impl::mbedpending_sni());
  19693. }
  19694. return result;
  19695. }
  19696. inline bool connect_nonblocking(session_t session, socket_t sock,
  19697. time_t timeout_sec, time_t timeout_usec,
  19698. TlsError *err,
  19699. const std::function<bool()> &interrupted) {
  19700. if (!session) {
  19701. if (err) { err->code = ErrorCode::Fatal; }
  19702. return false;
  19703. }
  19704. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19705. // Set socket to non-blocking mode
  19706. detail::set_nonblocking(sock, true);
  19707. auto cleanup =
  19708. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19709. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19710. int ret;
  19711. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  19712. // Non-fatal TLS 1.3 ticket; retry immediately.
  19713. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  19714. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  19715. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  19716. continue;
  19717. }
  19718. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  19719. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  19720. continue;
  19721. }
  19722. }
  19723. // TlsError or timeout
  19724. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  19725. impl::mbedtls_last_error() = ret;
  19726. return false;
  19727. }
  19728. if (err) { err->code = ErrorCode::Success; }
  19729. return true;
  19730. }
  19731. inline bool accept_nonblocking(session_t session, socket_t sock,
  19732. time_t timeout_sec, time_t timeout_usec,
  19733. TlsError *err) {
  19734. // A failed handshake leaves its SNI behind, so start without it
  19735. impl::mbedpending_sni().clear();
  19736. // Same implementation as connect for Mbed TLS
  19737. bool result =
  19738. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  19739. // After successful handshake, capture SNI from thread-local storage
  19740. if (result && session) {
  19741. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19742. msession->sni_hostname = std::move(impl::mbedpending_sni());
  19743. }
  19744. return result;
  19745. }
  19746. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19747. if (!session || !buf) {
  19748. err.code = ErrorCode::Fatal;
  19749. return -1;
  19750. }
  19751. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19752. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  19753. if (msession->has_peeked_byte) {
  19754. if (len == 0) { return 0; }
  19755. auto p = static_cast<unsigned char *>(buf);
  19756. p[0] = msession->peeked_byte;
  19757. msession->has_peeked_byte = false;
  19758. size_t n = 1;
  19759. // Top up with any already-decrypted bytes without risking a block.
  19760. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  19761. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  19762. if (extra > 0) { n += static_cast<size_t>(extra); }
  19763. }
  19764. err.code = ErrorCode::Success;
  19765. return static_cast<ssize_t>(n);
  19766. }
  19767. int ret;
  19768. do {
  19769. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  19770. len);
  19771. } while (impl::mbedtls_is_session_ticket(ret));
  19772. if (ret > 0) {
  19773. err.code = ErrorCode::Success;
  19774. return static_cast<ssize_t>(ret);
  19775. }
  19776. // 0 means EOF without close_notify, which is an error as on OpenSSL
  19777. if (ret == 0) { ret = MBEDTLS_ERR_SSL_CONN_EOF; }
  19778. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  19779. err.backend_code = static_cast<uint64_t>(-ret);
  19780. impl::mbedtls_last_error() = ret;
  19781. // mbedTLS signals a clean close_notify via a negative error code rather
  19782. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  19783. if (err.code == ErrorCode::PeerClosed) { return 0; }
  19784. return -1;
  19785. }
  19786. inline ssize_t write(session_t session, const void *buf, size_t len,
  19787. TlsError &err) {
  19788. if (!session || !buf) {
  19789. err.code = ErrorCode::Fatal;
  19790. return -1;
  19791. }
  19792. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19793. int ret;
  19794. do {
  19795. ret = mbedtls_ssl_write(&msession->ssl,
  19796. static_cast<const unsigned char *>(buf), len);
  19797. } while (impl::mbedtls_is_session_ticket(ret));
  19798. if (ret > 0) {
  19799. err.code = ErrorCode::Success;
  19800. return static_cast<ssize_t>(ret);
  19801. }
  19802. if (ret == 0) {
  19803. err.code = ErrorCode::PeerClosed;
  19804. return 0;
  19805. }
  19806. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  19807. err.backend_code = static_cast<uint64_t>(-ret);
  19808. impl::mbedtls_last_error() = ret;
  19809. return -1;
  19810. }
  19811. inline int pending(const_session_t session) {
  19812. if (!session) { return 0; }
  19813. auto msession =
  19814. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19815. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  19816. (msession->has_peeked_byte ? 1 : 0);
  19817. }
  19818. inline void shutdown(session_t session, bool graceful) {
  19819. if (!session) { return; }
  19820. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19821. if (graceful) {
  19822. // Try to send close_notify, but don't block forever
  19823. int ret;
  19824. int attempts = 0;
  19825. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  19826. attempts < 3) {
  19827. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  19828. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  19829. break;
  19830. }
  19831. attempts++;
  19832. }
  19833. }
  19834. }
  19835. inline bool is_peer_closed(session_t session, socket_t sock) {
  19836. if (!session || sock == INVALID_SOCKET) { return true; }
  19837. auto msession = static_cast<impl::MbedTlsSession *>(session);
  19838. // Check if there's already decrypted or pushed-back data available.
  19839. // If so, the connection is definitely alive.
  19840. if (msession->has_peeked_byte ||
  19841. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  19842. return false;
  19843. }
  19844. // Set socket to non-blocking to avoid blocking on read
  19845. detail::set_nonblocking(sock, true);
  19846. auto cleanup =
  19847. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19848. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  19849. // on application data — e.g. a response that already arrived — push the
  19850. // byte back so the next read() delivers it instead of losing it.
  19851. unsigned char buf;
  19852. int ret;
  19853. do {
  19854. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  19855. } while (impl::mbedtls_is_session_ticket(ret));
  19856. // If we got data or WANT_READ (would block), connection is alive
  19857. if (ret > 0) {
  19858. msession->peeked_byte = buf;
  19859. msession->has_peeked_byte = true;
  19860. return false;
  19861. }
  19862. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  19863. // If we get a peer close notify or a connection reset, the peer is closed
  19864. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  19865. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  19866. }
  19867. inline cert_t get_peer_cert(const_session_t session) {
  19868. if (!session) { return nullptr; }
  19869. auto msession =
  19870. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19871. // Mbed TLS returns a pointer to the internal peer cert chain.
  19872. // WARNING: This pointer is only valid while the session is active.
  19873. // Do not use the certificate after calling free_session().
  19874. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  19875. return const_cast<mbedtls_x509_crt *>(cert);
  19876. }
  19877. inline size_t get_peer_certs(const_session_t session,
  19878. std::vector<cert_t> &certs) {
  19879. certs.clear();
  19880. // Mbed TLS parses the whole received chain into a list headed by the peer
  19881. // certificate, owned by the session like get_peer_cert()'s result
  19882. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  19883. crt && crt->raw.len > 0; crt = crt->next) {
  19884. certs.push_back(static_cast<cert_t>(crt));
  19885. }
  19886. return certs.size();
  19887. }
  19888. inline void free_cert(cert_t cert) {
  19889. // Mbed TLS: every cert_t handed out points into a session's or a context's
  19890. // chain, so there is nothing to free. Callers still call this for the other
  19891. // backends.
  19892. (void)cert;
  19893. }
  19894. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19895. if (!cert || !hostname) { return false; }
  19896. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  19897. std::string host_str(hostname);
  19898. // Check if hostname is an IP address (IPv4 or IPv6)
  19899. unsigned char ip_bytes[16];
  19900. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19901. auto is_ip = ip_len > 0;
  19902. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  19903. // in buf.tag and the raw value in buf.p / buf.len.
  19904. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  19905. if (!san->buf.p || san->buf.len == 0) { continue; }
  19906. const unsigned char *p = san->buf.p;
  19907. size_t len = san->buf.len;
  19908. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  19909. if (is_ip) {
  19910. // For an IP host, only a matching iPAddress SAN of the same family
  19911. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  19912. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  19913. memcmp(p, ip_bytes, ip_len) == 0) {
  19914. return true;
  19915. }
  19916. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  19917. std::string san_name(reinterpret_cast<const char *>(p), len);
  19918. if (detail::match_hostname(san_name, host_str)) { return true; }
  19919. }
  19920. }
  19921. return false;
  19922. }
  19923. inline uint64_t hostname_mismatch_code() {
  19924. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  19925. }
  19926. inline long get_verify_result(const_session_t session) {
  19927. if (!session) { return -1; }
  19928. auto msession =
  19929. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19930. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  19931. // Return 0 (X509_V_OK equivalent) if verification passed
  19932. return flags == 0 ? 0 : static_cast<long>(flags);
  19933. }
  19934. inline std::string get_cert_subject_cn(cert_t cert) {
  19935. if (!cert) return "";
  19936. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19937. // Find the CN in the subject
  19938. const mbedtls_x509_name *name = &x509->subject;
  19939. while (name != nullptr) {
  19940. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  19941. return std::string(reinterpret_cast<const char *>(name->val.p),
  19942. name->val.len);
  19943. }
  19944. name = name->next;
  19945. }
  19946. return "";
  19947. }
  19948. inline std::string get_cert_issuer_name(cert_t cert) {
  19949. if (!cert) return "";
  19950. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19951. // Build a human-readable issuer name string
  19952. char buf[512];
  19953. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  19954. if (ret < 0) return "";
  19955. return std::string(buf);
  19956. }
  19957. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19958. sans.clear();
  19959. if (!cert) return false;
  19960. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19961. // Parse the Subject Alternative Name extension
  19962. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  19963. while (cur != nullptr) {
  19964. if (cur->buf.len > 0) {
  19965. const unsigned char *p = cur->buf.p;
  19966. size_t value_len = cur->buf.len;
  19967. SanEntry entry;
  19968. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  19969. case MBEDTLS_X509_SAN_DNS_NAME:
  19970. entry.type = SanType::DNS;
  19971. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19972. break;
  19973. case MBEDTLS_X509_SAN_IP_ADDRESS:
  19974. entry.type = SanType::IP;
  19975. if (value_len == 4) {
  19976. // IPv4
  19977. char buf[16];
  19978. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  19979. entry.value = buf;
  19980. } else if (value_len == 16) {
  19981. // IPv6
  19982. char buf[64];
  19983. snprintf(buf, sizeof(buf),
  19984. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19985. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19986. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  19987. p[10], p[11], p[12], p[13], p[14], p[15]);
  19988. entry.value = buf;
  19989. }
  19990. break;
  19991. case MBEDTLS_X509_SAN_RFC822_NAME:
  19992. entry.type = SanType::EMAIL;
  19993. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19994. break;
  19995. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  19996. entry.type = SanType::URI;
  19997. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19998. break;
  19999. default: entry.type = SanType::OTHER; break;
  20000. }
  20001. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  20002. }
  20003. cur = cur->next;
  20004. }
  20005. return true;
  20006. }
  20007. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  20008. time_t &not_after) {
  20009. if (!cert) return false;
  20010. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  20011. // Convert mbedtls_x509_time to time_t
  20012. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  20013. struct tm tm_time = {};
  20014. tm_time.tm_year = t.year - 1900;
  20015. tm_time.tm_mon = t.mon - 1;
  20016. tm_time.tm_mday = t.day;
  20017. tm_time.tm_hour = t.hour;
  20018. tm_time.tm_min = t.min;
  20019. tm_time.tm_sec = t.sec;
  20020. #ifdef _WIN32
  20021. return _mkgmtime(&tm_time);
  20022. #else
  20023. return timegm(&tm_time);
  20024. #endif
  20025. };
  20026. not_before = to_time_t(x509->valid_from);
  20027. not_after = to_time_t(x509->valid_to);
  20028. return true;
  20029. }
  20030. inline std::string get_cert_serial(cert_t cert) {
  20031. if (!cert) return "";
  20032. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  20033. // Convert serial number to hex string
  20034. std::string result;
  20035. result.reserve(x509->serial.len * 2);
  20036. for (size_t i = 0; i < x509->serial.len; i++) {
  20037. char hex[3];
  20038. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  20039. result += hex;
  20040. }
  20041. return result;
  20042. }
  20043. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  20044. if (!cert) return false;
  20045. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  20046. if (!crt->raw.p || crt->raw.len == 0) return false;
  20047. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  20048. return true;
  20049. }
  20050. inline const char *get_sni(const_session_t session) {
  20051. if (!session) return nullptr;
  20052. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  20053. // For server: return SNI received from client during handshake
  20054. if (!msession->sni_hostname.empty()) {
  20055. return msession->sni_hostname.c_str();
  20056. }
  20057. // For client: return the hostname set via set_sni
  20058. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  20059. return nullptr;
  20060. }
  20061. inline uint64_t peek_error() {
  20062. // Mbed TLS doesn't have an error queue, return the last error
  20063. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  20064. }
  20065. inline uint64_t get_error() {
  20066. // Mbed TLS doesn't have an error queue, return and clear the last error
  20067. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  20068. impl::mbedtls_last_error() = 0;
  20069. return err;
  20070. }
  20071. inline std::string error_string(uint64_t code) {
  20072. char buf[256];
  20073. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  20074. return std::string(buf);
  20075. }
  20076. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  20077. #ifdef CPPHTTPLIB_MBEDTLS_V4
  20078. // Parsing certificates needs PSA Crypto, and no context may exist yet
  20079. if (!detail::ensure_mbedtls_psa_crypto()) { return nullptr; }
  20080. #endif
  20081. if (!pem) { return nullptr; }
  20082. // mbedtls_x509_crt_parse expects null-terminated PEM
  20083. std::string pem_str(pem, len);
  20084. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  20085. if (!ca_chain) { return nullptr; }
  20086. mbedtls_x509_crt_init(ca_chain);
  20087. auto ret = mbedtls_x509_crt_parse(
  20088. ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  20089. pem_str.size() + 1);
  20090. if (ret != 0) {
  20091. mbedtls_x509_crt_free(ca_chain);
  20092. delete ca_chain;
  20093. return nullptr;
  20094. }
  20095. return static_cast<ca_store_t>(ca_chain);
  20096. }
  20097. inline void free_ca_store(ca_store_t store) {
  20098. if (store) {
  20099. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  20100. mbedtls_x509_crt_free(ca_chain);
  20101. delete ca_chain;
  20102. }
  20103. }
  20104. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  20105. if (!ctx || !store) { return false; }
  20106. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  20107. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  20108. // Free existing CA chain
  20109. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  20110. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  20111. // Copy the CA chain (deep copy)
  20112. // Parse from the raw data of the source cert
  20113. mbedtls_x509_crt *src = ca_chain;
  20114. while (src != nullptr) {
  20115. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  20116. src->raw.len);
  20117. if (ret != 0) {
  20118. free_ca_store(store);
  20119. return false;
  20120. }
  20121. src = src->next;
  20122. }
  20123. // This function takes ownership of the store; the chain was deep-copied
  20124. // above, so release the source
  20125. free_ca_store(store);
  20126. // Update the SSL config to use the new CA chain
  20127. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  20128. return true;
  20129. }
  20130. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  20131. certs.clear();
  20132. if (!ctx) { return 0; }
  20133. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  20134. // Owned by the context; see free_cert()
  20135. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  20136. cert = cert->next) {
  20137. certs.push_back(static_cast<cert_t>(cert));
  20138. }
  20139. return certs.size();
  20140. }
  20141. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  20142. std::vector<std::string> names;
  20143. if (!ctx) { return names; }
  20144. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  20145. // Iterate through the CA chain
  20146. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  20147. while (cert != nullptr && cert->raw.len > 0) {
  20148. char buf[512];
  20149. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  20150. if (ret > 0) { names.push_back(buf); }
  20151. cert = cert->next;
  20152. }
  20153. return names;
  20154. }
  20155. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  20156. const char *key_pem, const char *password) {
  20157. if (!ctx || !cert_pem || !key_pem) { return false; }
  20158. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  20159. // Parse into new objects first, so that a bad pair leaves the old one in
  20160. // place, and swap them in after; the old ones are freed on the way out.
  20161. mbedtls_x509_crt cert;
  20162. mbedtls_pk_context key;
  20163. mbedtls_x509_crt_init(&cert);
  20164. mbedtls_pk_init(&key);
  20165. auto se = detail::scope_exit([&] {
  20166. mbedtls_x509_crt_free(&cert);
  20167. mbedtls_pk_free(&key);
  20168. });
  20169. // Parse certificate PEM
  20170. int ret = mbedtls_x509_crt_parse(
  20171. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  20172. strlen(cert_pem) + 1);
  20173. if (ret != 0) {
  20174. impl::mbedtls_last_error() = ret;
  20175. return false;
  20176. }
  20177. // Parse private key PEM
  20178. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  20179. ret = mbedtls_pk_parse_key(
  20180. &key, reinterpret_cast<const unsigned char *>(key_pem),
  20181. strlen(key_pem) + 1,
  20182. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  20183. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  20184. &mbed_ctx->ctr_drbg);
  20185. #else
  20186. ret = mbedtls_pk_parse_key(
  20187. &key, reinterpret_cast<const unsigned char *>(key_pem),
  20188. strlen(key_pem) + 1,
  20189. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  20190. password ? strlen(password) : 0);
  20191. #endif
  20192. if (ret != 0) {
  20193. impl::mbedtls_last_error() = ret;
  20194. return false;
  20195. }
  20196. std::swap(mbed_ctx->own_cert, cert);
  20197. std::swap(mbed_ctx->own_key, key);
  20198. // Configure SSL to use the new certificate and key
  20199. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  20200. &mbed_ctx->own_key);
  20201. if (ret != 0) {
  20202. impl::mbedtls_last_error() = ret;
  20203. return false;
  20204. }
  20205. return true;
  20206. }
  20207. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  20208. if (!ctx || !ca_pem) { return false; }
  20209. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  20210. // Parse into a new chain first, so that a bad one leaves the old in place
  20211. mbedtls_x509_crt chain;
  20212. mbedtls_x509_crt_init(&chain);
  20213. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  20214. // Parse CA PEM
  20215. int ret = mbedtls_x509_crt_parse(
  20216. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  20217. strlen(ca_pem) + 1);
  20218. if (ret != 0) {
  20219. impl::mbedtls_last_error() = ret;
  20220. return false;
  20221. }
  20222. std::swap(mbed_ctx->ca_chain, chain);
  20223. // Update SSL config to use new CA chain
  20224. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  20225. return true;
  20226. }
  20227. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  20228. if (!ctx) { return false; }
  20229. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  20230. // create_session() hands each session its own copy to run.
  20231. mbed_ctx->verify_callback = std::move(callback);
  20232. impl::apply_verify_mode(*mbed_ctx);
  20233. return true;
  20234. }
  20235. inline long get_verify_error(const_session_t session) {
  20236. if (!session) { return -1; }
  20237. auto *msession =
  20238. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  20239. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  20240. }
  20241. inline std::string verify_error_string(long error_code) {
  20242. if (error_code == 0) { return ""; }
  20243. char buf[256];
  20244. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  20245. static_cast<uint32_t>(error_code));
  20246. // Remove trailing newline if present
  20247. std::string result(buf);
  20248. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  20249. result.pop_back();
  20250. }
  20251. return result;
  20252. }
  20253. } // namespace tls
  20254. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  20255. /*
  20256. * Group 10: TLS abstraction layer - wolfSSL backend
  20257. */
  20258. /*
  20259. * wolfSSL Backend Implementation
  20260. */
  20261. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  20262. namespace tls {
  20263. namespace impl {
  20264. // wolfSSL session wrapper
  20265. struct WolfSSLSession {
  20266. WOLFSSL *ssl = nullptr;
  20267. socket_t sock = INVALID_SOCKET;
  20268. std::string hostname; // For client: set via set_sni
  20269. std::string sni_hostname; // For server: received from client via SNI callback
  20270. WolfSSLSession() = default;
  20271. ~WolfSSLSession() {
  20272. if (ssl) { wolfSSL_free(ssl); }
  20273. }
  20274. WolfSSLSession(const WolfSSLSession &) = delete;
  20275. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  20276. };
  20277. // Thread-local error code accessor for wolfSSL
  20278. inline uint64_t &wolfssl_last_error() {
  20279. static thread_local uint64_t err = 0;
  20280. return err;
  20281. }
  20282. // Helper to map wolfSSL error to ErrorCode.
  20283. // ssl_error is the value from wolfSSL_get_error().
  20284. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  20285. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  20286. int &out_errno) {
  20287. switch (ssl_error) {
  20288. case SSL_ERROR_NONE: return ErrorCode::Success;
  20289. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  20290. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  20291. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  20292. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  20293. // EOF without close_notify
  20294. case SOCKET_PEER_CLOSED_E: out_errno = 0; return ErrorCode::SyscallError;
  20295. default:
  20296. if (ssl) {
  20297. // wolfSSL stores the low-level error code as a negative value.
  20298. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  20299. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  20300. if (low_err == DOMAIN_NAME_MISMATCH) {
  20301. return ErrorCode::HostnameMismatch;
  20302. }
  20303. // Check verify result to distinguish cert verification from generic SSL
  20304. // errors.
  20305. long vr = wolfSSL_get_verify_result(ssl);
  20306. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  20307. }
  20308. return ErrorCode::Fatal;
  20309. }
  20310. }
  20311. // WolfSSLContext constructor/destructor implementations
  20312. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  20313. inline WolfSSLContext::~WolfSSLContext() {
  20314. if (ctx) { wolfSSL_CTX_free(ctx); }
  20315. }
  20316. // Thread-local storage for SNI captured during handshake
  20317. inline std::string &wolfssl_pending_sni() {
  20318. static thread_local std::string sni;
  20319. return sni;
  20320. }
  20321. // SNI callback for wolfSSL server to capture client's SNI hostname
  20322. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  20323. (void)ret;
  20324. (void)exArg;
  20325. void *name_data = nullptr;
  20326. unsigned short name_len =
  20327. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  20328. if (name_data && name_len > 0) {
  20329. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  20330. name_len);
  20331. } else {
  20332. wolfssl_pending_sni().clear();
  20333. }
  20334. return 0; // Continue regardless
  20335. }
  20336. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  20337. // runs the verify callback of its own context.
  20338. inline int context_ex_data_index() {
  20339. static const auto index =
  20340. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  20341. return index;
  20342. }
  20343. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  20344. // other tls:: function takes.
  20345. inline int session_ex_data_index() {
  20346. static const auto index =
  20347. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  20348. return index;
  20349. }
  20350. // A resumed session skips the client's certificate, so a server that checks
  20351. // one would let in a certificate checked against another server's CA, as
  20352. // wolfSSL shares its session cache between contexts, or against a CA since
  20353. // replaced by update_server_client_ca().
  20354. inline void disable_server_resumption(WolfSSLContext *wctx) {
  20355. if (!wctx->is_server) { return; }
  20356. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  20357. #ifdef HAVE_SESSION_TICKET
  20358. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  20359. #endif
  20360. }
  20361. // wolfSSL verify callback wrapper
  20362. inline int wolfssl_verify_callback(int preverify_ok,
  20363. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  20364. // Get the WOLFSSL object from the X509_STORE_CTX
  20365. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  20366. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  20367. if (!ssl) { return preverify_ok; }
  20368. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  20369. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  20370. if (!wctx) { return preverify_ok; }
  20371. std::shared_ptr<VerifyCallback> callback;
  20372. {
  20373. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  20374. callback = wctx->verify_callback;
  20375. }
  20376. if (!callback) { return preverify_ok; }
  20377. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  20378. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  20379. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  20380. VerifyContext verify_ctx;
  20381. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  20382. verify_ctx.cert = static_cast<cert_t>(cert);
  20383. verify_ctx.depth = depth;
  20384. verify_ctx.preverify_ok = (preverify_ok != 0);
  20385. verify_ctx.error_code = static_cast<long>(err);
  20386. if (err != 0) {
  20387. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  20388. } else {
  20389. verify_ctx.error_string = nullptr;
  20390. }
  20391. auto accepted = run_verify_callback(*callback, verify_ctx);
  20392. // A client verifying the server during the handshake, which is what
  20393. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  20394. if (!wolfSSL_is_server(ssl) &&
  20395. (wolfSSL_get_verify_mode(ssl) & WOLFSSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  20396. accepted = accepted && preverify_ok;
  20397. }
  20398. return accepted ? 1 : 0;
  20399. }
  20400. // Sets the verify mode from whether the peer's certificate is required and
  20401. // whether a verify callback is set.
  20402. inline void apply_verify_mode(WolfSSLContext &wctx) {
  20403. auto has_callback = static_cast<bool>(wctx.verify_callback);
  20404. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  20405. auto mode = wctx.verify_client
  20406. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  20407. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  20408. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  20409. has_callback ? wolfssl_verify_callback : nullptr);
  20410. }
  20411. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  20412. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  20413. wolfSSL_CTX_set_default_passwd_cb(
  20414. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  20415. auto *pwd = static_cast<const char *>(userdata);
  20416. if (!pwd) return 0;
  20417. auto len = static_cast<int>(strlen(pwd));
  20418. if (len > size) len = size;
  20419. memcpy(buf, pwd, static_cast<size_t>(len));
  20420. return len;
  20421. });
  20422. }
  20423. } // namespace impl
  20424. inline ctx_t create_client_context() {
  20425. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  20426. if (!ctx) { return nullptr; }
  20427. ctx->is_server = false;
  20428. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  20429. if (!method) {
  20430. delete ctx;
  20431. return nullptr;
  20432. }
  20433. ctx->ctx = wolfSSL_CTX_new(method);
  20434. if (!ctx->ctx ||
  20435. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  20436. WOLFSSL_SUCCESS) {
  20437. delete ctx;
  20438. return nullptr;
  20439. }
  20440. // Default: verify peer certificate
  20441. ctx->verify_client = true;
  20442. impl::apply_verify_mode(*ctx);
  20443. return static_cast<ctx_t>(ctx);
  20444. }
  20445. inline ctx_t create_server_context() {
  20446. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  20447. if (!ctx) { return nullptr; }
  20448. ctx->is_server = true;
  20449. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  20450. if (!method) {
  20451. delete ctx;
  20452. return nullptr;
  20453. }
  20454. ctx->ctx = wolfSSL_CTX_new(method);
  20455. if (!ctx->ctx ||
  20456. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  20457. WOLFSSL_SUCCESS) {
  20458. delete ctx;
  20459. return nullptr;
  20460. }
  20461. // Default: don't verify client
  20462. impl::apply_verify_mode(*ctx);
  20463. // Enable SNI on server
  20464. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  20465. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  20466. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  20467. return static_cast<ctx_t>(ctx);
  20468. }
  20469. inline void free_context(ctx_t ctx) {
  20470. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  20471. }
  20472. inline bool set_min_version(ctx_t ctx, Version version) {
  20473. if (!ctx) { return false; }
  20474. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20475. int min_ver = WOLFSSL_TLSV1_2;
  20476. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  20477. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  20478. }
  20479. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  20480. if (!ctx || !pem) { return false; }
  20481. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20482. int ret = wolfSSL_CTX_load_verify_buffer(
  20483. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  20484. static_cast<long>(len), SSL_FILETYPE_PEM);
  20485. if (ret != SSL_SUCCESS) {
  20486. impl::wolfssl_last_error() =
  20487. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20488. return false;
  20489. }
  20490. wctx->ca_pem_data_.append(pem, len);
  20491. return true;
  20492. }
  20493. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  20494. if (!ctx || !file_path) { return false; }
  20495. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20496. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  20497. if (ret != SSL_SUCCESS) {
  20498. impl::wolfssl_last_error() =
  20499. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20500. return false;
  20501. }
  20502. return true;
  20503. }
  20504. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  20505. if (!ctx || !dir_path) { return false; }
  20506. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20507. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  20508. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  20509. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  20510. // immediately. Return true even on failure since the CA file may have
  20511. // already been loaded, matching OpenSSL's lenient behavior.
  20512. (void)ret;
  20513. return true;
  20514. }
  20515. inline bool load_system_certs(ctx_t ctx) {
  20516. if (!ctx) { return false; }
  20517. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20518. bool loaded = false;
  20519. #ifdef _WIN32
  20520. loaded = impl::enumerate_windows_system_certs(
  20521. [&](const unsigned char *data, size_t len) {
  20522. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  20523. static_cast<long>(len),
  20524. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  20525. });
  20526. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  20527. loaded = impl::enumerate_macos_keychain_certs(
  20528. [&](const unsigned char *data, size_t len) {
  20529. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  20530. static_cast<long>(len),
  20531. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  20532. });
  20533. #else
  20534. for (auto path = impl::system_ca_paths(); *path; ++path) {
  20535. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  20536. SSL_SUCCESS) {
  20537. loaded = true;
  20538. break;
  20539. }
  20540. }
  20541. if (!loaded) {
  20542. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  20543. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  20544. SSL_SUCCESS) {
  20545. loaded = true;
  20546. break;
  20547. }
  20548. }
  20549. }
  20550. #endif
  20551. return loaded;
  20552. }
  20553. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  20554. const char *password) {
  20555. if (!ctx || !cert || !key) { return false; }
  20556. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20557. // Load certificate
  20558. int ret = wolfSSL_CTX_use_certificate_buffer(
  20559. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  20560. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  20561. if (ret != SSL_SUCCESS) {
  20562. impl::wolfssl_last_error() =
  20563. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20564. return false;
  20565. }
  20566. // Set password callback if password is provided
  20567. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  20568. // Load private key
  20569. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  20570. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  20571. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  20572. if (ret != SSL_SUCCESS) {
  20573. impl::wolfssl_last_error() =
  20574. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20575. return false;
  20576. }
  20577. // Verify that the certificate and private key match
  20578. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  20579. }
  20580. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  20581. const char *key_path, const char *password) {
  20582. if (!ctx || !cert_path || !key_path) { return false; }
  20583. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20584. // Load certificate file
  20585. int ret =
  20586. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  20587. if (ret != SSL_SUCCESS) {
  20588. impl::wolfssl_last_error() =
  20589. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20590. return false;
  20591. }
  20592. // Set password callback if password is provided
  20593. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  20594. // Load private key file
  20595. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  20596. if (ret != SSL_SUCCESS) {
  20597. impl::wolfssl_last_error() =
  20598. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20599. return false;
  20600. }
  20601. // Verify that the certificate and private key match
  20602. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  20603. }
  20604. inline void set_verify_client(ctx_t ctx, bool require) {
  20605. if (!ctx) { return; }
  20606. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20607. wctx->verify_client = require;
  20608. impl::apply_verify_mode(*wctx);
  20609. }
  20610. inline session_t create_session(ctx_t ctx, socket_t sock) {
  20611. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  20612. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20613. auto session = new (std::nothrow) impl::WolfSSLSession();
  20614. if (!session) { return nullptr; }
  20615. session->sock = sock;
  20616. session->ssl = wolfSSL_new(wctx->ctx);
  20617. if (!session->ssl) {
  20618. impl::wolfssl_last_error() =
  20619. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20620. delete session;
  20621. return nullptr;
  20622. }
  20623. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  20624. session) != WOLFSSL_SUCCESS) {
  20625. delete session;
  20626. return nullptr;
  20627. }
  20628. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  20629. return static_cast<session_t>(session);
  20630. }
  20631. inline void free_session(session_t session) {
  20632. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  20633. }
  20634. inline bool set_sni(session_t session, const char *hostname,
  20635. bool verify_hostname) {
  20636. if (!session || !hostname) { return false; }
  20637. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20638. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  20639. static_cast<word16>(strlen(hostname)));
  20640. if (ret != WOLFSSL_SUCCESS) {
  20641. impl::wolfssl_last_error() =
  20642. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20643. return false;
  20644. }
  20645. // wolfSSL_check_domain_name binds identity checking to the handshake,
  20646. // separately from the SNI extension sent above; skip it when hostname
  20647. // verification is disabled so only the chain is checked, matching OpenSSL.
  20648. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  20649. wsession->hostname = hostname;
  20650. return true;
  20651. }
  20652. inline TlsError connect(session_t session) {
  20653. TlsError err;
  20654. if (!session) {
  20655. err.code = ErrorCode::Fatal;
  20656. return err;
  20657. }
  20658. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20659. int ret = wolfSSL_connect(wsession->ssl);
  20660. if (ret == SSL_SUCCESS) {
  20661. err.code = ErrorCode::Success;
  20662. } else {
  20663. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20664. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  20665. err.backend_code = static_cast<uint64_t>(ssl_error);
  20666. impl::wolfssl_last_error() = err.backend_code;
  20667. }
  20668. return err;
  20669. }
  20670. inline TlsError accept(session_t session) {
  20671. TlsError err;
  20672. if (!session) {
  20673. err.code = ErrorCode::Fatal;
  20674. return err;
  20675. }
  20676. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20677. int ret = wolfSSL_accept(wsession->ssl);
  20678. if (ret == SSL_SUCCESS) {
  20679. err.code = ErrorCode::Success;
  20680. // Capture SNI from thread-local storage after successful handshake
  20681. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  20682. impl::wolfssl_pending_sni().clear();
  20683. } else {
  20684. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20685. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  20686. err.backend_code = static_cast<uint64_t>(ssl_error);
  20687. impl::wolfssl_last_error() = err.backend_code;
  20688. }
  20689. return err;
  20690. }
  20691. inline bool connect_nonblocking(session_t session, socket_t sock,
  20692. time_t timeout_sec, time_t timeout_usec,
  20693. TlsError *err,
  20694. const std::function<bool()> &interrupted) {
  20695. if (!session) {
  20696. if (err) { err->code = ErrorCode::Fatal; }
  20697. return false;
  20698. }
  20699. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20700. // Set socket to non-blocking mode
  20701. detail::set_nonblocking(sock, true);
  20702. auto cleanup =
  20703. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  20704. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  20705. int ret;
  20706. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  20707. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20708. if (ssl_error == SSL_ERROR_WANT_READ) {
  20709. if (detail::select_until(sock, POLLIN, deadline, interrupted) > 0) {
  20710. continue;
  20711. }
  20712. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  20713. if (detail::select_until(sock, POLLOUT, deadline, interrupted) > 0) {
  20714. continue;
  20715. }
  20716. }
  20717. // Error or timeout
  20718. if (err) {
  20719. err->code =
  20720. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  20721. err->backend_code = static_cast<uint64_t>(ssl_error);
  20722. }
  20723. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  20724. return false;
  20725. }
  20726. if (err) { err->code = ErrorCode::Success; }
  20727. return true;
  20728. }
  20729. inline bool accept_nonblocking(session_t session, socket_t sock,
  20730. time_t timeout_sec, time_t timeout_usec,
  20731. TlsError *err) {
  20732. if (!session) {
  20733. if (err) { err->code = ErrorCode::Fatal; }
  20734. return false;
  20735. }
  20736. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20737. // Set socket to non-blocking mode
  20738. detail::set_nonblocking(sock, true);
  20739. auto cleanup =
  20740. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  20741. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  20742. int ret;
  20743. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  20744. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20745. if (ssl_error == SSL_ERROR_WANT_READ) {
  20746. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  20747. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  20748. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  20749. }
  20750. // Error or timeout
  20751. if (err) {
  20752. err->code =
  20753. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  20754. err->backend_code = static_cast<uint64_t>(ssl_error);
  20755. }
  20756. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  20757. return false;
  20758. }
  20759. if (err) { err->code = ErrorCode::Success; }
  20760. // Capture SNI from thread-local storage after successful handshake
  20761. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  20762. impl::wolfssl_pending_sni().clear();
  20763. return true;
  20764. }
  20765. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  20766. if (!session || !buf) {
  20767. err.code = ErrorCode::Fatal;
  20768. return -1;
  20769. }
  20770. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20771. constexpr auto max_len =
  20772. static_cast<size_t>((std::numeric_limits<int>::max)());
  20773. if (len > max_len) { len = max_len; }
  20774. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  20775. if (ret > 0) {
  20776. err.code = ErrorCode::Success;
  20777. return static_cast<ssize_t>(ret);
  20778. }
  20779. // 0 is also returned for EOF without close_notify; get_error tells them apart
  20780. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20781. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  20782. if (err.code == ErrorCode::PeerClosed) { return 0; }
  20783. err.backend_code = static_cast<uint64_t>(ssl_error);
  20784. impl::wolfssl_last_error() = err.backend_code;
  20785. return -1;
  20786. }
  20787. inline ssize_t write(session_t session, const void *buf, size_t len,
  20788. TlsError &err) {
  20789. if (!session || !buf) {
  20790. err.code = ErrorCode::Fatal;
  20791. return -1;
  20792. }
  20793. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20794. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  20795. if (ret > 0) {
  20796. err.code = ErrorCode::Success;
  20797. return static_cast<ssize_t>(ret);
  20798. }
  20799. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  20800. // Treat this as an error (return -1) so callers don't spin in a
  20801. // write loop adding zero to the offset.
  20802. if (ret == 0) {
  20803. err.code = ErrorCode::PeerClosed;
  20804. return -1;
  20805. }
  20806. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20807. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  20808. err.backend_code = static_cast<uint64_t>(ssl_error);
  20809. impl::wolfssl_last_error() = err.backend_code;
  20810. return -1;
  20811. }
  20812. inline int pending(const_session_t session) {
  20813. if (!session) { return 0; }
  20814. auto wsession =
  20815. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20816. return wolfSSL_pending(wsession->ssl);
  20817. }
  20818. inline void shutdown(session_t session, bool graceful) {
  20819. if (!session) { return; }
  20820. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20821. if (graceful) {
  20822. int ret;
  20823. int attempts = 0;
  20824. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  20825. attempts < 3) {
  20826. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20827. if (ssl_error != SSL_ERROR_WANT_READ &&
  20828. ssl_error != SSL_ERROR_WANT_WRITE) {
  20829. break;
  20830. }
  20831. attempts++;
  20832. }
  20833. } else {
  20834. wolfSSL_shutdown(wsession->ssl);
  20835. }
  20836. }
  20837. inline bool is_peer_closed(session_t session, socket_t sock) {
  20838. if (!session || sock == INVALID_SOCKET) { return true; }
  20839. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  20840. // Check if there's already decrypted data available
  20841. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  20842. // Set socket to non-blocking to avoid blocking on read
  20843. detail::set_nonblocking(sock, true);
  20844. auto cleanup =
  20845. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  20846. // Peek 1 byte to check connection status without consuming data
  20847. unsigned char buf;
  20848. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  20849. // If we got data or WANT_READ (would block), connection is alive
  20850. if (ret > 0) { return false; }
  20851. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  20852. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  20853. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  20854. ret == 0;
  20855. }
  20856. inline cert_t get_peer_cert(const_session_t session) {
  20857. if (!session) { return nullptr; }
  20858. auto wsession =
  20859. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20860. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  20861. return static_cast<cert_t>(cert);
  20862. }
  20863. inline size_t get_peer_certs(const_session_t session,
  20864. std::vector<cert_t> &certs) {
  20865. certs.clear();
  20866. if (!session) { return 0; }
  20867. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  20868. #ifdef SESSION_CERTS
  20869. auto wsession =
  20870. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20871. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  20872. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  20873. for (int i = 0; i < count; i++) {
  20874. auto x509 = wolfSSL_get_chain_X509(chain, i);
  20875. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20876. }
  20877. #endif
  20878. return certs.size();
  20879. }
  20880. inline void free_cert(cert_t cert) {
  20881. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  20882. }
  20883. inline bool verify_hostname(cert_t cert, const char *hostname) {
  20884. if (!cert || !hostname) { return false; }
  20885. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20886. std::string host_str(hostname);
  20887. // Check if hostname is an IP address (IPv4 or IPv6)
  20888. unsigned char ip_bytes[16];
  20889. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  20890. auto is_ip = ip_len > 0;
  20891. // Check Subject Alternative Names
  20892. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  20893. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  20894. if (san_names) {
  20895. int san_count = wolfSSL_sk_num(san_names);
  20896. for (int i = 0; i < san_count; i++) {
  20897. auto *names =
  20898. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  20899. if (!names) continue;
  20900. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  20901. // DNS name
  20902. unsigned char *dns_name = nullptr;
  20903. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  20904. if (dns_name && dns_len > 0) {
  20905. std::string san_name(reinterpret_cast<char *>(dns_name),
  20906. static_cast<size_t>(dns_len));
  20907. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  20908. if (detail::match_hostname(san_name, host_str)) {
  20909. wolfSSL_sk_free(san_names);
  20910. return true;
  20911. }
  20912. }
  20913. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  20914. // IP address: only an iPAddress SAN of the same family (4 bytes for
  20915. // IPv4, 16 bytes for IPv6) may authenticate the host.
  20916. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  20917. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  20918. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  20919. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  20920. wolfSSL_sk_free(san_names);
  20921. return true;
  20922. }
  20923. }
  20924. }
  20925. wolfSSL_sk_free(san_names);
  20926. }
  20927. return false;
  20928. }
  20929. inline uint64_t hostname_mismatch_code() {
  20930. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  20931. }
  20932. inline long get_verify_result(const_session_t session) {
  20933. if (!session) { return -1; }
  20934. auto wsession =
  20935. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20936. long result = wolfSSL_get_verify_result(wsession->ssl);
  20937. return result;
  20938. }
  20939. inline std::string get_cert_subject_cn(cert_t cert) {
  20940. if (!cert) return "";
  20941. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20942. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20943. if (!subject) return "";
  20944. char cn[256] = {};
  20945. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  20946. sizeof(cn));
  20947. if (cn_len <= 0) return "";
  20948. return std::string(cn, static_cast<size_t>(cn_len));
  20949. }
  20950. inline std::string get_cert_issuer_name(cert_t cert) {
  20951. if (!cert) return "";
  20952. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20953. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  20954. if (!issuer) return "";
  20955. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  20956. if (!name_str) return "";
  20957. std::string result(name_str);
  20958. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20959. return result;
  20960. }
  20961. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  20962. sans.clear();
  20963. if (!cert) return false;
  20964. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20965. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  20966. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  20967. if (!san_names) return true; // No SANs is not an error
  20968. int count = wolfSSL_sk_num(san_names);
  20969. for (int i = 0; i < count; i++) {
  20970. auto *name =
  20971. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  20972. if (!name) continue;
  20973. SanEntry entry;
  20974. switch (name->type) {
  20975. case WOLFSSL_GEN_DNS: {
  20976. entry.type = SanType::DNS;
  20977. unsigned char *dns_name = nullptr;
  20978. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  20979. if (dns_name && dns_len > 0) {
  20980. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  20981. static_cast<size_t>(dns_len));
  20982. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  20983. }
  20984. break;
  20985. }
  20986. case WOLFSSL_GEN_IPADD: {
  20987. entry.type = SanType::IP;
  20988. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  20989. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  20990. if (ip_data && ip_len == 4) {
  20991. char buf[16];
  20992. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  20993. ip_data[2], ip_data[3]);
  20994. entry.value = buf;
  20995. } else if (ip_data && ip_len == 16) {
  20996. char buf[64];
  20997. snprintf(buf, sizeof(buf),
  20998. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  20999. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  21000. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  21001. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  21002. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  21003. ip_data[14], ip_data[15]);
  21004. entry.value = buf;
  21005. }
  21006. break;
  21007. }
  21008. case WOLFSSL_GEN_EMAIL:
  21009. entry.type = SanType::EMAIL;
  21010. {
  21011. unsigned char *email = nullptr;
  21012. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  21013. if (email && email_len > 0) {
  21014. entry.value = std::string(reinterpret_cast<char *>(email),
  21015. static_cast<size_t>(email_len));
  21016. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  21017. }
  21018. }
  21019. break;
  21020. case WOLFSSL_GEN_URI:
  21021. entry.type = SanType::URI;
  21022. {
  21023. unsigned char *uri = nullptr;
  21024. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  21025. &uri, name->d.uniformResourceIdentifier);
  21026. if (uri && uri_len > 0) {
  21027. entry.value = std::string(reinterpret_cast<char *>(uri),
  21028. static_cast<size_t>(uri_len));
  21029. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  21030. }
  21031. }
  21032. break;
  21033. default: entry.type = SanType::OTHER; break;
  21034. }
  21035. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  21036. }
  21037. wolfSSL_sk_free(san_names);
  21038. return true;
  21039. }
  21040. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  21041. time_t &not_after) {
  21042. if (!cert) return false;
  21043. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  21044. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  21045. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  21046. if (!nb || !na) return false;
  21047. // wolfSSL_ASN1_TIME_to_tm is available
  21048. struct tm tm_nb = {}, tm_na = {};
  21049. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  21050. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  21051. #ifdef _WIN32
  21052. not_before = _mkgmtime(&tm_nb);
  21053. not_after = _mkgmtime(&tm_na);
  21054. #else
  21055. not_before = timegm(&tm_nb);
  21056. not_after = timegm(&tm_na);
  21057. #endif
  21058. return true;
  21059. }
  21060. inline std::string get_cert_serial(cert_t cert) {
  21061. if (!cert) return "";
  21062. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  21063. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  21064. if (!serial_asn1) return "";
  21065. // Get the serial number data
  21066. int len = serial_asn1->length;
  21067. unsigned char *data = serial_asn1->data;
  21068. if (!data || len <= 0) return "";
  21069. std::string result;
  21070. result.reserve(static_cast<size_t>(len) * 2);
  21071. for (int i = 0; i < len; i++) {
  21072. char hex[3];
  21073. snprintf(hex, sizeof(hex), "%02X", data[i]);
  21074. result += hex;
  21075. }
  21076. return result;
  21077. }
  21078. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  21079. if (!cert) return false;
  21080. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  21081. int der_len = 0;
  21082. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  21083. if (!der_data || der_len <= 0) return false;
  21084. der.assign(der_data, der_data + der_len);
  21085. return true;
  21086. }
  21087. inline const char *get_sni(const_session_t session) {
  21088. if (!session) return nullptr;
  21089. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  21090. // For server: return SNI received from client during handshake
  21091. if (!wsession->sni_hostname.empty()) {
  21092. return wsession->sni_hostname.c_str();
  21093. }
  21094. // For client: return the hostname set via set_sni
  21095. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  21096. return nullptr;
  21097. }
  21098. inline uint64_t peek_error() {
  21099. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  21100. }
  21101. inline uint64_t get_error() {
  21102. uint64_t err = impl::wolfssl_last_error();
  21103. impl::wolfssl_last_error() = 0;
  21104. return err;
  21105. }
  21106. inline std::string error_string(uint64_t code) {
  21107. char buf[256];
  21108. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  21109. return std::string(buf);
  21110. }
  21111. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  21112. if (!pem || len == 0) { return nullptr; }
  21113. // Validate by attempting to load into a temporary ctx
  21114. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  21115. if (!tmp_ctx) { return nullptr; }
  21116. int ret = wolfSSL_CTX_load_verify_buffer(
  21117. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  21118. static_cast<long>(len), SSL_FILETYPE_PEM);
  21119. wolfSSL_CTX_free(tmp_ctx);
  21120. if (ret != SSL_SUCCESS) { return nullptr; }
  21121. return static_cast<ca_store_t>(
  21122. new impl::WolfSSLCAStore{std::string(pem, len)});
  21123. }
  21124. inline void free_ca_store(ca_store_t store) {
  21125. delete static_cast<impl::WolfSSLCAStore *>(store);
  21126. }
  21127. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  21128. if (!ctx || !store) { return false; }
  21129. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  21130. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  21131. int ret = wolfSSL_CTX_load_verify_buffer(
  21132. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  21133. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  21134. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  21135. // This function takes ownership of the store; the PEM data was copied into
  21136. // the context, so release the source
  21137. free_ca_store(store);
  21138. return ret == SSL_SUCCESS;
  21139. }
  21140. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  21141. certs.clear();
  21142. if (!ctx) { return 0; }
  21143. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  21144. if (wctx->ca_pem_data_.empty()) { return 0; }
  21145. const std::string &pem = wctx->ca_pem_data_;
  21146. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  21147. const std::string end_marker = "-----END CERTIFICATE-----";
  21148. size_t pos = 0;
  21149. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  21150. size_t end_pos = pem.find(end_marker, pos);
  21151. if (end_pos == std::string::npos) { break; }
  21152. end_pos += end_marker.size();
  21153. std::string cert_pem = pem.substr(pos, end_pos - pos);
  21154. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  21155. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  21156. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  21157. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  21158. pos = end_pos;
  21159. }
  21160. return certs.size();
  21161. }
  21162. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  21163. std::vector<std::string> names;
  21164. if (!ctx) { return names; }
  21165. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  21166. if (wctx->ca_pem_data_.empty()) { return names; }
  21167. const std::string &pem = wctx->ca_pem_data_;
  21168. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  21169. const std::string end_marker = "-----END CERTIFICATE-----";
  21170. size_t pos = 0;
  21171. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  21172. size_t end_pos = pem.find(end_marker, pos);
  21173. if (end_pos == std::string::npos) { break; }
  21174. end_pos += end_marker.size();
  21175. std::string cert_pem = pem.substr(pos, end_pos - pos);
  21176. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  21177. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  21178. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  21179. if (x509) {
  21180. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  21181. if (subject) {
  21182. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  21183. if (name_str) {
  21184. names.push_back(name_str);
  21185. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  21186. }
  21187. }
  21188. wolfSSL_X509_free(x509);
  21189. }
  21190. pos = end_pos;
  21191. }
  21192. return names;
  21193. }
  21194. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  21195. const char *key_pem, const char *password) {
  21196. if (!ctx || !cert_pem || !key_pem) { return false; }
  21197. // Try the pair on a scratch context first, so that a bad one leaves the
  21198. // server's certificate and key as they were
  21199. auto tmp = create_server_context();
  21200. if (!tmp) { return false; }
  21201. auto se = detail::scope_exit([&] { free_context(tmp); });
  21202. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  21203. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  21204. }
  21205. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  21206. if (!ctx || !ca_pem) { return false; }
  21207. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  21208. // Replace the CAs rather than add to them, as the other backends do, once
  21209. // the new ones are known to load
  21210. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  21211. if (!store) { return false; }
  21212. free_ca_store(store);
  21213. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  21214. wctx->ca_pem_data_.clear();
  21215. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  21216. }
  21217. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  21218. if (!ctx) { return false; }
  21219. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  21220. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  21221. : nullptr;
  21222. {
  21223. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  21224. // A handshake running the previous callback keeps it until it returns.
  21225. wctx->verify_callback.swap(stored);
  21226. }
  21227. impl::apply_verify_mode(*wctx);
  21228. return true;
  21229. }
  21230. inline long get_verify_error(const_session_t session) {
  21231. if (!session) { return -1; }
  21232. auto *wsession =
  21233. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  21234. return wolfSSL_get_verify_result(wsession->ssl);
  21235. }
  21236. inline std::string verify_error_string(long error_code) {
  21237. if (error_code == 0) { return ""; }
  21238. const char *str =
  21239. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  21240. return str ? std::string(str) : std::string();
  21241. }
  21242. } // namespace tls
  21243. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  21244. // WebSocket implementation
  21245. namespace ws {
  21246. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  21247. bool fin) {
  21248. std::lock_guard<std::mutex> lock(write_mutex_);
  21249. if (closed_) { return false; }
  21250. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  21251. }
  21252. inline ReadResult WebSocket::read(std::string &msg) {
  21253. // Answers a control frame; any other opcode here is a protocol error.
  21254. // Returns false when the connection is done.
  21255. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  21256. switch (op) {
  21257. case Opcode::Ping: {
  21258. std::lock_guard<std::mutex> lock(write_mutex_);
  21259. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  21260. payload.size(), true, !is_server_);
  21261. return true;
  21262. }
  21263. case Opcode::Pong: {
  21264. std::lock_guard<std::mutex> lock(ping_mutex_);
  21265. unacked_pings_ = 0;
  21266. return true;
  21267. }
  21268. case Opcode::Close: {
  21269. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  21270. // malformed, which is answered with a protocol error instead.
  21271. if (closed_.exchange(true)) { return false; }
  21272. auto reply = payload;
  21273. if (!impl::is_valid_close_payload(payload)) {
  21274. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  21275. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  21276. }
  21277. std::lock_guard<std::mutex> lock(write_mutex_);
  21278. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  21279. reply.size(), true, !is_server_);
  21280. return false;
  21281. }
  21282. default: closed_ = true; return false;
  21283. }
  21284. };
  21285. std::unique_lock<std::mutex> read_lock(read_mutex_);
  21286. // A server going down closes the connection rather than wait on it: its
  21287. // listen() waits for this handler to return.
  21288. auto going_away = [&]() -> ReadResult {
  21289. read_lock.unlock();
  21290. close(CloseStatus::GoingAway, "server stopping");
  21291. return Fail;
  21292. };
  21293. // close() ends the read, even while the peer keeps sending fragments
  21294. while (!closed_) {
  21295. Opcode opcode;
  21296. std::string payload;
  21297. bool fin;
  21298. // While a message is assembled, only what is left of the limit, but room
  21299. // for a control frame, which may come between its fragments.
  21300. auto max_len =
  21301. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0 || message_kind_ == Fail
  21302. ? size_t(CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH)
  21303. : (std::max)(size_t(125), CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  21304. message_.size());
  21305. auto r = frames_.read(strm_, opcode, payload, fin, is_server_, max_len);
  21306. if (r != impl::FrameRead::Ok && server_stopping()) { return going_away(); }
  21307. // A timeout leaves what was read of the frame and of the message for the
  21308. // next read(), so the connection is still usable wherever it landed: hand
  21309. // control back without closing it. That is only useful to a caller who
  21310. // asked for the timeout; the compile-time default is a backstop against a
  21311. // peer gone quiet, and elapsing it closes the connection so a plain
  21312. // `while (ws.read(msg))` loop ends. A wait that a pong timeout cut short
  21313. // finds the connection closed.
  21314. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  21315. return Timeout;
  21316. }
  21317. if (r != impl::FrameRead::Ok) {
  21318. closed_ = true;
  21319. return Fail;
  21320. }
  21321. auto continues = opcode == Opcode::Continuation;
  21322. if (opcode != Opcode::Text && opcode != Opcode::Binary && !continues) {
  21323. if (handle_control(opcode, payload)) { continue; }
  21324. return Fail;
  21325. }
  21326. // RFC 6455 5.4: a message is a Text or Binary frame and the continuation
  21327. // frames after it, with only control frames between them.
  21328. if (continues == (message_kind_ == Fail)) {
  21329. closed_ = true;
  21330. return Fail;
  21331. }
  21332. if (continues) {
  21333. message_ += payload;
  21334. } else {
  21335. message_ = std::move(payload);
  21336. message_kind_ = opcode == Opcode::Text ? Text : Binary;
  21337. }
  21338. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  21339. message_.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  21340. closed_ = true;
  21341. return Fail;
  21342. }
  21343. if (!fin) { continue; }
  21344. auto result = message_kind_;
  21345. msg = std::move(message_);
  21346. message_.clear();
  21347. message_kind_ = Fail;
  21348. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  21349. if (result == Text && !impl::is_valid_utf8(msg)) {
  21350. // close() takes the read lock to wait for the peer's Close reply, so
  21351. // it must not run while this thread still holds it.
  21352. read_lock.unlock();
  21353. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  21354. return Fail;
  21355. }
  21356. return result;
  21357. }
  21358. return Fail;
  21359. }
  21360. inline bool WebSocket::send(const std::string &data) {
  21361. return send_frame(Opcode::Text, data.data(), data.size());
  21362. }
  21363. inline bool WebSocket::send(const char *data, size_t len) {
  21364. return send_frame(Opcode::Binary, data, len);
  21365. }
  21366. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  21367. if (closed_.exchange(true)) { return; }
  21368. ping_cv_.notify_all();
  21369. std::string payload;
  21370. auto code = static_cast<uint16_t>(status);
  21371. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  21372. payload.push_back(static_cast<char>(code & 0xFF));
  21373. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  21374. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  21375. // cut back to a whole UTF-8 character
  21376. auto short_reason = reason.substr(0, 123);
  21377. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  21378. short_reason.pop_back();
  21379. }
  21380. payload += short_reason;
  21381. // A code that may not be sent, such as NoStatus, goes without a payload
  21382. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  21383. {
  21384. std::lock_guard<std::mutex> lock(write_mutex_);
  21385. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  21386. payload.size(), true, !is_server_);
  21387. }
  21388. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  21389. // Close response before closing the TCP connection.
  21390. //
  21391. // Wait only when no other thread is parsing frames. When one is, it is the
  21392. // thread positioned to see the peer's reply, and reading here would take
  21393. // bytes out of the message it is assembling. Bailing out also leaves the
  21394. // stream, including its read timeout, entirely to that thread.
  21395. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  21396. if (!read_lock.owns_lock()) { return; }
  21397. // A max timeout turns a negative (unbounded) read timeout into 0
  21398. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  21399. strm_.set_max_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND * 1000);
  21400. // The max timeout cuts a trickled frame short, the deadline a frame flood
  21401. auto deadline =
  21402. detail::deadline_after(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  21403. // From where the last read() left the stream, inside a frame as it may be
  21404. Opcode op;
  21405. std::string resp;
  21406. bool fin;
  21407. while (std::chrono::steady_clock::now() < deadline &&
  21408. frames_.read(strm_, op, resp, fin, is_server_, 125) ==
  21409. impl::FrameRead::Ok) {
  21410. if (op == Opcode::Close) { break; }
  21411. }
  21412. }
  21413. inline WebSocket::~WebSocket() {
  21414. {
  21415. std::lock_guard<std::mutex> lock(ping_mutex_);
  21416. closed_ = true;
  21417. }
  21418. ping_cv_.notify_all();
  21419. if (ping_thread_.joinable()) { ping_thread_.join(); }
  21420. // A server's stream outlives this object
  21421. strm_.set_read_interrupt(nullptr);
  21422. }
  21423. // A pong timeout ends a read() blocked on the silent peer, and so does the
  21424. // server stopping: its listen() waits for every handler to return.
  21425. inline void WebSocket::interrupt_reads() {
  21426. auto watches_pongs = ping_interval_sec_ > 0 && max_missed_pongs_ > 0;
  21427. if (!watches_pongs && !server_stopping_) { return; }
  21428. strm_.set_read_interrupt(
  21429. [this] { return pong_timed_out_.load() || server_stopping(); });
  21430. }
  21431. inline void WebSocket::start_heartbeat() {
  21432. if (ping_interval_sec_ <= 0) { return; }
  21433. ping_thread_ = std::thread([this]() {
  21434. std::unique_lock<std::mutex> lock(ping_mutex_);
  21435. // The predicate keeps a spurious wakeup from sending a ping early
  21436. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  21437. [this]() { return closed_.load(); })) {
  21438. // If the peer has failed to respond to the previous pings, give up.
  21439. // RFC 6455 does not define a pong-timeout mechanism; this is an
  21440. // opt-in liveness check controlled by max_missed_pongs_.
  21441. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  21442. lock.unlock();
  21443. close(CloseStatus::GoingAway, "pong timeout");
  21444. pong_timed_out_ = true;
  21445. return;
  21446. }
  21447. lock.unlock();
  21448. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  21449. lock.lock();
  21450. closed_ = true;
  21451. break;
  21452. }
  21453. lock.lock();
  21454. unacked_pings_++;
  21455. }
  21456. });
  21457. }
  21458. inline const Request &WebSocket::request() const { return req_; }
  21459. inline bool WebSocket::is_open() const { return !closed_; }
  21460. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  21461. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  21462. // poll(), where 0 would instead mean "return immediately", so hand it the
  21463. // negative poll uses for an unbounded wait.
  21464. if (sec == 0 && usec == 0) { sec = -1; }
  21465. strm_.set_read_timeout(sec, usec);
  21466. read_timeout_set_ = true;
  21467. }
  21468. // WebSocketClient implementation
  21469. inline WebSocketClient::WebSocketClient(
  21470. const std::string &scheme_host_port_path, const Headers &headers)
  21471. : headers_(headers) {
  21472. detail::UrlComponents uc;
  21473. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  21474. !uc.host.empty() && !uc.path.empty()) {
  21475. auto &scheme = uc.scheme;
  21476. #ifdef CPPHTTPLIB_SSL_ENABLED
  21477. if (scheme != "ws" && scheme != "wss") {
  21478. #else
  21479. if (scheme != "ws") {
  21480. #endif
  21481. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  21482. std::string msg = "'" + scheme + "' scheme is not supported.";
  21483. throw std::invalid_argument(msg);
  21484. #endif
  21485. return;
  21486. }
  21487. auto is_ssl = scheme == "wss";
  21488. host_ = std::move(uc.host);
  21489. port_ = is_ssl ? 443 : 80;
  21490. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  21491. path_ = std::move(uc.path);
  21492. if (!uc.query.empty()) { path_ += uc.query; }
  21493. #ifdef CPPHTTPLIB_SSL_ENABLED
  21494. is_ssl_ = is_ssl;
  21495. if (is_ssl_) {
  21496. // The context lives as long as the client so that CA configuration
  21497. // survives reconnects; sessions are created per connection.
  21498. tls_ctx_ = tls::create_client_context();
  21499. if (!tls_ctx_) { return; }
  21500. }
  21501. #else
  21502. if (is_ssl) { return; }
  21503. #endif
  21504. is_valid_ = true;
  21505. }
  21506. }
  21507. #ifdef CPPHTTPLIB_SSL_ENABLED
  21508. inline WebSocketClient::WebSocketClient(
  21509. const std::string &scheme_host_port_path, const PemMemory &pem,
  21510. const Headers &headers)
  21511. : WebSocketClient(scheme_host_port_path, headers) {
  21512. // For ws:// URLs the client certificate is silently ignored, consistent
  21513. // with the TLS-only setters such as set_ca_cert_path().
  21514. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  21515. std::string cert_buf, key_buf;
  21516. if (!tls::set_client_cert_pem(
  21517. tls_ctx_,
  21518. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  21519. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  21520. pem.private_key_password)) {
  21521. tls::free_context(tls_ctx_);
  21522. tls_ctx_ = nullptr;
  21523. is_valid_ = false;
  21524. }
  21525. }
  21526. }
  21527. #endif
  21528. inline WebSocketClient::~WebSocketClient() {
  21529. shutdown_and_close();
  21530. #ifdef CPPHTTPLIB_SSL_ENABLED
  21531. if (tls_ctx_) {
  21532. tls::free_context(tls_ctx_);
  21533. tls_ctx_ = nullptr;
  21534. }
  21535. #endif
  21536. }
  21537. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  21538. inline void WebSocketClient::shutdown_and_close() {
  21539. // Send the close frame while the TLS session is still alive: ws_ holds an
  21540. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  21541. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  21542. if (ws_ && ws_->is_open()) { ws_->close(); }
  21543. ws_.reset();
  21544. #ifdef CPPHTTPLIB_SSL_ENABLED
  21545. if (is_ssl_) {
  21546. if (tls_session_) {
  21547. tls::shutdown(tls_session_, true);
  21548. tls::free_session(tls_session_);
  21549. tls_session_ = nullptr;
  21550. }
  21551. }
  21552. #endif
  21553. if (sock_ != INVALID_SOCKET) {
  21554. detail::shutdown_socket(sock_);
  21555. detail::close_socket(sock_);
  21556. sock_ = INVALID_SOCKET;
  21557. }
  21558. }
  21559. // The handshakes belong to establishing the connection, so an unset read
  21560. // timeout leaves them bounded by the connection timeout instead of forever.
  21561. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  21562. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  21563. return {connection_timeout_sec_, connection_timeout_usec_};
  21564. }
  21565. return {read_timeout_sec_, read_timeout_usec_};
  21566. }
  21567. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  21568. Error &error, int &ssl_error,
  21569. uint64_t &ssl_backend_error) {
  21570. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  21571. // The streams wait with poll(), where 0 instead means "return immediately",
  21572. // so they are given the negative poll uses for an unbounded wait.
  21573. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  21574. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  21575. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  21576. #ifdef CPPHTTPLIB_SSL_ENABLED
  21577. if (is_ssl_) {
  21578. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  21579. // is not safe to call concurrently on one client to begin with, since
  21580. // nothing else here is guarded either.
  21581. if (server_certificate_verification_ && !certs_loaded_) {
  21582. uint64_t backend_error = 0;
  21583. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  21584. ca_cert_dir_path_, custom_ca_loaded_,
  21585. system_ca_mode_, backend_error);
  21586. certs_loaded_ = true;
  21587. }
  21588. detail::ClientTlsSessionOptions options;
  21589. options.server_hostname_verification = server_hostname_verification_;
  21590. options.session_verifier = session_verifier_;
  21591. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  21592. options.windows_cert_verification = detail::use_windows_cert_verification(
  21593. enable_windows_cert_verification_, ca_cert_file_path_,
  21594. ca_cert_dir_path_, custom_ca_loaded_, system_ca_mode_);
  21595. options.server_certificate_verifier_set = server_certificate_verifier_set_;
  21596. #endif
  21597. auto timeout = handshake_timeout();
  21598. detail::ClientTlsSessionError tls_error;
  21599. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  21600. server_certificate_verification_,
  21601. timeout.first, timeout.second,
  21602. &tls_error, options)) {
  21603. error = tls_error.error;
  21604. ssl_error = tls_error.ssl_error;
  21605. ssl_backend_error = tls_error.backend_error;
  21606. return false;
  21607. }
  21608. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  21609. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  21610. write_timeout_usec_));
  21611. return true;
  21612. }
  21613. #else
  21614. (void)error;
  21615. (void)ssl_error;
  21616. (void)ssl_backend_error;
  21617. #endif
  21618. strm = std::unique_ptr<Stream>(
  21619. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  21620. write_timeout_sec_, write_timeout_usec_));
  21621. return true;
  21622. }
  21623. inline void WebSocketClient::prepare_default_headers(Request &req) {
  21624. #ifdef CPPHTTPLIB_SSL_ENABLED
  21625. auto is_ssl = is_ssl_;
  21626. #else
  21627. auto is_ssl = false;
  21628. #endif
  21629. if (!req.has_header("Host")) {
  21630. req.headers.emplace("Host", detail::make_default_host_header_value(
  21631. host_, port_, is_ssl, address_family_));
  21632. }
  21633. detail::add_default_user_agent_header(req);
  21634. detail::add_authorization_header(req, basic_auth_username_,
  21635. basic_auth_password_,
  21636. bearer_token_auth_token_, false);
  21637. }
  21638. inline Result WebSocketClient::connect() {
  21639. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  21640. shutdown_and_close();
  21641. auto error = Error::Success;
  21642. if (!create_and_connect_socket(error)) {
  21643. return Result{error, -1, Headers{}};
  21644. }
  21645. if (is_proxy_enabled()) {
  21646. Response proxy_res;
  21647. if (!connect_with_proxy(proxy_res, error)) {
  21648. shutdown_and_close();
  21649. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  21650. }
  21651. }
  21652. std::unique_ptr<Stream> strm;
  21653. auto stream_error = Error::SSLConnection;
  21654. int ssl_error = 0;
  21655. uint64_t ssl_backend_error = 0;
  21656. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  21657. shutdown_and_close();
  21658. #ifdef CPPHTTPLIB_SSL_ENABLED
  21659. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  21660. #else
  21661. return Result{stream_error, -1, Headers{}};
  21662. #endif
  21663. }
  21664. Request req;
  21665. req.method = "GET";
  21666. req.path = path_;
  21667. req.headers = headers_;
  21668. prepare_default_headers(req);
  21669. detail::WebSocketUpgradeResponse upgrade;
  21670. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  21671. shutdown_and_close();
  21672. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  21673. }
  21674. subprotocol_ = std::move(upgrade.selected_subprotocol);
  21675. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  21676. websocket_ping_interval_sec_,
  21677. websocket_max_missed_pongs_));
  21678. // The stream was created with the timeout already; tell the WebSocket
  21679. // whether it came from the caller, so read() knows to report it as Timeout.
  21680. ws_->read_timeout_set_ = read_timeout_set_;
  21681. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  21682. }
  21683. inline ReadResult WebSocketClient::read(std::string &msg) {
  21684. if (!ws_) { return Fail; }
  21685. return ws_->read(msg);
  21686. }
  21687. inline bool WebSocketClient::send(const std::string &data) {
  21688. if (!ws_) { return false; }
  21689. return ws_->send(data);
  21690. }
  21691. inline bool WebSocketClient::send(const char *data, size_t len) {
  21692. if (!ws_) { return false; }
  21693. return ws_->send(data, len);
  21694. }
  21695. inline void WebSocketClient::close(CloseStatus status,
  21696. const std::string &reason) {
  21697. if (ws_) { ws_->close(status, reason); }
  21698. }
  21699. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  21700. inline const std::string &WebSocketClient::subprotocol() const {
  21701. return subprotocol_;
  21702. }
  21703. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  21704. read_timeout_sec_ = sec;
  21705. read_timeout_usec_ = usec;
  21706. read_timeout_set_ = true;
  21707. // The members above only seed the next connect(); read() consults the
  21708. // stream, so an already-open connection has to be told directly.
  21709. if (ws_) { ws_->set_read_timeout(sec, usec); }
  21710. }
  21711. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  21712. write_timeout_sec_ = sec;
  21713. write_timeout_usec_ = usec;
  21714. }
  21715. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  21716. websocket_ping_interval_sec_ = sec;
  21717. }
  21718. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  21719. websocket_max_missed_pongs_ = count;
  21720. }
  21721. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  21722. inline void WebSocketClient::set_address_family(int family) {
  21723. address_family_ = family;
  21724. }
  21725. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  21726. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  21727. socket_options_ = std::move(socket_options);
  21728. }
  21729. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  21730. connection_timeout_sec_ = sec;
  21731. connection_timeout_usec_ = usec;
  21732. }
  21733. inline void WebSocketClient::set_interface(const std::string &intf) {
  21734. interface_ = intf;
  21735. }
  21736. inline void WebSocketClient::set_hostname_addr_map(
  21737. std::map<std::string, std::string> addr_map) {
  21738. set_direct_hostname_addr_map(std::move(addr_map));
  21739. }
  21740. inline void WebSocketClient::set_direct_hostname_addr_map(
  21741. std::map<std::string, std::string> addr_map) {
  21742. addr_map_ = std::move(addr_map);
  21743. }
  21744. inline void WebSocketClient::set_tunnel_hostname_addr_map(
  21745. std::map<std::string, std::string> addr_map) {
  21746. tunnel_addr_map_ = std::move(addr_map);
  21747. }
  21748. inline bool WebSocketClient::is_proxy_enabled() const {
  21749. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  21750. if (no_proxy_entries_.empty()) { return true; }
  21751. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  21752. no_proxy_entries_);
  21753. }
  21754. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  21755. std::string connect_host;
  21756. std::string ip;
  21757. auto port = port_;
  21758. if (is_proxy_enabled()) {
  21759. connect_host = proxy_host_;
  21760. port = proxy_port_;
  21761. } else {
  21762. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  21763. }
  21764. sock_ = detail::create_client_socket(
  21765. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  21766. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  21767. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  21768. write_timeout_usec_, interface_, error);
  21769. if (sock_ != INVALID_SOCKET) { return true; }
  21770. if (error == Error::Success) { error = Error::Connection; }
  21771. return false;
  21772. }
  21773. inline bool WebSocketClient::send_proxy_connect(Request &req,
  21774. Response &proxy_res,
  21775. Error &error) {
  21776. auto timeout = handshake_timeout();
  21777. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  21778. write_timeout_sec_, write_timeout_usec_);
  21779. if (!detail::write_request_head(strm, req, error)) { return false; }
  21780. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  21781. error = Error::Read;
  21782. return false;
  21783. }
  21784. return true;
  21785. }
  21786. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  21787. // forward an Upgrade request.
  21788. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  21789. Error &error) {
  21790. Request req;
  21791. req.method = "CONNECT";
  21792. req.path =
  21793. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  21794. req.headers.emplace("Host", req.path);
  21795. detail::add_default_user_agent_header(req);
  21796. detail::add_authorization_header(req, proxy_basic_auth_username_,
  21797. proxy_basic_auth_password_,
  21798. proxy_bearer_token_auth_token_, true);
  21799. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  21800. #ifdef CPPHTTPLIB_SSL_ENABLED
  21801. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  21802. std::map<std::string, std::string> auth;
  21803. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  21804. !proxy_digest_auth_username_.empty() &&
  21805. !proxy_digest_auth_password_.empty() &&
  21806. detail::parse_www_authenticate(proxy_res, auth, true)) {
  21807. proxy_res = Response();
  21808. shutdown_and_close();
  21809. if (!create_and_connect_socket(error)) { return false; }
  21810. req.headers.erase("Proxy-Authorization");
  21811. req.headers.insert(detail::make_digest_authentication_header(
  21812. req, req.path, auth, 1, detail::random_string(10),
  21813. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  21814. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  21815. }
  21816. #endif
  21817. if (proxy_res.status != StatusCode::OK_200) {
  21818. error = Error::ProxyConnection;
  21819. return false;
  21820. }
  21821. return true;
  21822. }
  21823. inline void WebSocketClient::set_basic_auth(const std::string &username,
  21824. const std::string &password) {
  21825. basic_auth_username_ = username;
  21826. basic_auth_password_ = password;
  21827. }
  21828. inline void WebSocketClient::set_bearer_token_auth(const std::string &token) {
  21829. bearer_token_auth_token_ = token;
  21830. }
  21831. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  21832. proxy_host_ = host;
  21833. proxy_port_ = port;
  21834. }
  21835. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  21836. const std::string &password) {
  21837. proxy_basic_auth_username_ = username;
  21838. proxy_basic_auth_password_ = password;
  21839. }
  21840. inline void
  21841. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  21842. proxy_bearer_token_auth_token_ = token;
  21843. }
  21844. inline void
  21845. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  21846. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  21847. }
  21848. #ifdef CPPHTTPLIB_SSL_ENABLED
  21849. inline void
  21850. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  21851. const std::string &ca_cert_dir_path) {
  21852. ca_cert_file_path_ = ca_cert_file_path;
  21853. ca_cert_dir_path_ = ca_cert_dir_path;
  21854. }
  21855. inline void
  21856. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  21857. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  21858. server_certificate_verifier_set_ = static_cast<bool>(verifier);
  21859. #endif
  21860. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  21861. }
  21862. inline void WebSocketClient::set_session_verifier(
  21863. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  21864. session_verifier_ = std::move(verifier);
  21865. }
  21866. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  21867. if (store && tls_ctx_) {
  21868. // set_ca_store takes ownership of store
  21869. tls::set_ca_store(tls_ctx_, store);
  21870. } else if (store) {
  21871. tls::free_ca_store(store);
  21872. }
  21873. custom_ca_loaded_ = true;
  21874. }
  21875. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  21876. std::size_t size) {
  21877. if (tls_ctx_ && ca_cert && size > 0) {
  21878. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  21879. }
  21880. custom_ca_loaded_ = true;
  21881. }
  21882. inline void
  21883. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  21884. server_certificate_verification_ = enabled;
  21885. }
  21886. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  21887. server_hostname_verification_ = enabled;
  21888. }
  21889. inline void WebSocketClient::enable_system_ca(bool enabled) {
  21890. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  21891. }
  21892. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  21893. inline void
  21894. WebSocketClient::enable_windows_certificate_verification(bool enabled) {
  21895. enable_windows_cert_verification_ = enabled;
  21896. }
  21897. #endif
  21898. inline void
  21899. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  21900. const std::string &password) {
  21901. proxy_digest_auth_username_ = username;
  21902. proxy_digest_auth_password_ = password;
  21903. }
  21904. #endif // CPPHTTPLIB_SSL_ENABLED
  21905. } // namespace ws
  21906. // ----------------------------------------------------------------------------
  21907. } // namespace httplib
  21908. #endif // CPPHTTPLIB_HTTPLIB_H