httplib.h 807 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577
  1. //
  2. // httplib.h
  3. //
  4. // Copyright (c) 2026 Yuji Hirose. All rights reserved.
  5. // MIT License
  6. //
  7. #ifndef CPPHTTPLIB_HTTPLIB_H
  8. #define CPPHTTPLIB_HTTPLIB_H
  9. #define CPPHTTPLIB_VERSION "0.61.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003d00"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  104. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  105. #endif
  106. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  107. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  108. #endif
  109. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  110. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  111. #endif
  112. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  113. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  114. #endif
  115. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  116. // 1400 rather than a round number: a body that already fits in one 1500-byte
  117. // MTU gains nothing from being made smaller.
  118. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  119. #endif
  120. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  121. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  122. #endif
  123. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  124. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  125. #endif
  126. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  127. // recurses roughly once per matched character for quantified patterns such
  128. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  129. // a default ~8MB thread stack that has been observed to take on the order of
  130. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  131. // margin below that (well under the 8192-byte request URI limit) while still
  132. // fitting any realistic route segment; raise it if a route legitimately needs
  133. // longer paths. Regex routes are never applied to paths longer than this.
  134. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  135. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  136. #endif
  137. #ifndef CPPHTTPLIB_TCP_NODELAY
  138. #define CPPHTTPLIB_TCP_NODELAY false
  139. #endif
  140. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  141. #define CPPHTTPLIB_IPV6_V6ONLY false
  142. #endif
  143. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  144. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  145. #endif
  146. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  147. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  148. #endif
  149. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  150. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  151. #endif
  152. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  153. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  154. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  155. ? std::thread::hardware_concurrency() - 1 \
  156. : 0))
  157. #endif
  158. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  159. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  160. #endif
  161. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  162. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  163. #endif
  164. #ifndef CPPHTTPLIB_RECV_FLAGS
  165. #define CPPHTTPLIB_RECV_FLAGS 0
  166. #endif
  167. #ifndef CPPHTTPLIB_SEND_FLAGS
  168. #define CPPHTTPLIB_SEND_FLAGS 0
  169. #endif
  170. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  171. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  172. #endif
  173. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  174. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  175. #endif
  176. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  177. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  178. #endif
  179. // One macro used to set the read timeout for both sides. They want different
  180. // defaults: a client's read timeout is the caller's own tool (it waits forever
  181. // until asked not to), while a server keeps a ceiling that reclaims a worker
  182. // from a peer that has gone quiet. The old name still works and sets both.
  183. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  184. #pragma message( \
  185. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  186. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  187. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  188. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  189. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  190. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  191. #endif
  192. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  193. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  194. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  195. #endif
  196. #endif
  197. // 0 waits forever. A read timeout is how a caller gets control back to send on
  198. // the same connection; it is not a liveness check (that is ping/pong). Only a
  199. // timeout set at runtime through set_read_timeout() is reported as
  200. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  201. // ws::Fail and closes the connection.
  202. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  203. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  204. #endif
  205. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  207. #endif
  208. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  209. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  210. #endif
  211. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  212. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  213. #endif
  214. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  215. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  216. #endif
  217. /*
  218. * Headers
  219. */
  220. #ifdef _WIN32
  221. #ifndef _CRT_SECURE_NO_WARNINGS
  222. #define _CRT_SECURE_NO_WARNINGS
  223. #endif //_CRT_SECURE_NO_WARNINGS
  224. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  225. #define _CRT_NONSTDC_NO_DEPRECATE
  226. #endif //_CRT_NONSTDC_NO_DEPRECATE
  227. #if defined(_MSC_VER)
  228. #if _MSC_VER < 1900
  229. #error Sorry, Visual Studio versions prior to 2015 are not supported
  230. #endif
  231. #pragma comment(lib, "ws2_32.lib")
  232. #ifndef _SSIZE_T_DEFINED
  233. using ssize_t = __int64;
  234. #define _SSIZE_T_DEFINED
  235. #endif
  236. #endif // _MSC_VER
  237. #ifndef S_ISREG
  238. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  239. #endif // S_ISREG
  240. #ifndef S_ISDIR
  241. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  242. #endif // S_ISDIR
  243. #ifndef NOMINMAX
  244. #define NOMINMAX
  245. #endif // NOMINMAX
  246. #include <io.h>
  247. #include <winsock2.h>
  248. #include <ws2tcpip.h>
  249. #if defined(__has_include)
  250. #if __has_include(<afunix.h>)
  251. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  252. #include <afunix.h>
  253. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  254. #endif
  255. #endif
  256. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  257. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  258. #endif
  259. using nfds_t = unsigned long;
  260. using socket_t = SOCKET;
  261. using socklen_t = int;
  262. #else // not _WIN32
  263. #include <arpa/inet.h>
  264. #if !defined(_AIX) && !defined(__MVS__)
  265. #include <ifaddrs.h>
  266. #endif
  267. #ifdef __MVS__
  268. #include <strings.h>
  269. #ifndef NI_MAXHOST
  270. #define NI_MAXHOST 1025
  271. #endif
  272. #endif
  273. #include <net/if.h>
  274. #include <netdb.h>
  275. #include <netinet/in.h>
  276. #ifdef __linux__
  277. #include <resolv.h>
  278. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  279. #endif
  280. #include <csignal>
  281. #include <netinet/tcp.h>
  282. #include <poll.h>
  283. #include <pthread.h>
  284. #include <sys/mman.h>
  285. #include <sys/socket.h>
  286. #include <sys/un.h>
  287. #include <unistd.h>
  288. using socket_t = int;
  289. #ifndef INVALID_SOCKET
  290. #define INVALID_SOCKET (-1)
  291. #endif
  292. #endif //_WIN32
  293. #if defined(__APPLE__)
  294. #include <TargetConditionals.h>
  295. #endif
  296. #include <algorithm>
  297. #include <array>
  298. #include <atomic>
  299. #include <cassert>
  300. #include <chrono>
  301. #include <climits>
  302. #include <condition_variable>
  303. #include <cstdlib>
  304. #include <cstring>
  305. #include <errno.h>
  306. #include <exception>
  307. #include <fcntl.h>
  308. #include <fstream>
  309. #include <functional>
  310. #include <iomanip>
  311. #include <iostream>
  312. #include <iterator>
  313. #include <list>
  314. #include <map>
  315. #include <memory>
  316. #include <mutex>
  317. #include <random>
  318. #include <regex>
  319. #include <set>
  320. #include <sstream>
  321. #include <string>
  322. #include <sys/stat.h>
  323. #include <system_error>
  324. #include <thread>
  325. #include <type_traits>
  326. #include <unordered_map>
  327. #include <unordered_set>
  328. #include <utility>
  329. #include <vector>
  330. // On macOS with a TLS backend, enable Keychain root certificates by default
  331. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  332. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  333. // only; on those platforms the user must provide a CA bundle explicitly.
  334. #if defined(__APPLE__) && defined(__clang__) && \
  335. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  336. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  337. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  338. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  339. #if TARGET_OS_OSX
  340. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  341. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  342. #endif
  343. #endif
  344. #endif
  345. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  346. defined(__APPLE__) && !TARGET_OS_OSX
  347. #error \
  348. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  349. #endif
  350. // On Windows, enable Schannel certificate verification by default
  351. // unless the user explicitly opts out.
  352. #if defined(_WIN32) && \
  353. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  354. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  355. #endif
  356. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  357. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  358. #if TARGET_OS_MAC && defined(__clang__)
  359. #include <CFNetwork/CFHost.h>
  360. #include <CoreFoundation/CoreFoundation.h>
  361. #endif
  362. #endif
  363. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  364. #ifdef _WIN32
  365. #include <wincrypt.h>
  366. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  367. // used
  368. #undef X509_NAME
  369. #undef X509_CERT_PAIR
  370. #undef X509_EXTENSIONS
  371. #undef PKCS7_SIGNER_INFO
  372. #ifdef _MSC_VER
  373. #pragma comment(lib, "crypt32.lib")
  374. #endif
  375. #endif // _WIN32
  376. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  377. #if TARGET_OS_OSX
  378. #include <Security/Security.h>
  379. #endif
  380. #endif
  381. #include <openssl/err.h>
  382. #include <openssl/evp.h>
  383. #include <openssl/rand.h>
  384. #include <openssl/ssl.h>
  385. #include <openssl/x509v3.h>
  386. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  387. #include <openssl/applink.c>
  388. #endif
  389. #include <iostream>
  390. #include <sstream>
  391. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  392. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  393. #error Please use OpenSSL or a current version of BoringSSL
  394. #endif
  395. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  396. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  397. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  398. #endif
  399. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  400. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  401. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  402. // in with this first include group so the version gating below can use it.
  403. #include <mbedtls/error.h>
  404. #include <mbedtls/net_sockets.h>
  405. #include <mbedtls/oid.h>
  406. #include <mbedtls/pk.h>
  407. #include <mbedtls/ssl.h>
  408. #include <mbedtls/version.h>
  409. #include <mbedtls/x509_crt.h>
  410. #if MBEDTLS_VERSION_MAJOR >= 4
  411. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  412. #include <psa/crypto.h>
  413. #else
  414. #include <mbedtls/ctr_drbg.h>
  415. #include <mbedtls/entropy.h>
  416. #include <mbedtls/md5.h>
  417. #include <mbedtls/sha1.h>
  418. #include <mbedtls/sha256.h>
  419. #include <mbedtls/sha512.h>
  420. #endif
  421. #ifdef _WIN32
  422. #include <wincrypt.h>
  423. #ifdef _MSC_VER
  424. #pragma comment(lib, "crypt32.lib")
  425. #endif
  426. #endif // _WIN32
  427. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  428. #if TARGET_OS_OSX
  429. #include <Security/Security.h>
  430. #endif
  431. #endif
  432. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  433. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  434. #if MBEDTLS_VERSION_MAJOR >= 4
  435. #define CPPHTTPLIB_MBEDTLS_V4
  436. #endif
  437. #if MBEDTLS_VERSION_MAJOR >= 3
  438. #define CPPHTTPLIB_MBEDTLS_V3
  439. #endif
  440. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  441. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  442. #include <wolfssl/options.h>
  443. #include <wolfssl/openssl/x509v3.h>
  444. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  445. #ifndef WOLFSSL_GEN_EMAIL
  446. #define WOLFSSL_GEN_EMAIL 1
  447. #endif
  448. #ifndef WOLFSSL_GEN_DNS
  449. #define WOLFSSL_GEN_DNS 2
  450. #endif
  451. #ifndef WOLFSSL_GEN_URI
  452. #define WOLFSSL_GEN_URI 6
  453. #endif
  454. #ifndef WOLFSSL_GEN_IPADD
  455. #define WOLFSSL_GEN_IPADD 7
  456. #endif
  457. #include <wolfssl/ssl.h>
  458. #include <wolfssl/wolfcrypt/hash.h>
  459. #include <wolfssl/wolfcrypt/md5.h>
  460. #include <wolfssl/wolfcrypt/sha256.h>
  461. #include <wolfssl/wolfcrypt/sha512.h>
  462. #ifdef _WIN32
  463. #include <wincrypt.h>
  464. #ifdef _MSC_VER
  465. #pragma comment(lib, "crypt32.lib")
  466. #endif
  467. #endif // _WIN32
  468. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  469. #if TARGET_OS_OSX
  470. #include <Security/Security.h>
  471. #endif
  472. #endif
  473. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  474. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  475. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  476. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  477. #define CPPHTTPLIB_SSL_ENABLED
  478. #endif
  479. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  480. #include <zlib.h>
  481. #endif
  482. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  483. #include <brotli/decode.h>
  484. #include <brotli/encode.h>
  485. #endif
  486. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  487. #include <zstd.h>
  488. #endif
  489. /*
  490. * Declaration
  491. */
  492. namespace httplib {
  493. namespace ws {
  494. class WebSocket;
  495. } // namespace ws
  496. namespace detail {
  497. /*
  498. * Backport std::make_unique from C++14.
  499. *
  500. * NOTE: This code came up with the following stackoverflow post:
  501. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  502. *
  503. */
  504. template <class T, class... Args>
  505. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  506. make_unique(Args &&...args) {
  507. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  508. }
  509. template <class T>
  510. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  511. make_unique(std::size_t n) {
  512. typedef typename std::remove_extent<T>::type RT;
  513. return std::unique_ptr<T>(new RT[n]);
  514. }
  515. // Locale-independent ASCII character classification. The <cctype>
  516. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  517. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  518. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  519. // classified without regard to the locale.
  520. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  521. inline bool is_ascii_alpha(char c) {
  522. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  523. }
  524. inline bool is_ascii_alnum(char c) {
  525. return is_ascii_digit(c) || is_ascii_alpha(c);
  526. }
  527. namespace case_ignore {
  528. inline unsigned char to_lower(int c) {
  529. const static unsigned char table[256] = {
  530. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  531. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  532. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  533. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  534. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  535. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  536. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  537. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  538. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  539. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  540. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  541. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  542. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  543. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  544. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  545. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  546. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  547. 255,
  548. };
  549. return table[(unsigned char)(char)c];
  550. }
  551. inline std::string to_lower(const std::string &s) {
  552. std::string result = s;
  553. std::transform(
  554. result.begin(), result.end(), result.begin(),
  555. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  556. return result;
  557. }
  558. inline bool equal(const std::string &a, const std::string &b) {
  559. return a.size() == b.size() &&
  560. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  561. return to_lower(ca) == to_lower(cb);
  562. });
  563. }
  564. struct equal_to {
  565. bool operator()(const std::string &a, const std::string &b) const {
  566. return equal(a, b);
  567. }
  568. };
  569. struct hash {
  570. size_t operator()(const std::string &key) const {
  571. size_t h = 0;
  572. for (auto c : key) {
  573. // Unsets the 6 high bits of h, therefore no overflow happens
  574. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  575. static_cast<unsigned char>(to_lower(c));
  576. }
  577. return h;
  578. }
  579. };
  580. template <typename T>
  581. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  582. detail::case_ignore::equal_to>;
  583. } // namespace case_ignore
  584. // This is based on
  585. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  586. struct scope_exit {
  587. explicit scope_exit(std::function<void(void)> &&f)
  588. : exit_function(std::move(f)), execute_on_destruction{true} {}
  589. scope_exit(scope_exit &&rhs) noexcept
  590. : exit_function(std::move(rhs.exit_function)),
  591. execute_on_destruction{rhs.execute_on_destruction} {
  592. rhs.release();
  593. }
  594. ~scope_exit() {
  595. if (execute_on_destruction) { this->exit_function(); }
  596. }
  597. void release() { this->execute_on_destruction = false; }
  598. private:
  599. scope_exit(const scope_exit &) = delete;
  600. void operator=(const scope_exit &) = delete;
  601. scope_exit &operator=(scope_exit &&) = delete;
  602. std::function<void(void)> exit_function;
  603. bool execute_on_destruction;
  604. };
  605. // Simple from_chars implementation for integer and double types (C++17
  606. // substitute)
  607. template <typename T> struct from_chars_result {
  608. const char *ptr;
  609. std::errc ec;
  610. };
  611. template <typename T>
  612. inline from_chars_result<T> from_chars(const char *first, const char *last,
  613. T &value, int base = 10) {
  614. value = 0;
  615. const char *p = first;
  616. bool negative = false;
  617. if (p != last && *p == '-') {
  618. negative = true;
  619. ++p;
  620. }
  621. if (p == last) { return {first, std::errc::invalid_argument}; }
  622. T result = 0;
  623. for (; p != last; ++p) {
  624. char c = *p;
  625. int digit = -1;
  626. if (is_ascii_digit(c)) {
  627. digit = c - '0';
  628. } else if ('a' <= c && c <= 'z') {
  629. digit = c - 'a' + 10;
  630. } else if ('A' <= c && c <= 'Z') {
  631. digit = c - 'A' + 10;
  632. } else {
  633. break;
  634. }
  635. if (digit < 0 || digit >= base) { break; }
  636. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  637. return {p, std::errc::result_out_of_range};
  638. }
  639. result = result * base + digit;
  640. }
  641. if (p == first || (negative && p == first + 1)) {
  642. return {first, std::errc::invalid_argument};
  643. }
  644. value = negative ? T(0) - result : result;
  645. return {p, std::errc{}};
  646. }
  647. // from_chars for double (hand-written, locale-independent)
  648. //
  649. // The only double consumed by this library is the HTTP quality value, whose
  650. // grammar is (RFC 9110 12.4.2):
  651. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  652. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  653. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  654. // '.' always the decimal separator (std::strtod would instead read it from the
  655. // global C locale, mis-parsing q-values once an embedder calls
  656. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  657. // the result to [0, 1], so inputs outside that range need not be distinguished
  658. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  659. // cases that exponent and wide-range handling would introduce.
  660. inline from_chars_result<double> from_chars(const char *first, const char *last,
  661. double &value) {
  662. value = 0.0;
  663. const char *p = first;
  664. // Each 1eN is exactly representable, so a single final division by the
  665. // matching entry yields a correctly-rounded result.
  666. static const double powers_of_ten[] = {
  667. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  668. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  669. const int max_frac_digits =
  670. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  671. // Accumulate digits into a 64-bit integer and remember how many were
  672. // fractional. Two independent caps keep this bounded and safe:
  673. // * accumulation saturates before mantissa could overflow uint64_t, and
  674. // * frac_digits is capped at max_frac_digits so it is always a valid index
  675. // into powers_of_ten (without this an input like "0.000...0" would never
  676. // grow mantissa, so the saturation cap alone would not bound it).
  677. // Both caps only drop digits far beyond the precision a q-value needs; any
  678. // value they would change is well outside [0, 1] and rejected by the caller.
  679. uint64_t mantissa = 0;
  680. int frac_digits = 0;
  681. bool seen_digit = false;
  682. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  683. auto accumulate = [&](char c) {
  684. if (mantissa <= limit) {
  685. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  686. return true;
  687. }
  688. return false;
  689. };
  690. for (; p != last && is_ascii_digit(*p); ++p) {
  691. seen_digit = true;
  692. accumulate(*p);
  693. }
  694. if (p != last && *p == '.') {
  695. ++p;
  696. for (; p != last && is_ascii_digit(*p); ++p) {
  697. seen_digit = true;
  698. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  699. }
  700. }
  701. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  702. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  703. return {p, std::errc{}};
  704. }
  705. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  706. int &out) {
  707. int val = 0;
  708. auto r = from_chars(s, s + len, val);
  709. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  710. return false;
  711. }
  712. out = val;
  713. return true;
  714. }
  715. inline bool parse_port(const char *s, size_t len, int &port) {
  716. return parse_int_in_range(s, len, 1, 65535, port);
  717. }
  718. inline bool parse_port(const std::string &s, int &port) {
  719. return parse_port(s.data(), s.size(), port);
  720. }
  721. struct UrlComponents {
  722. std::string scheme;
  723. std::string host;
  724. std::string port;
  725. std::string path;
  726. std::string query;
  727. };
  728. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  729. uc = {};
  730. size_t pos = 0;
  731. auto sep = url.find("://");
  732. if (sep != std::string::npos) {
  733. uc.scheme = url.substr(0, sep);
  734. // Scheme must be [a-z]+ only
  735. if (uc.scheme.empty()) { return false; }
  736. for (auto c : uc.scheme) {
  737. if (c < 'a' || c > 'z') { return false; }
  738. }
  739. pos = sep + 3;
  740. } else if (url.compare(0, 2, "//") == 0) {
  741. pos = 2;
  742. }
  743. auto has_authority_prefix = pos > 0;
  744. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  745. url[0] != '?' && url[0] != '#');
  746. if (has_authority) {
  747. // userinfo is not supported, and a backslash that some parsers take for
  748. // '/' would leave them seeing another host than this one.
  749. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  750. return false;
  751. }
  752. if (pos < url.size() && url[pos] == '[') {
  753. auto close = url.find(']', pos);
  754. if (close == std::string::npos) { return false; }
  755. uc.host = url.substr(pos + 1, close - pos - 1);
  756. // IPv6 host must be [a-fA-F0-9:]+ only
  757. if (uc.host.empty()) { return false; }
  758. for (auto c : uc.host) {
  759. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  760. (c >= 'A' && c <= 'F') || c == ':')) {
  761. return false;
  762. }
  763. }
  764. pos = close + 1;
  765. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  766. // path, query or fragment delimiter (or the end of input). Otherwise the
  767. // trailing bytes would be folded into the path while the connection
  768. // still targets the bracketed address.
  769. if (pos < url.size()) {
  770. auto c = url[pos];
  771. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  772. }
  773. } else {
  774. auto end = url.find_first_of(":/?#", pos);
  775. if (end == std::string::npos) { end = url.size(); }
  776. uc.host = url.substr(pos, end - pos);
  777. pos = end;
  778. }
  779. if (pos < url.size() && url[pos] == ':') {
  780. ++pos;
  781. auto end = url.find_first_of("/?#", pos);
  782. if (end == std::string::npos) { end = url.size(); }
  783. uc.port = url.substr(pos, end - pos);
  784. pos = end;
  785. }
  786. // Without :// or //, the entire input must be consumed as host[:port].
  787. // If there is leftover (path, query, etc.), this is not a valid
  788. // host[:port] string — clear and reparse as a plain path.
  789. if (!has_authority_prefix && pos < url.size()) {
  790. uc.host.clear();
  791. uc.port.clear();
  792. pos = 0;
  793. }
  794. }
  795. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  796. auto end = url.find_first_of("?#", pos);
  797. if (end == std::string::npos) { end = url.size(); }
  798. uc.path = url.substr(pos, end - pos);
  799. pos = end;
  800. }
  801. if (pos < url.size() && url[pos] == '?') {
  802. auto end = url.find('#', pos);
  803. if (end == std::string::npos) { end = url.size(); }
  804. uc.query = url.substr(pos, end - pos);
  805. }
  806. return true;
  807. }
  808. // Resolves a relative-path or query-only Location value against the path of
  809. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  810. // references starting with '/' are returned unchanged.
  811. inline std::string resolve_relative_location(const std::string &location,
  812. const std::string &base) {
  813. if (location.empty() || location[0] == '/') { return location; }
  814. // A ':' in the first segment means the value has a scheme.
  815. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  816. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  817. auto base_path = base.substr(0, base.find_first_of("?#"));
  818. if (location[0] == '?') { return base_path + location; }
  819. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  820. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  821. // Remove "." and ".." segments from the merged path.
  822. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  823. std::string path;
  824. size_t i = 0;
  825. while (i < path_end) {
  826. auto next = (std::min)(merged.find('/', i + 1), path_end);
  827. auto segment = merged.substr(i + 1, next - i - 1);
  828. auto is_last = next == path_end;
  829. if (segment == "." || segment == "..") {
  830. if (segment == "..") {
  831. path.erase((std::min)(path.rfind('/'), path.size()));
  832. }
  833. if (is_last) { path += '/'; }
  834. } else {
  835. path += '/';
  836. path += segment;
  837. }
  838. i = next;
  839. }
  840. if (path.empty()) { path = "/"; }
  841. return path + merged.substr(path_end);
  842. }
  843. } // namespace detail
  844. enum class SSLVerifierResponse {
  845. // no decision has been made, use the built-in certificate verifier
  846. NoDecisionMade,
  847. // connection certificate is verified and accepted
  848. CertificateAccepted,
  849. // connection certificate was processed but is rejected
  850. CertificateRejected
  851. };
  852. // System CA loading policy for SSL clients. Auto (the default) loads system
  853. // CA certs only when no custom CA is configured; enable_system_ca() switches
  854. // to an explicit policy.
  855. enum class SystemCAMode { Auto, Enabled, Disabled };
  856. enum StatusCode {
  857. // Information responses
  858. Continue_100 = 100,
  859. SwitchingProtocol_101 = 101,
  860. Processing_102 = 102,
  861. EarlyHints_103 = 103,
  862. // Successful responses
  863. OK_200 = 200,
  864. Created_201 = 201,
  865. Accepted_202 = 202,
  866. NonAuthoritativeInformation_203 = 203,
  867. NoContent_204 = 204,
  868. ResetContent_205 = 205,
  869. PartialContent_206 = 206,
  870. MultiStatus_207 = 207,
  871. AlreadyReported_208 = 208,
  872. IMUsed_226 = 226,
  873. // Redirection messages
  874. MultipleChoices_300 = 300,
  875. MovedPermanently_301 = 301,
  876. Found_302 = 302,
  877. SeeOther_303 = 303,
  878. NotModified_304 = 304,
  879. UseProxy_305 = 305,
  880. unused_306 = 306,
  881. TemporaryRedirect_307 = 307,
  882. PermanentRedirect_308 = 308,
  883. // Client error responses
  884. BadRequest_400 = 400,
  885. Unauthorized_401 = 401,
  886. PaymentRequired_402 = 402,
  887. Forbidden_403 = 403,
  888. NotFound_404 = 404,
  889. MethodNotAllowed_405 = 405,
  890. NotAcceptable_406 = 406,
  891. ProxyAuthenticationRequired_407 = 407,
  892. RequestTimeout_408 = 408,
  893. Conflict_409 = 409,
  894. Gone_410 = 410,
  895. LengthRequired_411 = 411,
  896. PreconditionFailed_412 = 412,
  897. PayloadTooLarge_413 = 413,
  898. UriTooLong_414 = 414,
  899. UnsupportedMediaType_415 = 415,
  900. RangeNotSatisfiable_416 = 416,
  901. ExpectationFailed_417 = 417,
  902. ImATeapot_418 = 418,
  903. MisdirectedRequest_421 = 421,
  904. UnprocessableContent_422 = 422,
  905. Locked_423 = 423,
  906. FailedDependency_424 = 424,
  907. TooEarly_425 = 425,
  908. UpgradeRequired_426 = 426,
  909. PreconditionRequired_428 = 428,
  910. TooManyRequests_429 = 429,
  911. RequestHeaderFieldsTooLarge_431 = 431,
  912. UnavailableForLegalReasons_451 = 451,
  913. // Server error responses
  914. InternalServerError_500 = 500,
  915. NotImplemented_501 = 501,
  916. BadGateway_502 = 502,
  917. ServiceUnavailable_503 = 503,
  918. GatewayTimeout_504 = 504,
  919. HttpVersionNotSupported_505 = 505,
  920. VariantAlsoNegotiates_506 = 506,
  921. InsufficientStorage_507 = 507,
  922. LoopDetected_508 = 508,
  923. NotExtended_510 = 510,
  924. NetworkAuthenticationRequired_511 = 511,
  925. };
  926. namespace detail {
  927. // A multimap that keeps its entries in the order they were inserted.
  928. //
  929. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  930. // fields sharing a field name significant and forbids a proxy from reordering
  931. // them, and a query string's parameters are meaningful in the order the caller
  932. // wrote them. Neither standard container expresses it: std::unordered_multimap
  933. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  934. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  935. // key, which would drop control data such as Host behind whatever else the
  936. // message carries and alphabetise a query string.
  937. //
  938. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  939. // scan, which beats hashing for the handful of entries a message carries
  940. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  941. //
  942. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  943. // Params, whose parameter names are case-sensitive, not.
  944. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  945. public:
  946. using key_type = std::string;
  947. using mapped_type = Mapped;
  948. using value_type = std::pair<std::string, Mapped>;
  949. using size_type = std::size_t;
  950. using difference_type = std::ptrdiff_t;
  951. using reference = value_type &;
  952. using const_reference = const value_type &;
  953. private:
  954. static size_type npos() { return static_cast<size_type>(-1); }
  955. static bool keys_equal(const std::string &a, const std::string &b) {
  956. return KeyEqual()(a, b);
  957. }
  958. // Iterating yields every entry in insertion order, but equal_range() and
  959. // find() have to walk only the entries sharing one key, which are not
  960. // adjacent. Both are the same iterator type: key_idx_ selects between the
  961. // two traversals, and since equality compares only the position, an iterator
  962. // restricted to one key still compares equal to end().
  963. template <typename V> class iterator_t {
  964. public:
  965. using iterator_category = std::bidirectional_iterator_tag;
  966. using value_type = insertion_ordered_multimap::value_type;
  967. using difference_type = insertion_ordered_multimap::difference_type;
  968. using pointer = V *;
  969. using reference = V &;
  970. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  971. template <typename U,
  972. typename std::enable_if<std::is_convertible<U *, V *>::value,
  973. int>::type = 0>
  974. iterator_t(const iterator_t<U> &rhs)
  975. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  976. key_idx_(rhs.key_idx_) {}
  977. reference operator*() const { return data_[idx_]; }
  978. pointer operator->() const { return data_ + idx_; }
  979. iterator_t &operator++() {
  980. // Saturating, so that advancing past the last entry of a key stays at
  981. // end() instead of running off the container.
  982. if (idx_ >= size_) { return *this; }
  983. ++idx_;
  984. if (key_idx_ != npos()) {
  985. while (idx_ < size_ && !matches(idx_)) {
  986. ++idx_;
  987. }
  988. }
  989. return *this;
  990. }
  991. iterator_t operator++(int) {
  992. auto tmp = *this;
  993. ++*this;
  994. return tmp;
  995. }
  996. iterator_t &operator--() {
  997. if (idx_ == 0) { return *this; }
  998. --idx_;
  999. if (key_idx_ != npos()) {
  1000. while (idx_ > 0 && !matches(idx_)) {
  1001. --idx_;
  1002. }
  1003. }
  1004. return *this;
  1005. }
  1006. iterator_t operator--(int) {
  1007. auto tmp = *this;
  1008. --*this;
  1009. return tmp;
  1010. }
  1011. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1012. return idx_ == rhs.idx_;
  1013. }
  1014. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1015. return idx_ != rhs.idx_;
  1016. }
  1017. private:
  1018. friend class insertion_ordered_multimap;
  1019. template <typename> friend class iterator_t;
  1020. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1021. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1022. bool matches(size_type i) const {
  1023. return keys_equal(data_[i].first, data_[key_idx_].first);
  1024. }
  1025. V *data_;
  1026. size_type idx_;
  1027. size_type size_;
  1028. size_type key_idx_;
  1029. };
  1030. public:
  1031. using iterator = iterator_t<value_type>;
  1032. using const_iterator = iterator_t<const value_type>;
  1033. insertion_ordered_multimap() = default;
  1034. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1035. : entries_(il) {}
  1036. template <typename InputIt>
  1037. insertion_ordered_multimap(InputIt first, InputIt last)
  1038. : entries_(first, last) {}
  1039. iterator begin() { return make_iter(0, npos()); }
  1040. iterator end() { return make_iter(entries_.size(), npos()); }
  1041. const_iterator begin() const { return make_citer(0, npos()); }
  1042. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1043. const_iterator cbegin() const { return begin(); }
  1044. const_iterator cend() const { return end(); }
  1045. bool empty() const { return entries_.empty(); }
  1046. size_type size() const { return entries_.size(); }
  1047. void clear() { entries_.clear(); }
  1048. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1049. iterator insert(const value_type &val) {
  1050. entries_.push_back(val);
  1051. return make_iter(entries_.size() - 1, npos());
  1052. }
  1053. iterator insert(value_type &&val) {
  1054. entries_.push_back(std::move(val));
  1055. return make_iter(entries_.size() - 1, npos());
  1056. }
  1057. template <typename... Args> iterator emplace(Args &&...args) {
  1058. entries_.emplace_back(std::forward<Args>(args)...);
  1059. return make_iter(entries_.size() - 1, npos());
  1060. }
  1061. // For entries that have to lead the message, such as the Host header field
  1062. // (RFC 9110 5.3 recommends sending control data first).
  1063. template <typename... Args> iterator emplace_front(Args &&...args) {
  1064. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1065. return make_iter(0, npos());
  1066. }
  1067. iterator find(const std::string &key) {
  1068. auto i = index_of(key);
  1069. return i == npos() ? end() : make_iter(i, i);
  1070. }
  1071. const_iterator find(const std::string &key) const {
  1072. auto i = index_of(key);
  1073. return i == npos() ? end() : make_citer(i, i);
  1074. }
  1075. size_type count(const std::string &key) const {
  1076. size_type n = 0;
  1077. for (const auto &entry : entries_) {
  1078. if (keys_equal(entry.first, key)) { n++; }
  1079. }
  1080. return n;
  1081. }
  1082. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1083. auto i = index_of(key);
  1084. return i == npos() ? std::make_pair(end(), end())
  1085. : std::make_pair(make_iter(i, i), end());
  1086. }
  1087. std::pair<const_iterator, const_iterator>
  1088. equal_range(const std::string &key) const {
  1089. auto i = index_of(key);
  1090. return i == npos() ? std::make_pair(end(), end())
  1091. : std::make_pair(make_citer(i, i), end());
  1092. }
  1093. size_type erase(const std::string &key) {
  1094. auto before = entries_.size();
  1095. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1096. [&](const value_type &entry) {
  1097. return keys_equal(entry.first, key);
  1098. }),
  1099. entries_.end());
  1100. return before - entries_.size();
  1101. }
  1102. iterator erase(const_iterator pos) {
  1103. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1104. return make_iter(pos.idx_, npos());
  1105. }
  1106. // Erases what iterating [first, last) would actually visit, so erasing an
  1107. // equal_range() removes only the entries with that key, not everything
  1108. // positioned between them.
  1109. iterator erase(const_iterator first, const_iterator last) {
  1110. auto from = first.idx_;
  1111. auto to = last.idx_;
  1112. if (from >= to) { return make_iter(from, npos()); }
  1113. auto begin_it = entries_.begin();
  1114. auto from_it = begin_it + static_cast<difference_type>(from);
  1115. auto to_it = begin_it + static_cast<difference_type>(to);
  1116. if (first.key_idx_ == npos()) {
  1117. entries_.erase(from_it, to_it);
  1118. } else {
  1119. auto key = entries_[first.key_idx_].first;
  1120. auto keep = from_it;
  1121. for (auto it = from_it; it != to_it; ++it) {
  1122. if (!keys_equal(it->first, key)) {
  1123. if (keep != it) { *keep = std::move(*it); }
  1124. ++keep;
  1125. }
  1126. }
  1127. if (keep != to_it) {
  1128. keep = std::move(to_it, entries_.end(), keep);
  1129. } else {
  1130. keep = entries_.end();
  1131. }
  1132. entries_.erase(keep, entries_.end());
  1133. }
  1134. return make_iter(from, npos());
  1135. }
  1136. friend bool operator==(const insertion_ordered_multimap &lhs,
  1137. const insertion_ordered_multimap &rhs) {
  1138. return lhs.entries_ == rhs.entries_;
  1139. }
  1140. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1141. const insertion_ordered_multimap &rhs) {
  1142. return !(lhs == rhs);
  1143. }
  1144. private:
  1145. size_type index_of(const std::string &key) const {
  1146. for (size_type i = 0; i < entries_.size(); i++) {
  1147. if (keys_equal(entries_[i].first, key)) { return i; }
  1148. }
  1149. return npos();
  1150. }
  1151. iterator make_iter(size_type idx, size_type key_idx) {
  1152. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1153. }
  1154. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1155. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1156. }
  1157. std::vector<value_type> entries_;
  1158. };
  1159. } // namespace detail
  1160. using Headers =
  1161. detail::insertion_ordered_multimap<std::string,
  1162. detail::case_ignore::equal_to>;
  1163. // Query parameter names are case-sensitive, unlike header field names.
  1164. using Params =
  1165. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1166. using Match = std::smatch;
  1167. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1168. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1169. /*
  1170. * detail: type-erased storage used by UserData.
  1171. * ABI-stable regardless of C++ standard — always uses this custom
  1172. * implementation instead of std::any.
  1173. */
  1174. namespace detail {
  1175. using any_type_id = const void *;
  1176. template <typename T> any_type_id any_typeid() noexcept {
  1177. static const char id = 0;
  1178. return &id;
  1179. }
  1180. struct any_storage {
  1181. virtual ~any_storage() = default;
  1182. virtual std::unique_ptr<any_storage> clone() const = 0;
  1183. virtual any_type_id type_id() const noexcept = 0;
  1184. };
  1185. template <typename T> struct any_value final : any_storage {
  1186. T value;
  1187. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1188. std::unique_ptr<any_storage> clone() const override {
  1189. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1190. }
  1191. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1192. };
  1193. } // namespace detail
  1194. class UserData {
  1195. public:
  1196. UserData() = default;
  1197. UserData(UserData &&) noexcept = default;
  1198. UserData &operator=(UserData &&) noexcept = default;
  1199. UserData(const UserData &o) {
  1200. for (const auto &e : o.entries_) {
  1201. if (e.second) { entries_[e.first] = e.second->clone(); }
  1202. }
  1203. }
  1204. UserData &operator=(const UserData &o) {
  1205. if (this != &o) {
  1206. entries_.clear();
  1207. for (const auto &e : o.entries_) {
  1208. if (e.second) { entries_[e.first] = e.second->clone(); }
  1209. }
  1210. }
  1211. return *this;
  1212. }
  1213. template <typename T> void set(const std::string &key, T &&value) {
  1214. using D = typename std::decay<T>::type;
  1215. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1216. }
  1217. template <typename T> T *get(const std::string &key) noexcept {
  1218. auto it = entries_.find(key);
  1219. if (it == entries_.end() || !it->second) { return nullptr; }
  1220. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1221. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1222. }
  1223. template <typename T> const T *get(const std::string &key) const noexcept {
  1224. auto it = entries_.find(key);
  1225. if (it == entries_.end() || !it->second) { return nullptr; }
  1226. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1227. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1228. }
  1229. bool has(const std::string &key) const noexcept {
  1230. return entries_.find(key) != entries_.end();
  1231. }
  1232. void erase(const std::string &key) { entries_.erase(key); }
  1233. void clear() noexcept { entries_.clear(); }
  1234. private:
  1235. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1236. entries_;
  1237. };
  1238. struct Response;
  1239. using ResponseHandler = std::function<bool(const Response &response)>;
  1240. struct FormData {
  1241. std::string name;
  1242. std::string content;
  1243. std::string filename;
  1244. std::string content_type;
  1245. Headers headers;
  1246. };
  1247. struct FormField {
  1248. std::string name;
  1249. std::string content;
  1250. Headers headers;
  1251. };
  1252. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1253. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1254. // should see the parts as they were sent. A std::multimap sorts by field name
  1255. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1256. // than the case-insensitive predicate Headers uses.
  1257. using FormFields =
  1258. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1259. using FormFiles =
  1260. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1261. struct MultipartFormData {
  1262. FormFields fields; // Text fields from multipart
  1263. FormFiles files; // Files from multipart
  1264. // Text field access
  1265. std::string get_field(const std::string &key, size_t id = 0) const;
  1266. std::vector<std::string> get_fields(const std::string &key) const;
  1267. bool has_field(const std::string &key) const;
  1268. size_t get_field_count(const std::string &key) const;
  1269. // File access
  1270. FormData get_file(const std::string &key, size_t id = 0) const;
  1271. std::vector<FormData> get_files(const std::string &key) const;
  1272. bool has_file(const std::string &key) const;
  1273. size_t get_file_count(const std::string &key) const;
  1274. };
  1275. struct UploadFormData {
  1276. std::string name;
  1277. std::string content;
  1278. std::string filename;
  1279. std::string content_type;
  1280. };
  1281. using UploadFormDataItems = std::vector<UploadFormData>;
  1282. class DataSink {
  1283. public:
  1284. DataSink() : os(&sb_), sb_(*this) {}
  1285. DataSink(const DataSink &) = delete;
  1286. DataSink &operator=(const DataSink &) = delete;
  1287. DataSink(DataSink &&) = delete;
  1288. DataSink &operator=(DataSink &&) = delete;
  1289. std::function<bool(const char *data, size_t data_len)> write;
  1290. // Only `write` is mandatory. The rest are defaulted so that a provider
  1291. // calling one on a writer that does not set it gets sensible behaviour
  1292. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1293. // `this` is safe: DataSink is neither copyable nor movable.
  1294. std::function<bool()> is_writable = []() { return true; };
  1295. std::function<void()> done = []() {};
  1296. std::function<void(const Headers &trailer)> done_with_trailer =
  1297. [this](const Headers & /*trailer*/) { done(); };
  1298. std::ostream os;
  1299. private:
  1300. class data_sink_streambuf final : public std::streambuf {
  1301. public:
  1302. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1303. protected:
  1304. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1305. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1306. return 0;
  1307. }
  1308. private:
  1309. DataSink &sink_;
  1310. };
  1311. data_sink_streambuf sb_;
  1312. };
  1313. using ContentProvider =
  1314. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1315. using ContentProviderWithoutLength =
  1316. std::function<bool(size_t offset, DataSink &sink)>;
  1317. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1318. struct FormDataProvider {
  1319. std::string name;
  1320. ContentProviderWithoutLength provider;
  1321. std::string filename;
  1322. std::string content_type;
  1323. };
  1324. using FormDataProviderItems = std::vector<FormDataProvider>;
  1325. inline FormDataProvider
  1326. make_file_provider(const std::string &name, const std::string &filepath,
  1327. const std::string &filename = std::string(),
  1328. const std::string &content_type = std::string()) {
  1329. FormDataProvider fdp;
  1330. fdp.name = name;
  1331. fdp.filename = filename.empty() ? filepath : filename;
  1332. fdp.content_type = content_type;
  1333. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1334. std::ifstream f(filepath, std::ios::binary);
  1335. if (!f) { return false; }
  1336. if (offset > 0) {
  1337. f.seekg(static_cast<std::streamoff>(offset));
  1338. if (!f.good()) {
  1339. sink.done();
  1340. return true;
  1341. }
  1342. }
  1343. char buf[8192];
  1344. f.read(buf, sizeof(buf));
  1345. auto n = static_cast<size_t>(f.gcount());
  1346. if (n > 0) { return sink.write(buf, n); }
  1347. sink.done(); // EOF
  1348. return true;
  1349. };
  1350. return fdp;
  1351. }
  1352. inline std::pair<size_t, ContentProvider>
  1353. make_file_body(const std::string &filepath) {
  1354. size_t size = 0;
  1355. {
  1356. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1357. if (!f) { return {0, ContentProvider{}}; }
  1358. size = static_cast<size_t>(f.tellg());
  1359. }
  1360. ContentProvider provider = [filepath](size_t offset, size_t length,
  1361. DataSink &sink) -> bool {
  1362. std::ifstream f(filepath, std::ios::binary);
  1363. if (!f) { return false; }
  1364. f.seekg(static_cast<std::streamoff>(offset));
  1365. if (!f.good()) { return false; }
  1366. char buf[8192];
  1367. while (length > 0) {
  1368. auto to_read = (std::min)(sizeof(buf), length);
  1369. f.read(buf, static_cast<std::streamsize>(to_read));
  1370. auto n = static_cast<size_t>(f.gcount());
  1371. // The file is shorter than the size make_file_body() measured, which the
  1372. // caller has already committed to as Content-Length. The body cannot be
  1373. // completed, so fail as every other error here does.
  1374. if (n == 0) { return false; }
  1375. if (!sink.write(buf, n)) { return false; }
  1376. length -= n;
  1377. }
  1378. return true;
  1379. };
  1380. return {size, std::move(provider)};
  1381. }
  1382. using ContentReceiverWithProgress = std::function<bool(
  1383. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1384. using ContentReceiver =
  1385. std::function<bool(const char *data, size_t data_length)>;
  1386. using FormDataHeader = std::function<bool(const FormData &file)>;
  1387. class ContentReader {
  1388. public:
  1389. using Reader = std::function<bool(ContentReceiver receiver)>;
  1390. using FormDataReader =
  1391. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1392. ContentReader(Reader reader, FormDataReader multipart_reader)
  1393. : reader_(std::move(reader)),
  1394. formdata_reader_(std::move(multipart_reader)) {}
  1395. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1396. return formdata_reader_(std::move(header), std::move(receiver));
  1397. }
  1398. bool operator()(ContentReceiver receiver) const {
  1399. return reader_(std::move(receiver));
  1400. }
  1401. Reader reader_;
  1402. FormDataReader formdata_reader_;
  1403. };
  1404. using Range = std::pair<ssize_t, ssize_t>;
  1405. using Ranges = std::vector<Range>;
  1406. #ifdef CPPHTTPLIB_SSL_ENABLED
  1407. // TLS abstraction layer - public type definitions and API
  1408. namespace tls {
  1409. // Opaque handles (defined as void* for abstraction)
  1410. using ctx_t = void *;
  1411. using session_t = void *;
  1412. using const_session_t = const void *; // For read-only session access
  1413. using cert_t = void *;
  1414. using ca_store_t = void *;
  1415. // TLS versions
  1416. enum class Version {
  1417. TLS1_2 = 0x0303,
  1418. TLS1_3 = 0x0304,
  1419. };
  1420. // Subject Alternative Names (SAN) entry types
  1421. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1422. // SAN entry structure
  1423. struct SanEntry {
  1424. SanType type;
  1425. std::string value;
  1426. };
  1427. // Verification context for certificate verification callback
  1428. struct VerifyContext {
  1429. session_t session; // TLS session handle
  1430. cert_t cert; // Current certificate being verified
  1431. int depth; // Certificate chain depth (0 = leaf)
  1432. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1433. long error_code; // Backend-specific error code (0 = no error)
  1434. const char *error_string; // Human-readable error description
  1435. // Certificate introspection methods
  1436. std::string subject_cn() const;
  1437. std::string issuer_name() const;
  1438. bool check_hostname(const char *hostname) const;
  1439. std::vector<SanEntry> sans() const;
  1440. bool validity(time_t &not_before, time_t &not_after) const;
  1441. std::string serial() const;
  1442. };
  1443. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1444. // TlsError codes for TLS operations (backend-independent)
  1445. enum class ErrorCode : int {
  1446. Success = 0,
  1447. WantRead, // Non-blocking: need to wait for read
  1448. WantWrite, // Non-blocking: need to wait for write
  1449. PeerClosed, // Peer closed the connection
  1450. Fatal, // Unrecoverable error
  1451. SyscallError, // System call error (check sys_errno)
  1452. CertVerifyFailed, // Certificate verification failed
  1453. HostnameMismatch, // Hostname verification failed
  1454. };
  1455. // TLS error information
  1456. struct TlsError {
  1457. ErrorCode code = ErrorCode::Fatal;
  1458. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1459. int sys_errno = 0; // errno when SyscallError
  1460. // Convert verification error code to human-readable string
  1461. static std::string verify_error_to_string(long error_code);
  1462. };
  1463. // RAII wrapper for peer certificate
  1464. class PeerCert {
  1465. public:
  1466. PeerCert();
  1467. PeerCert(PeerCert &&other) noexcept;
  1468. PeerCert &operator=(PeerCert &&other) noexcept;
  1469. ~PeerCert();
  1470. PeerCert(const PeerCert &) = delete;
  1471. PeerCert &operator=(const PeerCert &) = delete;
  1472. explicit operator bool() const;
  1473. std::string subject_cn() const;
  1474. std::string issuer_name() const;
  1475. bool check_hostname(const char *hostname) const;
  1476. std::vector<SanEntry> sans() const;
  1477. bool validity(time_t &not_before, time_t &not_after) const;
  1478. std::string serial() const;
  1479. private:
  1480. explicit PeerCert(cert_t cert);
  1481. cert_t cert_ = nullptr;
  1482. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1483. };
  1484. // Callback for TLS context setup (used by SSLServer constructor)
  1485. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1486. } // namespace tls
  1487. #endif
  1488. struct Request {
  1489. std::string method;
  1490. std::string path;
  1491. std::string matched_route;
  1492. Params params;
  1493. Headers headers;
  1494. Headers trailers;
  1495. std::string body;
  1496. std::string remote_addr;
  1497. int remote_port = -1;
  1498. std::string local_addr;
  1499. int local_port = -1;
  1500. // for server
  1501. std::string version;
  1502. std::string target;
  1503. MultipartFormData form;
  1504. Ranges ranges;
  1505. Match matches;
  1506. std::unordered_map<std::string, std::string> path_params;
  1507. std::function<bool()> is_connection_closed = []() { return true; };
  1508. // for client
  1509. std::vector<std::string> accept_content_types;
  1510. ResponseHandler response_handler;
  1511. ContentReceiverWithProgress content_receiver;
  1512. DownloadProgress download_progress;
  1513. UploadProgress upload_progress;
  1514. bool has_header(const std::string &key) const;
  1515. std::string get_header_value(const std::string &key, const char *def = "",
  1516. size_t id = 0) const;
  1517. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1518. size_t id = 0) const;
  1519. size_t get_header_value_count(const std::string &key) const;
  1520. void set_header(const std::string &key, const std::string &val);
  1521. bool has_trailer(const std::string &key) const;
  1522. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1523. size_t get_trailer_value_count(const std::string &key) const;
  1524. bool has_param(const std::string &key) const;
  1525. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1526. std::vector<std::string> get_param_values(const std::string &key) const;
  1527. size_t get_param_value_count(const std::string &key) const;
  1528. bool is_multipart_form_data() const;
  1529. // private members...
  1530. bool body_read_started_ = false;
  1531. bool body_consumed_ = false;
  1532. bool expect_100_continue_pending_ = false;
  1533. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1534. size_t content_length_ = 0;
  1535. ContentProvider content_provider_;
  1536. bool is_chunked_content_provider_ = false;
  1537. size_t authorization_count_ = 0;
  1538. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1539. (std::chrono::steady_clock::time_point::min)();
  1540. #ifdef CPPHTTPLIB_SSL_ENABLED
  1541. tls::const_session_t ssl = nullptr;
  1542. tls::PeerCert peer_cert() const;
  1543. std::string sni() const;
  1544. #endif
  1545. };
  1546. namespace detail {
  1547. // Declared up here, away from the rest of the compression helpers, because
  1548. // `Response` stores one.
  1549. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1550. } // namespace detail
  1551. struct Response {
  1552. std::string version;
  1553. int status = -1;
  1554. std::string reason;
  1555. Headers headers;
  1556. Headers trailers;
  1557. std::string body;
  1558. std::string location; // Redirect location
  1559. // User-defined context — set by pre-routing/pre-request handlers and read
  1560. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1561. UserData user_data;
  1562. bool has_header(const std::string &key) const;
  1563. std::string get_header_value(const std::string &key, const char *def = "",
  1564. size_t id = 0) const;
  1565. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1566. size_t id = 0) const;
  1567. size_t get_header_value_count(const std::string &key) const;
  1568. void set_header(const std::string &key, const std::string &val);
  1569. bool has_trailer(const std::string &key) const;
  1570. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1571. size_t get_trailer_value_count(const std::string &key) const;
  1572. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1573. void set_content(const char *s, size_t n, const std::string &content_type);
  1574. void set_content(const std::string &s, const std::string &content_type);
  1575. void set_content(std::string &&s, const std::string &content_type);
  1576. void set_content_provider(
  1577. size_t length, const std::string &content_type, ContentProvider provider,
  1578. ContentProviderResourceReleaser resource_releaser = nullptr);
  1579. void set_content_provider(
  1580. const std::string &content_type, ContentProviderWithoutLength provider,
  1581. ContentProviderResourceReleaser resource_releaser = nullptr);
  1582. void set_chunked_content_provider(
  1583. const std::string &content_type, ContentProviderWithoutLength provider,
  1584. ContentProviderResourceReleaser resource_releaser = nullptr);
  1585. void set_file_content(const std::string &path,
  1586. const std::string &content_type);
  1587. void set_file_content(const std::string &path);
  1588. Response() = default;
  1589. Response(const Response &) = default;
  1590. Response &operator=(const Response &) = default;
  1591. Response(Response &&) = default;
  1592. Response &operator=(Response &&) = default;
  1593. ~Response() {
  1594. if (content_provider_resource_releaser_) {
  1595. content_provider_resource_releaser_(content_provider_success_);
  1596. }
  1597. }
  1598. // private members...
  1599. size_t content_length_ = 0;
  1600. ContentProvider content_provider_;
  1601. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1602. bool is_chunked_content_provider_ = false;
  1603. bool is_file_content_provider_ = false;
  1604. bool content_provider_success_ = false;
  1605. std::string file_content_path_;
  1606. std::string file_content_content_type_;
  1607. // Content coding chosen for the response body, decided once so that the
  1608. // headers and the body cannot disagree: where the file is opened for a
  1609. // file-backed content provider (keeping the ETag honest), and in
  1610. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1611. // for every other kind of response.
  1612. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1613. };
  1614. enum class Error {
  1615. Success = 0,
  1616. Unknown,
  1617. Connection,
  1618. BindIPAddress,
  1619. Read,
  1620. Write,
  1621. ExceedRedirectCount,
  1622. Canceled,
  1623. SSLConnection,
  1624. SSLLoadingCerts,
  1625. SSLServerVerification,
  1626. SSLServerHostnameVerification,
  1627. UnsupportedMultipartBoundaryChars,
  1628. Compression,
  1629. ConnectionTimeout,
  1630. ProxyConnection,
  1631. ConnectionClosed,
  1632. Timeout,
  1633. ResourceExhaustion,
  1634. TooManyFormDataFiles,
  1635. ExceedMaxPayloadSize,
  1636. ExceedUriMaxLength,
  1637. ExceedMaxSocketDescriptorCount,
  1638. InvalidRequestLine,
  1639. InvalidHTTPMethod,
  1640. InvalidHTTPVersion,
  1641. InvalidHeaders,
  1642. MultipartParsing,
  1643. OpenFile,
  1644. Listen,
  1645. GetSockName,
  1646. UnsupportedAddressFamily,
  1647. HTTPParsing,
  1648. InvalidRangeHeader,
  1649. UnsupportedContentEncoding,
  1650. WebSocketHandshake,
  1651. UserCallbackException,
  1652. // For internal use only
  1653. SSLPeerCouldBeClosed_,
  1654. };
  1655. std::string to_string(Error error);
  1656. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1657. class Stream {
  1658. public:
  1659. virtual ~Stream() = default;
  1660. virtual bool is_readable() const = 0;
  1661. virtual bool wait_readable() const = 0;
  1662. virtual bool wait_writable() const = 0;
  1663. virtual bool is_peer_alive() const { return wait_writable(); }
  1664. virtual ssize_t read(char *ptr, size_t size) = 0;
  1665. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1666. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1667. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1668. virtual socket_t socket() const = 0;
  1669. virtual time_t duration() const = 0;
  1670. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1671. (void)sec;
  1672. (void)usec;
  1673. }
  1674. // Bytes already pulled off the socket and sitting in this stream's own
  1675. // buffer. Exposing them lets a line reader scan for a terminator in one
  1676. // pass instead of asking for a byte at a time. A stream that does no
  1677. // buffering of its own reports none, and readers fall back to read().
  1678. virtual const char *buffered_data(size_t &size) const {
  1679. size = 0;
  1680. return nullptr;
  1681. }
  1682. // Discards `size` bytes previously returned by buffered_data().
  1683. virtual void consume_buffered(size_t size) { (void)size; }
  1684. ssize_t write(const char *ptr);
  1685. ssize_t write(const std::string &s);
  1686. Error get_error() const { return error_; }
  1687. protected:
  1688. Error error_ = Error::Success;
  1689. };
  1690. class TaskQueue {
  1691. public:
  1692. TaskQueue() = default;
  1693. virtual ~TaskQueue() = default;
  1694. virtual bool enqueue(std::function<void()> fn) = 0;
  1695. virtual void shutdown() = 0;
  1696. virtual void on_idle() {}
  1697. };
  1698. class ThreadPool final : public TaskQueue {
  1699. public:
  1700. explicit ThreadPool(
  1701. size_t n, size_t max_n = 0, size_t mqr = 0,
  1702. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1703. ThreadPool(const ThreadPool &) = delete;
  1704. ~ThreadPool() override = default;
  1705. bool enqueue(std::function<void()> fn) override;
  1706. void shutdown() override;
  1707. private:
  1708. void worker(bool is_dynamic);
  1709. void move_to_finished(std::thread::id id);
  1710. void cleanup_finished_threads();
  1711. size_t base_thread_count_;
  1712. size_t max_thread_count_;
  1713. size_t max_queued_requests_;
  1714. time_t idle_timeout_sec_;
  1715. size_t idle_thread_count_;
  1716. bool shutdown_;
  1717. std::list<std::function<void()>> jobs_;
  1718. std::vector<std::thread> threads_; // base threads
  1719. std::list<std::thread> dynamic_threads_; // dynamic threads
  1720. std::vector<std::thread>
  1721. finished_threads_; // exited dynamic threads awaiting join
  1722. std::condition_variable cond_;
  1723. std::mutex mutex_;
  1724. };
  1725. using Logger = std::function<void(const Request &, const Response &)>;
  1726. // Forward declaration for Error type
  1727. enum class Error;
  1728. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1729. using SocketOptions = std::function<void(socket_t sock)>;
  1730. void default_socket_options(socket_t sock);
  1731. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1732. const char *status_message(int status);
  1733. std::string to_string(Error error);
  1734. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1735. std::string get_bearer_token_auth(const Request &req);
  1736. namespace detail {
  1737. class MatcherBase {
  1738. public:
  1739. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1740. virtual ~MatcherBase() = default;
  1741. const std::string &pattern() const { return pattern_; }
  1742. // Match request path and populate its matches and
  1743. virtual bool match(Request &request) const = 0;
  1744. private:
  1745. std::string pattern_;
  1746. };
  1747. /**
  1748. * Captures parameters in request path and stores them in Request::path_params
  1749. *
  1750. * Capture name is a substring of a pattern from : to /.
  1751. * The rest of the pattern is matched against the request path directly
  1752. * Parameters are captured starting from the next character after
  1753. * the end of the last matched static pattern fragment until the next /.
  1754. *
  1755. * Example pattern:
  1756. * "/path/fragments/:capture/more/fragments/:second_capture"
  1757. * Static fragments:
  1758. * "/path/fragments/", "more/fragments/"
  1759. *
  1760. * Given the following request path:
  1761. * "/path/fragments/:1/more/fragments/:2"
  1762. * the resulting capture will be
  1763. * {{"capture", "1"}, {"second_capture", "2"}}
  1764. */
  1765. class PathParamsMatcher final : public MatcherBase {
  1766. public:
  1767. PathParamsMatcher(const std::string &pattern);
  1768. bool match(Request &request) const override;
  1769. private:
  1770. // Treat segment separators as the end of path parameter capture
  1771. // Does not need to handle query parameters as they are parsed before path
  1772. // matching
  1773. static constexpr char separator = '/';
  1774. // Contains static path fragments to match against, excluding the '/' after
  1775. // path params
  1776. // Fragments are separated by path params
  1777. std::vector<std::string> static_fragments_;
  1778. // Stores the names of the path parameters to be used as keys in the
  1779. // Request::path_params map
  1780. std::vector<std::string> param_names_;
  1781. };
  1782. /**
  1783. * Performs std::regex_match on request path
  1784. * and stores the result in Request::matches
  1785. *
  1786. * Note that regex match is performed directly on the whole request.
  1787. * This means that wildcard patterns may match multiple path segments with /:
  1788. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1789. */
  1790. class RegexMatcher final : public MatcherBase {
  1791. public:
  1792. RegexMatcher(const std::string &pattern)
  1793. : MatcherBase(pattern), regex_(pattern) {}
  1794. bool match(Request &request) const override;
  1795. private:
  1796. std::regex regex_;
  1797. };
  1798. int close_socket(socket_t sock) noexcept;
  1799. bool is_accept_resource_error();
  1800. bool is_accept_transient_error();
  1801. ssize_t write_headers(Stream &strm, const Headers &headers);
  1802. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1803. time_t usec);
  1804. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1805. const std::string &boundary);
  1806. ContentProvider
  1807. make_multipart_content_provider(const UploadFormDataItems &items,
  1808. const std::string &boundary);
  1809. } // namespace detail
  1810. bool is_valid_multipart_boundary(const std::string &boundary);
  1811. // Serializer for multipart/form-data request bodies. The boundary is owned
  1812. // by the writer so that per-part framing and the final terminator always
  1813. // agree. Field names and filenames are escaped following the WHATWG HTML
  1814. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1815. // in content types.
  1816. class MultipartFormDataWriter {
  1817. public:
  1818. MultipartFormDataWriter();
  1819. // precondition: is_valid_multipart_boundary(boundary)
  1820. explicit MultipartFormDataWriter(std::string boundary);
  1821. const std::string &boundary() const;
  1822. std::string content_type() const;
  1823. // In-memory items -> whole body (known length)
  1824. std::string serialize(const UploadFormDataItems &items) const;
  1825. size_t content_length(const UploadFormDataItems &items) const;
  1826. // Per-part framing for streaming via a content provider
  1827. std::string item_begin(const UploadFormData &item) const;
  1828. static std::string item_end();
  1829. std::string finish() const;
  1830. private:
  1831. std::string boundary_;
  1832. };
  1833. class Server {
  1834. public:
  1835. using Handler = std::function<void(const Request &, Response &)>;
  1836. using ExceptionHandler =
  1837. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1838. enum class HandlerResponse {
  1839. Handled,
  1840. Unhandled,
  1841. };
  1842. using HandlerWithResponse =
  1843. std::function<HandlerResponse(const Request &, Response &)>;
  1844. using HandlerWithContentReader = std::function<void(
  1845. const Request &, Response &, const ContentReader &content_reader)>;
  1846. using Expect100ContinueHandler =
  1847. std::function<int(const Request &, Response &)>;
  1848. using StartHandler = std::function<void()>;
  1849. using WebSocketHandler =
  1850. std::function<void(const Request &, ws::WebSocket &)>;
  1851. using SubProtocolSelector =
  1852. std::function<std::string(const std::vector<std::string> &protocols)>;
  1853. Server();
  1854. virtual ~Server();
  1855. virtual bool is_valid() const;
  1856. Server &Get(const std::string &pattern, Handler handler);
  1857. Server &Post(const std::string &pattern, Handler handler);
  1858. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1859. Server &Put(const std::string &pattern, Handler handler);
  1860. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1861. Server &Patch(const std::string &pattern, Handler handler);
  1862. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1863. Server &Delete(const std::string &pattern, Handler handler);
  1864. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1865. Server &Options(const std::string &pattern, Handler handler);
  1866. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1867. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1868. // server accept it; an unregistered method is still rejected with 400.
  1869. // `method` must be a valid HTTP method token and must not be one of the
  1870. // built-in methods, which have their own registration functions above. A
  1871. // rejected registration makes is_valid() return false, so listen() fails.
  1872. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1873. Handler handler);
  1874. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1875. HandlerWithContentReader handler);
  1876. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1877. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1878. SubProtocolSelector sub_protocol_selector);
  1879. bool set_base_dir(const std::string &dir,
  1880. const std::string &mount_point = std::string());
  1881. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1882. Headers headers = Headers());
  1883. bool remove_mount_point(const std::string &mount_point);
  1884. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1885. const std::string &mime);
  1886. Server &set_default_file_mimetype(const std::string &mime);
  1887. Server &set_file_request_handler(Handler handler);
  1888. template <class ErrorHandlerFunc>
  1889. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1890. return set_error_handler_core(
  1891. std::forward<ErrorHandlerFunc>(handler),
  1892. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1893. }
  1894. Server &set_exception_handler(ExceptionHandler handler);
  1895. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1896. Server &set_post_routing_handler(Handler handler);
  1897. Server &set_pre_request_handler(HandlerWithResponse handler);
  1898. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1899. Server &set_start_handler(StartHandler handler);
  1900. Server &set_logger(Logger logger);
  1901. Server &set_pre_compression_logger(Logger logger);
  1902. Server &set_error_logger(ErrorLogger error_logger);
  1903. Server &set_address_family(int family);
  1904. Server &set_tcp_nodelay(bool on);
  1905. Server &set_ipv6_v6only(bool on);
  1906. Server &set_socket_options(SocketOptions socket_options);
  1907. Server &set_default_headers(Headers headers);
  1908. Server &
  1909. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1910. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1911. Server &set_keep_alive_max_count(size_t count);
  1912. Server &set_keep_alive_timeout(time_t sec);
  1913. template <class Rep, class Period>
  1914. Server &
  1915. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1916. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1917. template <class Rep, class Period>
  1918. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1919. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1920. template <class Rep, class Period>
  1921. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1922. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1923. template <class Rep, class Period>
  1924. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1925. Server &set_payload_max_length(size_t length);
  1926. Server &set_static_file_compression(bool on);
  1927. Server &set_static_file_compression_min_length(size_t length);
  1928. Server &set_static_file_compression_max_length(size_t length);
  1929. Server &set_websocket_ping_interval(time_t sec);
  1930. template <class Rep, class Period>
  1931. Server &set_websocket_ping_interval(
  1932. const std::chrono::duration<Rep, Period> &duration);
  1933. Server &set_websocket_max_missed_pongs(int count);
  1934. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1935. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1936. bool listen_after_bind();
  1937. bool listen(const std::string &host, int port, int socket_flags = 0);
  1938. bool is_running() const;
  1939. void wait_until_ready() const;
  1940. void stop() noexcept;
  1941. void decommission();
  1942. std::function<TaskQueue *(void)> new_task_queue;
  1943. protected:
  1944. bool process_request(Stream &strm, const std::string &remote_addr,
  1945. int remote_port, const std::string &local_addr,
  1946. int local_port, bool close_connection,
  1947. bool &connection_closed,
  1948. const std::function<void(Request &)> &setup_request,
  1949. bool *websocket_upgraded = nullptr);
  1950. // Runs the per-connection serving loop and stops an exception thrown by a
  1951. // user callback from escaping the worker thread.
  1952. //
  1953. // process_request() wraps only routing() in a try/catch. Content providers,
  1954. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1955. // handlers all run outside it, and the task queue calls the job without a
  1956. // catch, so an exception from any of those would terminate the process.
  1957. //
  1958. // No 500 is possible here: by the time a content provider runs, the status
  1959. // line and headers are already on the wire. Report it through the error
  1960. // logger and drop the connection, which is what the peer observes either
  1961. // way. Other connections are unaffected.
  1962. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1963. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1964. return serve();
  1965. #else
  1966. try {
  1967. return serve();
  1968. } catch (...) {
  1969. // The error logger is a user callback too, so it must not be able to
  1970. // throw the guard back open.
  1971. try {
  1972. output_error_log(Error::UserCallbackException, nullptr);
  1973. } catch (...) {}
  1974. return false;
  1975. }
  1976. #endif
  1977. }
  1978. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1979. std::vector<std::string> trusted_proxies_;
  1980. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1981. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1982. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1983. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1984. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1985. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1986. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1987. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1988. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1989. bool static_file_compression_ = false;
  1990. size_t static_file_compression_min_length_ =
  1991. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1992. size_t static_file_compression_max_length_ =
  1993. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1994. time_t websocket_ping_interval_sec_ =
  1995. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1996. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1997. private:
  1998. using Handlers =
  1999. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2000. using HandlersForContentReader =
  2001. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2002. HandlerWithContentReader>>;
  2003. // Both handler tables for one custom method live in a single entry, so that
  2004. // routing() needs only one map lookup per request to reach either of them.
  2005. struct CustomHandlerEntry {
  2006. Handlers handlers;
  2007. HandlersForContentReader handlers_for_content_reader;
  2008. };
  2009. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2010. static std::unique_ptr<detail::MatcherBase>
  2011. make_matcher(const std::string &pattern);
  2012. static const std::set<std::string> &builtin_methods();
  2013. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2014. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2015. template <typename H>
  2016. Server &add_handler(
  2017. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2018. const std::string &pattern, H handler) {
  2019. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2020. return *this;
  2021. }
  2022. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2023. Server &set_error_handler_core(Handler handler, std::false_type);
  2024. socket_t create_server_socket(const std::string &host, int port,
  2025. int socket_flags,
  2026. SocketOptions socket_options) const;
  2027. int bind_internal(const std::string &host, int port, int socket_flags);
  2028. bool listen_internal();
  2029. bool routing(Request &req, Response &res, Stream &strm);
  2030. bool handle_file_request(Request &req, Response &res);
  2031. bool check_if_not_modified(const Request &req, Response &res,
  2032. const std::string &etag, time_t mtime) const;
  2033. bool check_if_range(Request &req, const std::string &etag,
  2034. time_t mtime) const;
  2035. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2036. Stream &strm);
  2037. bool dispatch_request_for_content_reader(
  2038. Request &req, Response &res, ContentReader content_reader,
  2039. const HandlersForContentReader &handlers) const;
  2040. bool parse_request_line(const char *s, Request &req) const;
  2041. detail::EncodingType static_file_encoding(const Request &req,
  2042. const Response &res,
  2043. const std::string &content_type,
  2044. size_t length) const;
  2045. bool apply_static_file_compression(const Request &req, Response &res) const;
  2046. void apply_ranges(const Request &req, Response &res,
  2047. std::string &content_type, std::string &boundary) const;
  2048. bool write_response(Stream &strm, bool close_connection, Request &req,
  2049. Response &res);
  2050. bool write_response_with_content(Stream &strm, bool close_connection,
  2051. const Request &req, Response &res);
  2052. bool write_response_core(Stream &strm, bool close_connection,
  2053. const Request &req, Response &res,
  2054. bool need_apply_ranges);
  2055. bool write_content_with_provider(Stream &strm, const Request &req,
  2056. Response &res, const std::string &boundary,
  2057. const std::string &content_type);
  2058. bool read_content(Stream &strm, Request &req, Response &res);
  2059. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2060. Response &res,
  2061. ContentReceiver receiver,
  2062. FormDataHeader multipart_header,
  2063. ContentReceiver multipart_receiver);
  2064. bool read_content_core(Stream &strm, Request &req, Response &res,
  2065. ContentReceiver receiver,
  2066. FormDataHeader multipart_header,
  2067. ContentReceiver multipart_receiver) const;
  2068. virtual bool process_and_close_socket(socket_t sock);
  2069. void output_log(const Request &req, const Response &res) const;
  2070. void output_pre_compression_log(const Request &req,
  2071. const Response &res) const;
  2072. void output_error_log(const Error &err, const Request *req) const;
  2073. std::atomic<bool> is_running_{false};
  2074. std::atomic<bool> is_decommissioned{false};
  2075. // Set when CustomRoute() refuses a registration. Written before listen(),
  2076. // read by is_valid() on the same thread, so it needs no synchronization.
  2077. bool has_invalid_registration_ = false;
  2078. struct MountPointEntry {
  2079. std::string mount_point;
  2080. std::string base_dir;
  2081. std::string resolved_base_dir;
  2082. Headers headers;
  2083. };
  2084. std::vector<MountPointEntry> base_dirs_;
  2085. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2086. std::string default_file_mimetype_ = "application/octet-stream";
  2087. Handler file_request_handler_;
  2088. Handlers get_handlers_;
  2089. Handlers post_handlers_;
  2090. HandlersForContentReader post_handlers_for_content_reader_;
  2091. Handlers put_handlers_;
  2092. HandlersForContentReader put_handlers_for_content_reader_;
  2093. Handlers patch_handlers_;
  2094. HandlersForContentReader patch_handlers_for_content_reader_;
  2095. Handlers delete_handlers_;
  2096. HandlersForContentReader delete_handlers_for_content_reader_;
  2097. Handlers options_handlers_;
  2098. CustomHandlers custom_handlers_;
  2099. struct WebSocketHandlerEntry {
  2100. std::unique_ptr<detail::MatcherBase> matcher;
  2101. WebSocketHandler handler;
  2102. SubProtocolSelector sub_protocol_selector;
  2103. };
  2104. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2105. WebSocketHandlers websocket_handlers_;
  2106. HandlerWithResponse error_handler_;
  2107. ExceptionHandler exception_handler_;
  2108. HandlerWithResponse pre_routing_handler_;
  2109. Handler post_routing_handler_;
  2110. HandlerWithResponse pre_request_handler_;
  2111. Expect100ContinueHandler expect_100_continue_handler_;
  2112. StartHandler start_handler_;
  2113. mutable std::mutex logger_mutex_;
  2114. Logger logger_;
  2115. Logger pre_compression_logger_;
  2116. ErrorLogger error_logger_;
  2117. int address_family_ = AF_UNSPEC;
  2118. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2119. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2120. SocketOptions socket_options_ = default_socket_options;
  2121. Headers default_headers_;
  2122. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2123. detail::write_headers;
  2124. };
  2125. class Result {
  2126. public:
  2127. Result() = default;
  2128. Result(std::unique_ptr<Response> &&res, Error err,
  2129. Headers &&request_headers = Headers{})
  2130. : res_(std::move(res)), err_(err),
  2131. request_headers_(std::move(request_headers)) {}
  2132. // Response
  2133. operator bool() const { return res_ != nullptr; }
  2134. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2135. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2136. const Response &value() const { return *res_; }
  2137. Response &value() { return *res_; }
  2138. const Response &operator*() const { return *res_; }
  2139. Response &operator*() { return *res_; }
  2140. const Response *operator->() const { return res_.get(); }
  2141. Response *operator->() { return res_.get(); }
  2142. // Error
  2143. Error error() const { return err_; }
  2144. // Request Headers
  2145. bool has_request_header(const std::string &key) const;
  2146. std::string get_request_header_value(const std::string &key,
  2147. const char *def = "",
  2148. size_t id = 0) const;
  2149. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2150. size_t id = 0) const;
  2151. size_t get_request_header_value_count(const std::string &key) const;
  2152. private:
  2153. std::unique_ptr<Response> res_;
  2154. Error err_ = Error::Unknown;
  2155. Headers request_headers_;
  2156. #ifdef CPPHTTPLIB_SSL_ENABLED
  2157. public:
  2158. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2159. int ssl_error)
  2160. : res_(std::move(res)), err_(err),
  2161. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2162. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2163. int ssl_error, uint64_t ssl_backend_error)
  2164. : res_(std::move(res)), err_(err),
  2165. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2166. ssl_backend_error_(ssl_backend_error) {}
  2167. int ssl_error() const { return ssl_error_; }
  2168. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2169. private:
  2170. int ssl_error_ = 0;
  2171. uint64_t ssl_backend_error_ = 0;
  2172. #endif
  2173. };
  2174. struct ClientConnection {
  2175. socket_t sock = INVALID_SOCKET;
  2176. bool is_open() const { return sock != INVALID_SOCKET; }
  2177. ClientConnection() = default;
  2178. ~ClientConnection();
  2179. ClientConnection(const ClientConnection &) = delete;
  2180. ClientConnection &operator=(const ClientConnection &) = delete;
  2181. ClientConnection(ClientConnection &&other) noexcept
  2182. : sock(other.sock)
  2183. #ifdef CPPHTTPLIB_SSL_ENABLED
  2184. ,
  2185. session(other.session)
  2186. #endif
  2187. {
  2188. other.sock = INVALID_SOCKET;
  2189. #ifdef CPPHTTPLIB_SSL_ENABLED
  2190. other.session = nullptr;
  2191. #endif
  2192. }
  2193. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2194. if (this != &other) {
  2195. sock = other.sock;
  2196. other.sock = INVALID_SOCKET;
  2197. #ifdef CPPHTTPLIB_SSL_ENABLED
  2198. session = other.session;
  2199. other.session = nullptr;
  2200. #endif
  2201. }
  2202. return *this;
  2203. }
  2204. #ifdef CPPHTTPLIB_SSL_ENABLED
  2205. tls::session_t session = nullptr;
  2206. #endif
  2207. };
  2208. namespace detail {
  2209. struct ChunkedDecoder;
  2210. struct BodyReader {
  2211. Stream *stream = nullptr;
  2212. bool has_content_length = false;
  2213. size_t content_length = 0;
  2214. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2215. size_t bytes_read = 0;
  2216. bool chunked = false;
  2217. bool eof = false;
  2218. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2219. Error last_error = Error::Success;
  2220. ssize_t read(char *buf, size_t len);
  2221. bool has_error() const { return last_error != Error::Success; }
  2222. };
  2223. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2224. size_t len) {
  2225. (void)stream;
  2226. return br.read(buf, len);
  2227. }
  2228. class decompressor;
  2229. enum class NoProxyKind {
  2230. Wildcard, // "*"
  2231. HostnameSuffix, // "example.com" or ".example.com"
  2232. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2233. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2234. };
  2235. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2236. // Lets one CIDR matcher cover both families.
  2237. using IPBytes = std::array<uint8_t, 16>;
  2238. struct NoProxyEntry {
  2239. NoProxyKind kind = NoProxyKind::Wildcard;
  2240. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2241. IPBytes net{};
  2242. int prefix_bits = 0;
  2243. };
  2244. struct NormalizedTarget {
  2245. std::string hostname; // lowercase; brackets and trailing dot removed
  2246. bool is_ipv4 = false;
  2247. bool is_ipv6 = false;
  2248. IPBytes ip{};
  2249. };
  2250. } // namespace detail
  2251. class ClientImpl {
  2252. public:
  2253. explicit ClientImpl(const std::string &host);
  2254. explicit ClientImpl(const std::string &host, int port);
  2255. explicit ClientImpl(const std::string &host, int port,
  2256. const std::string &client_cert_path,
  2257. const std::string &client_key_path);
  2258. virtual ~ClientImpl();
  2259. virtual bool is_valid() const;
  2260. struct StreamHandle {
  2261. std::unique_ptr<Response> response;
  2262. Error error = Error::Success;
  2263. StreamHandle() = default;
  2264. StreamHandle(const StreamHandle &) = delete;
  2265. StreamHandle &operator=(const StreamHandle &) = delete;
  2266. StreamHandle(StreamHandle &&) = default;
  2267. StreamHandle &operator=(StreamHandle &&) = default;
  2268. ~StreamHandle() = default;
  2269. bool is_valid() const {
  2270. return response != nullptr && error == Error::Success;
  2271. }
  2272. ssize_t read(char *buf, size_t len);
  2273. void parse_trailers_if_needed();
  2274. Error get_read_error() const { return body_reader_.last_error; }
  2275. bool has_read_error() const { return body_reader_.has_error(); }
  2276. bool trailers_parsed_ = false;
  2277. private:
  2278. friend class ClientImpl;
  2279. ssize_t read_with_decompression(char *buf, size_t len);
  2280. std::unique_ptr<ClientConnection> connection_;
  2281. std::unique_ptr<Stream> socket_stream_;
  2282. Stream *stream_ = nullptr;
  2283. detail::BodyReader body_reader_;
  2284. std::unique_ptr<detail::decompressor> decompressor_;
  2285. std::string decompress_buffer_;
  2286. size_t decompress_offset_ = 0;
  2287. size_t decompressed_bytes_read_ = 0;
  2288. };
  2289. // clang-format off
  2290. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2291. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2292. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2293. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2294. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2295. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2296. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2297. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2298. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2299. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2300. Result Head(const std::string &path);
  2301. Result Head(const std::string &path, const Headers &headers);
  2302. Result Post(const std::string &path);
  2303. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2304. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2305. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2306. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2307. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2308. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2309. Result Post(const std::string &path, const Params &params);
  2310. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2311. Result Post(const std::string &path, const Headers &headers);
  2312. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2313. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2314. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2315. 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);
  2316. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2317. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2318. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2319. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2320. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2321. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2322. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2323. Result Put(const std::string &path);
  2324. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2325. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2326. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2327. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2328. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2329. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2330. Result Put(const std::string &path, const Params &params);
  2331. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2332. Result Put(const std::string &path, const Headers &headers);
  2333. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2334. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2335. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2336. 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);
  2337. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2338. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2339. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2340. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2341. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2342. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2343. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2344. Result Patch(const std::string &path);
  2345. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2346. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2347. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2348. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2349. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2350. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2351. Result Patch(const std::string &path, const Params &params);
  2352. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2353. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2354. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2355. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2356. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2357. 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);
  2358. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2359. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2360. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2361. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2362. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2363. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2364. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2365. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2366. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2367. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2368. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2369. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2370. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2371. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2372. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2373. Result Options(const std::string &path);
  2374. Result Options(const std::string &path, const Headers &headers);
  2375. // clang-format on
  2376. // Streaming API: Open a stream for reading response body incrementally
  2377. // Socket ownership is transferred to StreamHandle for true streaming
  2378. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2379. StreamHandle open_stream(const std::string &method, const std::string &path,
  2380. const Params &params = {},
  2381. const Headers &headers = {},
  2382. const std::string &body = {},
  2383. const std::string &content_type = {});
  2384. bool send(Request &req, Response &res, Error &error);
  2385. Result send(const Request &req);
  2386. void stop();
  2387. std::string host() const;
  2388. int port() const;
  2389. size_t is_socket_open() const;
  2390. socket_t socket() const;
  2391. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2392. void set_default_headers(Headers headers);
  2393. void
  2394. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2395. void set_address_family(int family);
  2396. void set_tcp_nodelay(bool on);
  2397. void set_ipv6_v6only(bool on);
  2398. void set_socket_options(SocketOptions socket_options);
  2399. void set_connection_timeout(time_t sec, time_t usec = 0);
  2400. template <class Rep, class Period>
  2401. void
  2402. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2403. void set_read_timeout(time_t sec, time_t usec = 0);
  2404. template <class Rep, class Period>
  2405. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2406. void set_write_timeout(time_t sec, time_t usec = 0);
  2407. template <class Rep, class Period>
  2408. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2409. void set_max_timeout(time_t msec);
  2410. template <class Rep, class Period>
  2411. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2412. void set_basic_auth(const std::string &username, const std::string &password);
  2413. void set_bearer_token_auth(const std::string &token);
  2414. void set_keep_alive(bool on);
  2415. void set_follow_location(bool on);
  2416. void set_path_encode(bool on);
  2417. void set_compress(bool on);
  2418. void set_decompress(bool on);
  2419. void set_payload_max_length(size_t length);
  2420. void set_interface(const std::string &intf);
  2421. void set_proxy(const std::string &host, int port);
  2422. void set_proxy_basic_auth(const std::string &username,
  2423. const std::string &password);
  2424. void set_proxy_bearer_token_auth(const std::string &token);
  2425. void set_no_proxy(const std::vector<std::string> &patterns);
  2426. void set_logger(Logger logger);
  2427. void set_error_logger(ErrorLogger error_logger);
  2428. protected:
  2429. struct Socket {
  2430. socket_t sock = INVALID_SOCKET;
  2431. // For Mbed TLS compatibility: start_time for request timeout tracking
  2432. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2433. bool is_open() const { return sock != INVALID_SOCKET; }
  2434. #ifdef CPPHTTPLIB_SSL_ENABLED
  2435. tls::session_t ssl = nullptr;
  2436. #endif
  2437. };
  2438. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2439. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2440. virtual bool setup_proxy_connection(
  2441. Socket &socket,
  2442. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2443. Response &res, bool &success, Error &error);
  2444. bool is_proxy_enabled_for_host(const std::string &host) const;
  2445. // All of:
  2446. // shutdown_ssl
  2447. // shutdown_socket
  2448. // close_socket
  2449. // disconnect
  2450. // should ONLY be called when socket_mutex_ is locked, and only when
  2451. // no other thread is using the socket.
  2452. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2453. void shutdown_socket(Socket &socket) const;
  2454. void close_socket(Socket &socket);
  2455. void disconnect(bool gracefully);
  2456. bool process_request(Stream &strm, Request &req, Response &res,
  2457. bool close_connection, Error &error);
  2458. bool write_content_with_provider(Stream &strm, const Request &req,
  2459. Error &error) const;
  2460. void output_log(const Request &req, const Response &res) const;
  2461. void output_error_log(const Error &err, const Request *req) const;
  2462. // Socket endpoint information
  2463. const std::string host_;
  2464. const int port_;
  2465. // Current open socket
  2466. Socket socket_;
  2467. mutable std::mutex socket_mutex_;
  2468. std::recursive_mutex request_mutex_;
  2469. // These are all protected under socket_mutex
  2470. size_t socket_requests_in_flight_ = 0;
  2471. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2472. bool socket_should_be_closed_when_request_is_done_ = false;
  2473. // Hostname to connection target map. The value is an IP literal or another
  2474. // hostname; only the connection target changes, never the identity.
  2475. std::map<std::string, std::string> addr_map_;
  2476. // Default headers
  2477. Headers default_headers_;
  2478. // Header writer
  2479. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2480. detail::write_headers;
  2481. // Settings
  2482. std::string client_cert_path_;
  2483. std::string client_key_path_;
  2484. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2485. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2486. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2487. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2488. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2489. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2490. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2491. std::string basic_auth_username_;
  2492. std::string basic_auth_password_;
  2493. std::string bearer_token_auth_token_;
  2494. bool keep_alive_ = false;
  2495. bool follow_location_ = false;
  2496. bool path_encode_ = true;
  2497. int address_family_ = AF_UNSPEC;
  2498. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2499. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2500. SocketOptions socket_options_ = nullptr;
  2501. bool compress_ = false;
  2502. bool decompress_ = true;
  2503. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2504. bool has_payload_max_length_ = false;
  2505. std::string interface_;
  2506. std::string proxy_host_;
  2507. int proxy_port_ = -1;
  2508. std::string proxy_basic_auth_username_;
  2509. std::string proxy_basic_auth_password_;
  2510. std::string proxy_bearer_token_auth_token_;
  2511. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2512. mutable detail::NormalizedTarget host_normalized_;
  2513. mutable bool host_normalized_valid_ = false;
  2514. mutable std::mutex logger_mutex_;
  2515. Logger logger_;
  2516. ErrorLogger error_logger_;
  2517. private:
  2518. bool send_(Request &req, Response &res, Error &error);
  2519. Result send_(Request &&req);
  2520. socket_t create_client_socket(Error &error) const;
  2521. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2522. bool skip_100_continue = true) const;
  2523. bool write_request(Stream &strm, Request &req, bool close_connection,
  2524. Error &error, bool skip_body, bool &rejected_locally);
  2525. bool write_request_body(Stream &strm, Request &req, Error &error);
  2526. void prepare_default_headers(Request &r, bool for_stream,
  2527. const std::string &ct);
  2528. bool redirect(Request &req, Response &res, Error &error);
  2529. bool create_redirect_client(const std::string &scheme,
  2530. const std::string &host, int port, Request &req,
  2531. Response &res, const std::string &path,
  2532. const std::string &location, Error &error);
  2533. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2534. bool handle_request(Stream &strm, Request &req, Response &res,
  2535. bool close_connection, Error &error);
  2536. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2537. Request &req, const char *body, size_t content_length,
  2538. ContentProvider content_provider,
  2539. ContentProviderWithoutLength content_provider_without_length,
  2540. const std::string &content_type, ContentReceiver content_receiver,
  2541. Error &error);
  2542. Result send_with_content_provider_and_receiver(
  2543. const std::string &method, const std::string &path,
  2544. const Headers &headers, const char *body, size_t content_length,
  2545. ContentProvider content_provider,
  2546. ContentProviderWithoutLength content_provider_without_length,
  2547. const std::string &content_type, ContentReceiver content_receiver,
  2548. UploadProgress progress);
  2549. ContentProviderWithoutLength get_multipart_content_provider(
  2550. const std::string &boundary, const UploadFormDataItems &items,
  2551. const FormDataProviderItems &provider_items) const;
  2552. virtual bool
  2553. process_socket(const Socket &socket,
  2554. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2555. std::function<bool(Stream &strm)> callback);
  2556. virtual bool is_ssl() const;
  2557. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2558. #ifdef CPPHTTPLIB_SSL_ENABLED
  2559. public:
  2560. void set_digest_auth(const std::string &username,
  2561. const std::string &password);
  2562. void set_proxy_digest_auth(const std::string &username,
  2563. const std::string &password);
  2564. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2565. const std::string &ca_cert_dir_path = std::string());
  2566. void enable_server_certificate_verification(bool enabled);
  2567. void enable_server_hostname_verification(bool enabled);
  2568. void enable_system_ca(bool enabled);
  2569. protected:
  2570. std::string digest_auth_username_;
  2571. std::string digest_auth_password_;
  2572. std::string proxy_digest_auth_username_;
  2573. std::string proxy_digest_auth_password_;
  2574. std::string ca_cert_file_path_;
  2575. std::string ca_cert_dir_path_;
  2576. bool server_certificate_verification_ = true;
  2577. bool server_hostname_verification_ = true;
  2578. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2579. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2580. int last_ssl_error_ = 0;
  2581. uint64_t last_backend_error_ = 0;
  2582. #endif
  2583. };
  2584. namespace detail {
  2585. // Stands in for a client that Client could not make from its arguments, so a
  2586. // request fails rather than going through a null pointer.
  2587. class InvalidClientImpl final : public ClientImpl {
  2588. public:
  2589. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2590. bool is_valid() const override { return false; }
  2591. private:
  2592. bool create_and_connect_socket(Socket &, Error &error) override {
  2593. error = Error::Connection;
  2594. return false;
  2595. }
  2596. };
  2597. } // namespace detail
  2598. class Client {
  2599. public:
  2600. // Universal interface
  2601. explicit Client(const std::string &scheme_host_port);
  2602. explicit Client(const std::string &scheme_host_port,
  2603. const std::string &client_cert_path,
  2604. const std::string &client_key_path);
  2605. // HTTP only interface
  2606. explicit Client(const std::string &host, int port);
  2607. explicit Client(const std::string &host, int port,
  2608. const std::string &client_cert_path,
  2609. const std::string &client_key_path);
  2610. Client(Client &&) = default;
  2611. Client &operator=(Client &&) = default;
  2612. ~Client();
  2613. bool is_valid() const;
  2614. // clang-format off
  2615. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2616. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2617. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2618. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2619. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2620. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2621. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2622. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2623. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2624. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2625. Result Head(const std::string &path);
  2626. Result Head(const std::string &path, const Headers &headers);
  2627. Result Post(const std::string &path);
  2628. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2629. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2630. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2631. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2632. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2633. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2634. Result Post(const std::string &path, const Params &params);
  2635. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2636. Result Post(const std::string &path, const Headers &headers);
  2637. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2638. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2639. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2640. 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);
  2641. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2642. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2643. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2644. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2645. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2646. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2647. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2648. Result Put(const std::string &path);
  2649. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2650. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2651. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2652. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2653. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2654. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2655. Result Put(const std::string &path, const Params &params);
  2656. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2657. Result Put(const std::string &path, const Headers &headers);
  2658. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2659. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2660. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2661. 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);
  2662. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2663. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2664. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2665. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2666. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2667. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2668. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2669. Result Patch(const std::string &path);
  2670. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2671. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2672. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2673. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2674. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2675. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2676. Result Patch(const std::string &path, const Params &params);
  2677. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2678. Result Patch(const std::string &path, const Headers &headers);
  2679. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2680. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2681. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2682. 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);
  2683. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2684. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2685. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2686. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2687. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2688. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2689. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2690. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2691. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2692. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2693. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2694. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2695. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2696. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2697. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2698. Result Options(const std::string &path);
  2699. Result Options(const std::string &path, const Headers &headers);
  2700. // clang-format on
  2701. // Streaming API: Open a stream for reading response body incrementally
  2702. // Socket ownership is transferred to StreamHandle for true streaming
  2703. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2704. ClientImpl::StreamHandle open_stream(const std::string &method,
  2705. const std::string &path,
  2706. const Params &params = {},
  2707. const Headers &headers = {},
  2708. const std::string &body = {},
  2709. const std::string &content_type = {});
  2710. bool send(Request &req, Response &res, Error &error);
  2711. Result send(const Request &req);
  2712. void stop();
  2713. std::string host() const;
  2714. int port() const;
  2715. size_t is_socket_open() const;
  2716. socket_t socket() const;
  2717. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2718. void set_default_headers(Headers headers);
  2719. void
  2720. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2721. void set_address_family(int family);
  2722. void set_tcp_nodelay(bool on);
  2723. void set_socket_options(SocketOptions socket_options);
  2724. void set_connection_timeout(time_t sec, time_t usec = 0);
  2725. template <class Rep, class Period>
  2726. void
  2727. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2728. void set_read_timeout(time_t sec, time_t usec = 0);
  2729. template <class Rep, class Period>
  2730. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2731. void set_write_timeout(time_t sec, time_t usec = 0);
  2732. template <class Rep, class Period>
  2733. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2734. void set_max_timeout(time_t msec);
  2735. template <class Rep, class Period>
  2736. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2737. void set_basic_auth(const std::string &username, const std::string &password);
  2738. void set_bearer_token_auth(const std::string &token);
  2739. void set_keep_alive(bool on);
  2740. void set_follow_location(bool on);
  2741. void set_path_encode(bool on);
  2742. void set_compress(bool on);
  2743. void set_decompress(bool on);
  2744. void set_payload_max_length(size_t length);
  2745. void set_interface(const std::string &intf);
  2746. void set_proxy(const std::string &host, int port);
  2747. void set_proxy_basic_auth(const std::string &username,
  2748. const std::string &password);
  2749. void set_proxy_bearer_token_auth(const std::string &token);
  2750. void set_no_proxy(const std::vector<std::string> &patterns);
  2751. void set_logger(Logger logger);
  2752. void set_error_logger(ErrorLogger error_logger);
  2753. private:
  2754. std::unique_ptr<ClientImpl> cli_;
  2755. #ifdef CPPHTTPLIB_SSL_ENABLED
  2756. public:
  2757. void set_digest_auth(const std::string &username,
  2758. const std::string &password);
  2759. void set_proxy_digest_auth(const std::string &username,
  2760. const std::string &password);
  2761. void enable_server_certificate_verification(bool enabled);
  2762. void enable_server_hostname_verification(bool enabled);
  2763. void enable_system_ca(bool enabled);
  2764. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2765. const std::string &ca_cert_dir_path = std::string());
  2766. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2767. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2768. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2769. void set_session_verifier(
  2770. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2771. tls::ctx_t tls_context() const;
  2772. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2773. void enable_windows_certificate_verification(bool enabled);
  2774. #endif
  2775. private:
  2776. bool is_ssl_ = false;
  2777. #endif
  2778. };
  2779. #ifdef CPPHTTPLIB_SSL_ENABLED
  2780. class SSLServer : public Server {
  2781. public:
  2782. SSLServer(const char *cert_path, const char *private_key_path,
  2783. const char *client_ca_cert_file_path = nullptr,
  2784. const char *client_ca_cert_dir_path = nullptr,
  2785. const char *private_key_password = nullptr);
  2786. struct PemMemory {
  2787. const char *cert_pem;
  2788. size_t cert_pem_len;
  2789. const char *key_pem;
  2790. size_t key_pem_len;
  2791. const char *client_ca_pem;
  2792. size_t client_ca_pem_len;
  2793. const char *private_key_password;
  2794. };
  2795. explicit SSLServer(const PemMemory &pem);
  2796. // The callback receives the ctx_t handle which can be cast to the
  2797. // appropriate backend type (SSL_CTX* for OpenSSL,
  2798. // tls::impl::MbedTlsContext* for Mbed TLS)
  2799. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2800. ~SSLServer() override;
  2801. bool is_valid() const override;
  2802. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2803. const char *client_ca_pem = nullptr,
  2804. const char *password = nullptr);
  2805. tls::ctx_t tls_context() const { return ctx_; }
  2806. int ssl_last_error() const { return last_ssl_error_; }
  2807. private:
  2808. bool process_and_close_socket(socket_t sock) override;
  2809. tls::ctx_t ctx_ = nullptr;
  2810. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2811. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2812. // bounds, and new ones wait while it is pending so that they cannot keep it
  2813. // waiting.
  2814. std::mutex ctx_mutex_;
  2815. std::condition_variable ctx_cv_;
  2816. size_t handshakes_in_progress_ = 0;
  2817. size_t updates_pending_ = 0;
  2818. int last_ssl_error_ = 0;
  2819. };
  2820. class SSLClient final : public ClientImpl {
  2821. public:
  2822. explicit SSLClient(const std::string &host);
  2823. explicit SSLClient(const std::string &host, int port);
  2824. explicit SSLClient(const std::string &host, int port,
  2825. const std::string &client_cert_path,
  2826. const std::string &client_key_path,
  2827. const std::string &private_key_password = std::string());
  2828. struct PemMemory {
  2829. const char *cert_pem;
  2830. size_t cert_pem_len;
  2831. const char *key_pem;
  2832. size_t key_pem_len;
  2833. const char *private_key_password;
  2834. };
  2835. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2836. ~SSLClient() override;
  2837. bool is_valid() const override;
  2838. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2839. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2840. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2841. // Post-handshake session verifier (backend-independent)
  2842. void set_session_verifier(
  2843. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2844. tls::ctx_t tls_context() const { return ctx_; }
  2845. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2846. void enable_windows_certificate_verification(bool enabled);
  2847. #endif
  2848. private:
  2849. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2850. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2851. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2852. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2853. bool
  2854. process_socket(const Socket &socket,
  2855. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2856. std::function<bool(Stream &strm)> callback) override;
  2857. bool is_ssl() const override;
  2858. bool setup_proxy_connection(
  2859. Socket &socket,
  2860. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2861. Response &res, bool &success, Error &error) override;
  2862. bool connect_with_proxy(
  2863. Socket &sock,
  2864. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2865. Response &res, bool &success, Error &error);
  2866. bool initialize_ssl(Socket &socket, Error &error);
  2867. void init_ctx();
  2868. void reset_ctx_on_error();
  2869. bool load_certs();
  2870. tls::ctx_t ctx_ = nullptr;
  2871. std::mutex ctx_mutex_;
  2872. std::once_flag initialize_cert_;
  2873. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2874. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2875. // Used to keep custom CA configuration exclusive with system CA loading.
  2876. bool ca_cert_store_set_ = false;
  2877. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2878. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2879. // set_server_certificate_verifier() installed there.
  2880. tls::VerifyCallback server_certificate_verifier_;
  2881. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2882. bool enable_windows_cert_verification_ = true;
  2883. #endif
  2884. friend class ClientImpl;
  2885. };
  2886. #endif // CPPHTTPLIB_SSL_ENABLED
  2887. namespace detail {
  2888. template <typename T, typename U>
  2889. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2890. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2891. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2892. duration - std::chrono::seconds(sec))
  2893. .count();
  2894. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2895. }
  2896. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2897. return N - 1;
  2898. }
  2899. inline bool is_numeric(const std::string &str) {
  2900. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2901. }
  2902. // std::ranges::next(first, n, last) for C++11
  2903. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2904. for (; n > 0 && first != last; --n) {
  2905. ++first;
  2906. }
  2907. return first;
  2908. }
  2909. inline size_t get_header_value_u64(const Headers &headers,
  2910. const std::string &key, size_t def,
  2911. size_t id, bool &is_invalid_value) {
  2912. is_invalid_value = false;
  2913. auto rng = headers.equal_range(key);
  2914. auto it = bounded_next(rng.first, id, rng.second);
  2915. if (it != rng.second) {
  2916. if (is_numeric(it->second)) {
  2917. // Parse at size_t width so an out-of-range Content-Length is reported
  2918. // rather than silently saturated/truncated (a value above 2^32 would
  2919. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2920. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2921. size_t val = 0;
  2922. const auto &s = it->second;
  2923. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2924. if (r.ec == std::errc::result_out_of_range) {
  2925. is_invalid_value = true;
  2926. return (std::numeric_limits<size_t>::max)();
  2927. }
  2928. return val;
  2929. } else {
  2930. is_invalid_value = true;
  2931. }
  2932. }
  2933. return def;
  2934. }
  2935. inline size_t get_header_value_u64(const Headers &headers,
  2936. const std::string &key, size_t def,
  2937. size_t id) {
  2938. auto dummy = false;
  2939. return get_header_value_u64(headers, key, def, id, dummy);
  2940. }
  2941. } // namespace detail
  2942. template <class Rep, class Period>
  2943. inline Server &
  2944. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2945. detail::duration_to_sec_and_usec(
  2946. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2947. return *this;
  2948. }
  2949. template <class Rep, class Period>
  2950. inline Server &
  2951. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2952. detail::duration_to_sec_and_usec(
  2953. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2954. return *this;
  2955. }
  2956. template <class Rep, class Period>
  2957. inline Server &
  2958. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2959. detail::duration_to_sec_and_usec(
  2960. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2961. return *this;
  2962. }
  2963. template <class Rep, class Period>
  2964. inline void ClientImpl::set_connection_timeout(
  2965. const std::chrono::duration<Rep, Period> &duration) {
  2966. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2967. set_connection_timeout(sec, usec);
  2968. });
  2969. }
  2970. template <class Rep, class Period>
  2971. inline void ClientImpl::set_read_timeout(
  2972. const std::chrono::duration<Rep, Period> &duration) {
  2973. detail::duration_to_sec_and_usec(
  2974. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2975. }
  2976. template <class Rep, class Period>
  2977. inline void ClientImpl::set_write_timeout(
  2978. const std::chrono::duration<Rep, Period> &duration) {
  2979. detail::duration_to_sec_and_usec(
  2980. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2981. }
  2982. template <class Rep, class Period>
  2983. inline void ClientImpl::set_max_timeout(
  2984. const std::chrono::duration<Rep, Period> &duration) {
  2985. auto msec =
  2986. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2987. set_max_timeout(msec);
  2988. }
  2989. template <class Rep, class Period>
  2990. inline void Client::set_connection_timeout(
  2991. const std::chrono::duration<Rep, Period> &duration) {
  2992. cli_->set_connection_timeout(duration);
  2993. }
  2994. template <class Rep, class Period>
  2995. inline void
  2996. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2997. cli_->set_read_timeout(duration);
  2998. }
  2999. template <class Rep, class Period>
  3000. inline void
  3001. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3002. cli_->set_write_timeout(duration);
  3003. }
  3004. inline void Client::set_max_timeout(time_t msec) {
  3005. cli_->set_max_timeout(msec);
  3006. }
  3007. template <class Rep, class Period>
  3008. inline void
  3009. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3010. cli_->set_max_timeout(duration);
  3011. }
  3012. /*
  3013. * Forward declarations and types that will be part of the .h file if split into
  3014. * .h + .cc.
  3015. */
  3016. std::string hosted_at(const std::string &hostname);
  3017. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3018. // JavaScript-style URL encoding/decoding functions
  3019. std::string encode_uri_component(const std::string &value);
  3020. std::string encode_uri(const std::string &value);
  3021. std::string decode_uri_component(const std::string &value);
  3022. std::string decode_uri(const std::string &value);
  3023. // RFC 3986 compliant URL component encoding/decoding functions
  3024. std::string encode_path_component(const std::string &component);
  3025. std::string decode_path_component(const std::string &component);
  3026. std::string encode_query_component(const std::string &component,
  3027. bool space_as_plus = true);
  3028. std::string decode_query_component(const std::string &component,
  3029. bool plus_as_space = true);
  3030. std::string sanitize_filename(const std::string &filename);
  3031. std::string append_query_params(const std::string &path, const Params &params);
  3032. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3033. std::pair<std::string, std::string>
  3034. make_basic_authentication_header(const std::string &username,
  3035. const std::string &password,
  3036. bool is_proxy = false);
  3037. namespace detail {
  3038. #if defined(_WIN32)
  3039. inline std::wstring u8string_to_wstring(const char *s) {
  3040. if (!s) { return std::wstring(); }
  3041. auto len = static_cast<int>(strlen(s));
  3042. if (!len) { return std::wstring(); }
  3043. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3044. if (!wlen) { return std::wstring(); }
  3045. std::wstring ws;
  3046. ws.resize(wlen);
  3047. wlen = ::MultiByteToWideChar(
  3048. CP_UTF8, 0, s, len,
  3049. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3050. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3051. return ws;
  3052. }
  3053. #endif
  3054. struct FileStat {
  3055. FileStat(const std::string &path);
  3056. bool is_file() const;
  3057. bool is_dir() const;
  3058. time_t mtime() const;
  3059. size_t size() const;
  3060. private:
  3061. #if defined(_WIN32)
  3062. struct _stat st_;
  3063. #else
  3064. struct stat st_;
  3065. #endif
  3066. int ret_ = -1;
  3067. };
  3068. std::string make_host_and_port_string(const std::string &host, int port,
  3069. bool is_ssl);
  3070. template <typename T>
  3071. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3072. Error &error);
  3073. std::string trim_copy(const std::string &s);
  3074. void divide(
  3075. const char *data, std::size_t size, char d,
  3076. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3077. fn);
  3078. void divide(
  3079. const std::string &str, char d,
  3080. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3081. fn);
  3082. void split(const char *b, const char *e, char d,
  3083. std::function<void(const char *, const char *)> fn);
  3084. void split(const char *b, const char *e, char d, size_t m,
  3085. std::function<void(const char *, const char *)> fn);
  3086. bool split_find(const char *b, const char *e, char d,
  3087. std::function<bool(const char *, const char *)> fn);
  3088. bool has_header_token(const Headers &headers, const std::string &key,
  3089. const std::string &token);
  3090. std::string websocket_accept_key(const std::string &client_key);
  3091. bool is_websocket_upgrade(const Request &req);
  3092. bool process_client_socket(
  3093. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3094. time_t write_timeout_sec, time_t write_timeout_usec,
  3095. time_t max_timeout_msec,
  3096. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3097. std::function<bool(Stream &)> callback);
  3098. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3099. int port, int address_family, bool tcp_nodelay,
  3100. bool ipv6_v6only, SocketOptions socket_options,
  3101. time_t connection_timeout_sec,
  3102. time_t connection_timeout_usec,
  3103. time_t read_timeout_sec, time_t read_timeout_usec,
  3104. time_t write_timeout_sec,
  3105. time_t write_timeout_usec,
  3106. const std::string &intf, Error &error);
  3107. const char *get_header_value(const Headers &headers, const std::string &key,
  3108. const char *def, size_t id);
  3109. std::string get_combined_header_value(const Headers &headers,
  3110. const std::string &key);
  3111. std::string params_to_query_str(const Params &params);
  3112. void parse_query_text(const char *data, std::size_t size, Params &params);
  3113. void parse_query_text(const std::string &s, Params &params);
  3114. bool parse_multipart_boundary(const std::string &content_type,
  3115. std::string &boundary);
  3116. bool parse_range_header(const std::string &s, Ranges &ranges);
  3117. bool parse_accept_header(const std::string &s,
  3118. std::vector<std::string> &content_types);
  3119. void parse_disposition_params(const std::string &s, Params &params);
  3120. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3121. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3122. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3123. EncodingType encoding_type(const Request &req, const Response &res,
  3124. const std::string &content_type);
  3125. EncodingType encoding_type(const Request &req, const Response &res);
  3126. class BufferStream final : public Stream {
  3127. public:
  3128. BufferStream() = default;
  3129. ~BufferStream() override = default;
  3130. bool is_readable() const override;
  3131. bool wait_readable() const override;
  3132. bool wait_writable() const override;
  3133. ssize_t read(char *ptr, size_t size) override;
  3134. ssize_t write(const char *ptr, size_t size) override;
  3135. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3136. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3137. socket_t socket() const override;
  3138. time_t duration() const override;
  3139. const std::string &get_buffer() const;
  3140. private:
  3141. std::string buffer;
  3142. size_t position = 0;
  3143. };
  3144. class compressor {
  3145. public:
  3146. virtual ~compressor() = default;
  3147. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3148. virtual bool compress(const char *data, size_t data_length, bool last,
  3149. Callback callback) = 0;
  3150. };
  3151. class decompressor {
  3152. public:
  3153. virtual ~decompressor() = default;
  3154. virtual bool is_valid() const = 0;
  3155. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3156. virtual bool decompress(const char *data, size_t data_length,
  3157. Callback callback) = 0;
  3158. };
  3159. class nocompressor final : public compressor {
  3160. public:
  3161. ~nocompressor() override = default;
  3162. bool compress(const char *data, size_t data_length, bool /*last*/,
  3163. Callback callback) override;
  3164. };
  3165. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3166. class gzip_compressor final : public compressor {
  3167. public:
  3168. gzip_compressor();
  3169. ~gzip_compressor() override;
  3170. bool compress(const char *data, size_t data_length, bool last,
  3171. Callback callback) override;
  3172. private:
  3173. bool is_valid_ = false;
  3174. z_stream strm_;
  3175. };
  3176. class gzip_decompressor final : public decompressor {
  3177. public:
  3178. gzip_decompressor();
  3179. ~gzip_decompressor() override;
  3180. bool is_valid() const override;
  3181. bool decompress(const char *data, size_t data_length,
  3182. Callback callback) override;
  3183. private:
  3184. bool is_valid_ = false;
  3185. z_stream strm_;
  3186. };
  3187. #endif
  3188. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3189. class brotli_compressor final : public compressor {
  3190. public:
  3191. brotli_compressor();
  3192. ~brotli_compressor();
  3193. bool compress(const char *data, size_t data_length, bool last,
  3194. Callback callback) override;
  3195. private:
  3196. BrotliEncoderState *state_ = nullptr;
  3197. };
  3198. class brotli_decompressor final : public decompressor {
  3199. public:
  3200. brotli_decompressor();
  3201. ~brotli_decompressor();
  3202. bool is_valid() const override;
  3203. bool decompress(const char *data, size_t data_length,
  3204. Callback callback) override;
  3205. private:
  3206. BrotliDecoderResult decoder_r;
  3207. BrotliDecoderState *decoder_s = nullptr;
  3208. };
  3209. #endif
  3210. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3211. class zstd_compressor : public compressor {
  3212. public:
  3213. zstd_compressor();
  3214. ~zstd_compressor();
  3215. bool compress(const char *data, size_t data_length, bool last,
  3216. Callback callback) override;
  3217. private:
  3218. ZSTD_CCtx *ctx_ = nullptr;
  3219. };
  3220. class zstd_decompressor : public decompressor {
  3221. public:
  3222. zstd_decompressor();
  3223. ~zstd_decompressor();
  3224. bool is_valid() const override;
  3225. bool decompress(const char *data, size_t data_length,
  3226. Callback callback) override;
  3227. private:
  3228. ZSTD_DCtx *ctx_ = nullptr;
  3229. };
  3230. #endif
  3231. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3232. // to store data. The call can set memory on stack for performance.
  3233. class stream_line_reader {
  3234. public:
  3235. stream_line_reader(Stream &strm, char *fixed_buffer,
  3236. size_t fixed_buffer_size);
  3237. const char *ptr() const;
  3238. size_t size() const;
  3239. bool end_with_crlf() const;
  3240. bool getline();
  3241. private:
  3242. void append(char c);
  3243. void append(const char *data, size_t size);
  3244. Stream &strm_;
  3245. char *fixed_buffer_;
  3246. const size_t fixed_buffer_size_;
  3247. size_t fixed_buffer_used_size_ = 0;
  3248. std::string growable_buffer_;
  3249. };
  3250. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3251. const Headers &src_headers);
  3252. struct ChunkedDecoder {
  3253. Stream &strm;
  3254. size_t chunk_remaining = 0;
  3255. bool finished = false;
  3256. char line_buf[64];
  3257. size_t last_chunk_total = 0;
  3258. size_t last_chunk_offset = 0;
  3259. explicit ChunkedDecoder(Stream &s);
  3260. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3261. size_t &out_chunk_total);
  3262. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3263. };
  3264. class mmap {
  3265. public:
  3266. mmap(const char *path);
  3267. ~mmap();
  3268. bool open(const char *path);
  3269. void close();
  3270. bool is_open() const;
  3271. size_t size() const;
  3272. const char *data() const;
  3273. private:
  3274. #if defined(_WIN32)
  3275. HANDLE hFile_ = NULL;
  3276. HANDLE hMapping_ = NULL;
  3277. #else
  3278. int fd_ = -1;
  3279. #endif
  3280. size_t size_ = 0;
  3281. void *addr_ = nullptr;
  3282. bool is_open_empty_file = false;
  3283. };
  3284. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3285. namespace fields {
  3286. bool is_token_char(char c);
  3287. bool is_token(const std::string &s);
  3288. bool is_field_name(const std::string &s);
  3289. bool is_vchar(char c);
  3290. bool is_obs_text(char c);
  3291. bool is_field_vchar(char c);
  3292. bool is_field_content(const std::string &s);
  3293. bool is_field_value(const std::string &s);
  3294. bool is_field_valid(const std::string &name, const std::string &value);
  3295. bool is_request_target(const std::string &s);
  3296. bool is_host(const std::string &s);
  3297. } // namespace fields
  3298. } // namespace detail
  3299. /*
  3300. * TLS Abstraction Layer Declarations
  3301. */
  3302. #ifdef CPPHTTPLIB_SSL_ENABLED
  3303. // TLS abstraction layer - backend-specific type declarations
  3304. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3305. namespace tls {
  3306. namespace impl {
  3307. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3308. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3309. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3310. struct MbedTlsContext {
  3311. mbedtls_ssl_config conf;
  3312. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3313. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3314. mbedtls_entropy_context entropy;
  3315. mbedtls_ctr_drbg_context ctr_drbg;
  3316. #endif
  3317. mbedtls_x509_crt ca_chain;
  3318. mbedtls_x509_crt own_cert;
  3319. mbedtls_pk_context own_key;
  3320. bool is_server = false;
  3321. bool verify_client = false;
  3322. VerifyCallback verify_callback;
  3323. MbedTlsContext();
  3324. ~MbedTlsContext();
  3325. MbedTlsContext(const MbedTlsContext &) = delete;
  3326. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3327. };
  3328. } // namespace impl
  3329. } // namespace tls
  3330. #endif
  3331. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3332. namespace tls {
  3333. namespace impl {
  3334. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3335. // This struct is accessible via tls::impl for use in SSL context
  3336. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3337. struct WolfSSLContext {
  3338. WOLFSSL_CTX *ctx = nullptr;
  3339. bool is_server = false;
  3340. bool verify_client = false;
  3341. VerifyCallback verify_callback;
  3342. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3343. WolfSSLContext();
  3344. ~WolfSSLContext();
  3345. WolfSSLContext(const WolfSSLContext &) = delete;
  3346. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3347. };
  3348. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3349. struct WolfSSLCAStore {
  3350. std::string pem_data;
  3351. };
  3352. } // namespace impl
  3353. } // namespace tls
  3354. #endif
  3355. #endif // CPPHTTPLIB_SSL_ENABLED
  3356. namespace stream {
  3357. class Result {
  3358. public:
  3359. Result();
  3360. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3361. Result(Result &&other) noexcept;
  3362. Result &operator=(Result &&other) noexcept;
  3363. Result(const Result &) = delete;
  3364. Result &operator=(const Result &) = delete;
  3365. // Response info
  3366. bool is_valid() const;
  3367. explicit operator bool() const;
  3368. int status() const;
  3369. const Headers &headers() const;
  3370. std::string get_header_value(const std::string &key,
  3371. const char *def = "") const;
  3372. bool has_header(const std::string &key) const;
  3373. Error error() const;
  3374. Error read_error() const;
  3375. bool has_read_error() const;
  3376. // Stream reading
  3377. bool next();
  3378. const char *data() const;
  3379. size_t size() const;
  3380. std::string read_all();
  3381. private:
  3382. ClientImpl::StreamHandle handle_;
  3383. std::string buffer_;
  3384. size_t current_size_ = 0;
  3385. size_t chunk_size_;
  3386. bool finished_ = false;
  3387. };
  3388. // GET
  3389. template <typename ClientType>
  3390. inline Result Get(ClientType &cli, const std::string &path,
  3391. size_t chunk_size = 8192) {
  3392. return Result{cli.open_stream("GET", path), chunk_size};
  3393. }
  3394. template <typename ClientType>
  3395. inline Result Get(ClientType &cli, const std::string &path,
  3396. const Headers &headers, size_t chunk_size = 8192) {
  3397. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3398. }
  3399. template <typename ClientType>
  3400. inline Result Get(ClientType &cli, const std::string &path,
  3401. const Params &params, size_t chunk_size = 8192) {
  3402. return Result{cli.open_stream("GET", path, params), chunk_size};
  3403. }
  3404. template <typename ClientType>
  3405. inline Result Get(ClientType &cli, const std::string &path,
  3406. const Params &params, const Headers &headers,
  3407. size_t chunk_size = 8192) {
  3408. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3409. }
  3410. // POST
  3411. template <typename ClientType>
  3412. inline Result Post(ClientType &cli, const std::string &path,
  3413. const std::string &body, const std::string &content_type,
  3414. size_t chunk_size = 8192) {
  3415. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3416. chunk_size};
  3417. }
  3418. template <typename ClientType>
  3419. inline Result Post(ClientType &cli, const std::string &path,
  3420. const Headers &headers, const std::string &body,
  3421. const std::string &content_type, size_t chunk_size = 8192) {
  3422. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3423. chunk_size};
  3424. }
  3425. template <typename ClientType>
  3426. inline Result Post(ClientType &cli, const std::string &path,
  3427. const Params &params, const std::string &body,
  3428. const std::string &content_type, size_t chunk_size = 8192) {
  3429. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3430. chunk_size};
  3431. }
  3432. template <typename ClientType>
  3433. inline Result Post(ClientType &cli, const std::string &path,
  3434. const Params &params, const Headers &headers,
  3435. const std::string &body, const std::string &content_type,
  3436. size_t chunk_size = 8192) {
  3437. return Result{
  3438. cli.open_stream("POST", path, params, headers, body, content_type),
  3439. chunk_size};
  3440. }
  3441. // PUT
  3442. template <typename ClientType>
  3443. inline Result Put(ClientType &cli, const std::string &path,
  3444. const std::string &body, const std::string &content_type,
  3445. size_t chunk_size = 8192) {
  3446. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3447. chunk_size};
  3448. }
  3449. template <typename ClientType>
  3450. inline Result Put(ClientType &cli, const std::string &path,
  3451. const Headers &headers, const std::string &body,
  3452. const std::string &content_type, size_t chunk_size = 8192) {
  3453. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3454. chunk_size};
  3455. }
  3456. template <typename ClientType>
  3457. inline Result Put(ClientType &cli, const std::string &path,
  3458. const Params &params, const std::string &body,
  3459. const std::string &content_type, size_t chunk_size = 8192) {
  3460. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3461. chunk_size};
  3462. }
  3463. template <typename ClientType>
  3464. inline Result Put(ClientType &cli, const std::string &path,
  3465. const Params &params, const Headers &headers,
  3466. const std::string &body, const std::string &content_type,
  3467. size_t chunk_size = 8192) {
  3468. return Result{
  3469. cli.open_stream("PUT", path, params, headers, body, content_type),
  3470. chunk_size};
  3471. }
  3472. // PATCH
  3473. template <typename ClientType>
  3474. inline Result Patch(ClientType &cli, const std::string &path,
  3475. const std::string &body, const std::string &content_type,
  3476. size_t chunk_size = 8192) {
  3477. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3478. chunk_size};
  3479. }
  3480. template <typename ClientType>
  3481. inline Result Patch(ClientType &cli, const std::string &path,
  3482. const Headers &headers, const std::string &body,
  3483. const std::string &content_type, size_t chunk_size = 8192) {
  3484. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3485. chunk_size};
  3486. }
  3487. template <typename ClientType>
  3488. inline Result Patch(ClientType &cli, const std::string &path,
  3489. const Params &params, const std::string &body,
  3490. const std::string &content_type, size_t chunk_size = 8192) {
  3491. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3492. chunk_size};
  3493. }
  3494. template <typename ClientType>
  3495. inline Result Patch(ClientType &cli, const std::string &path,
  3496. const Params &params, const Headers &headers,
  3497. const std::string &body, const std::string &content_type,
  3498. size_t chunk_size = 8192) {
  3499. return Result{
  3500. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3501. chunk_size};
  3502. }
  3503. // DELETE
  3504. template <typename ClientType>
  3505. inline Result Delete(ClientType &cli, const std::string &path,
  3506. size_t chunk_size = 8192) {
  3507. return Result{cli.open_stream("DELETE", path), chunk_size};
  3508. }
  3509. template <typename ClientType>
  3510. inline Result Delete(ClientType &cli, const std::string &path,
  3511. const Headers &headers, size_t chunk_size = 8192) {
  3512. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3513. }
  3514. template <typename ClientType>
  3515. inline Result Delete(ClientType &cli, const std::string &path,
  3516. const std::string &body, const std::string &content_type,
  3517. size_t chunk_size = 8192) {
  3518. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3519. chunk_size};
  3520. }
  3521. template <typename ClientType>
  3522. inline Result Delete(ClientType &cli, const std::string &path,
  3523. const Headers &headers, const std::string &body,
  3524. const std::string &content_type,
  3525. size_t chunk_size = 8192) {
  3526. return Result{
  3527. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3528. chunk_size};
  3529. }
  3530. template <typename ClientType>
  3531. inline Result Delete(ClientType &cli, const std::string &path,
  3532. const Params &params, size_t chunk_size = 8192) {
  3533. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3534. }
  3535. template <typename ClientType>
  3536. inline Result Delete(ClientType &cli, const std::string &path,
  3537. const Params &params, const Headers &headers,
  3538. size_t chunk_size = 8192) {
  3539. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3540. }
  3541. template <typename ClientType>
  3542. inline Result Delete(ClientType &cli, const std::string &path,
  3543. const Params &params, const std::string &body,
  3544. const std::string &content_type,
  3545. size_t chunk_size = 8192) {
  3546. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3547. chunk_size};
  3548. }
  3549. template <typename ClientType>
  3550. inline Result Delete(ClientType &cli, const std::string &path,
  3551. const Params &params, const Headers &headers,
  3552. const std::string &body, const std::string &content_type,
  3553. size_t chunk_size = 8192) {
  3554. return Result{
  3555. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3556. chunk_size};
  3557. }
  3558. // HEAD
  3559. template <typename ClientType>
  3560. inline Result Head(ClientType &cli, const std::string &path,
  3561. size_t chunk_size = 8192) {
  3562. return Result{cli.open_stream("HEAD", path), chunk_size};
  3563. }
  3564. template <typename ClientType>
  3565. inline Result Head(ClientType &cli, const std::string &path,
  3566. const Headers &headers, size_t chunk_size = 8192) {
  3567. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3568. }
  3569. template <typename ClientType>
  3570. inline Result Head(ClientType &cli, const std::string &path,
  3571. const Params &params, size_t chunk_size = 8192) {
  3572. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3573. }
  3574. template <typename ClientType>
  3575. inline Result Head(ClientType &cli, const std::string &path,
  3576. const Params &params, const Headers &headers,
  3577. size_t chunk_size = 8192) {
  3578. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3579. }
  3580. // OPTIONS
  3581. template <typename ClientType>
  3582. inline Result Options(ClientType &cli, const std::string &path,
  3583. size_t chunk_size = 8192) {
  3584. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3585. }
  3586. template <typename ClientType>
  3587. inline Result Options(ClientType &cli, const std::string &path,
  3588. const Headers &headers, size_t chunk_size = 8192) {
  3589. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3590. }
  3591. template <typename ClientType>
  3592. inline Result Options(ClientType &cli, const std::string &path,
  3593. const Params &params, size_t chunk_size = 8192) {
  3594. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3595. }
  3596. template <typename ClientType>
  3597. inline Result Options(ClientType &cli, const std::string &path,
  3598. const Params &params, const Headers &headers,
  3599. size_t chunk_size = 8192) {
  3600. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3601. }
  3602. } // namespace stream
  3603. namespace sse {
  3604. struct SSEMessage {
  3605. std::string event; // Event type (default: "message")
  3606. std::string data; // Event payload
  3607. std::string id; // Event ID for Last-Event-ID header
  3608. SSEMessage();
  3609. void clear();
  3610. };
  3611. class SSEClient {
  3612. public:
  3613. using MessageHandler = std::function<void(const SSEMessage &)>;
  3614. using ErrorHandler = std::function<void(Error)>;
  3615. using OpenHandler = std::function<void()>;
  3616. SSEClient(Client &client, const std::string &path);
  3617. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3618. ~SSEClient();
  3619. SSEClient(const SSEClient &) = delete;
  3620. SSEClient &operator=(const SSEClient &) = delete;
  3621. // Event handlers
  3622. SSEClient &on_message(MessageHandler handler);
  3623. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3624. SSEClient &on_open(OpenHandler handler);
  3625. SSEClient &on_error(ErrorHandler handler);
  3626. SSEClient &set_reconnect_interval(int ms);
  3627. SSEClient &set_max_reconnect_attempts(int n);
  3628. // Update headers (thread-safe)
  3629. SSEClient &set_headers(const Headers &headers);
  3630. // State accessors
  3631. bool is_connected() const;
  3632. const std::string &last_event_id() const;
  3633. // Blocking start - runs event loop with auto-reconnect
  3634. void start();
  3635. // Non-blocking start - runs in background thread
  3636. void start_async();
  3637. // Stop the client (thread-safe)
  3638. void stop();
  3639. private:
  3640. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3641. bool &has_data, bool &has_id);
  3642. void run_event_loop();
  3643. void dispatch_event(const SSEMessage &msg);
  3644. bool should_reconnect(int count) const;
  3645. void wait_for_reconnect();
  3646. // Client and path
  3647. Client &client_;
  3648. std::string path_;
  3649. Headers headers_;
  3650. mutable std::mutex headers_mutex_;
  3651. // Callbacks
  3652. MessageHandler on_message_;
  3653. std::map<std::string, MessageHandler> event_handlers_;
  3654. OpenHandler on_open_;
  3655. ErrorHandler on_error_;
  3656. // Configuration
  3657. int reconnect_interval_ms_ = 3000;
  3658. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3659. // State
  3660. std::atomic<bool> running_{false};
  3661. std::atomic<bool> connected_{false};
  3662. std::string last_event_id_;
  3663. // Async support
  3664. std::thread async_thread_;
  3665. };
  3666. } // namespace sse
  3667. namespace ws {
  3668. class WebSocketClient;
  3669. enum class Opcode : uint8_t {
  3670. Continuation = 0x0,
  3671. Text = 0x1,
  3672. Binary = 0x2,
  3673. Close = 0x8,
  3674. Ping = 0x9,
  3675. Pong = 0xA,
  3676. };
  3677. enum class CloseStatus : uint16_t {
  3678. Normal = 1000,
  3679. GoingAway = 1001,
  3680. ProtocolError = 1002,
  3681. UnsupportedData = 1003,
  3682. NoStatus = 1005,
  3683. Abnormal = 1006,
  3684. InvalidPayload = 1007,
  3685. PolicyViolation = 1008,
  3686. MessageTooBig = 1009,
  3687. MandatoryExtension = 1010,
  3688. InternalError = 1011,
  3689. };
  3690. // Timeout is returned only when a read timeout was set and it elapsed before
  3691. // any byte of a frame arrived: nothing was consumed and the connection is
  3692. // still open, so the caller can send on it and read again. `msg` is left
  3693. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3694. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3695. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3696. // upgrade handshake fully succeeded. On failure error() identifies the
  3697. // failing layer; status()/headers() expose the server's upgrade response
  3698. // when one was received (status() is -1 otherwise).
  3699. class Result {
  3700. public:
  3701. Result() = default;
  3702. Result(Error err, int status, Headers &&headers)
  3703. : err_(err), status_(status), headers_(std::move(headers)) {}
  3704. explicit operator bool() const { return err_ == Error::Success; }
  3705. Error error() const { return err_; }
  3706. // Upgrade response info
  3707. int status() const { return status_; }
  3708. const Headers &headers() const { return headers_; }
  3709. std::string get_header_value(const std::string &key,
  3710. const char *def = "") const {
  3711. return detail::get_header_value(headers_, key, def, 0);
  3712. }
  3713. bool has_header(const std::string &key) const {
  3714. return headers_.find(key) != headers_.end();
  3715. }
  3716. #ifdef CPPHTTPLIB_SSL_ENABLED
  3717. Result(Error err, int status, Headers &&headers, int ssl_error,
  3718. uint64_t ssl_backend_error)
  3719. : err_(err), status_(status), headers_(std::move(headers)),
  3720. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3721. int ssl_error() const { return ssl_error_; }
  3722. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3723. #endif
  3724. private:
  3725. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3726. int status_ = -1;
  3727. Headers headers_;
  3728. #ifdef CPPHTTPLIB_SSL_ENABLED
  3729. int ssl_error_ = 0;
  3730. uint64_t ssl_backend_error_ = 0;
  3731. #endif
  3732. };
  3733. class WebSocket {
  3734. public:
  3735. WebSocket(const WebSocket &) = delete;
  3736. WebSocket &operator=(const WebSocket &) = delete;
  3737. ~WebSocket();
  3738. ReadResult read(std::string &msg);
  3739. bool send(const std::string &data);
  3740. bool send(const char *data, size_t len);
  3741. void close(CloseStatus status = CloseStatus::Normal,
  3742. const std::string &reason = "");
  3743. const Request &request() const;
  3744. bool is_open() const;
  3745. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3746. // A server handler owns its connection's timeout this way; a client sets it
  3747. // through WebSocketClient. Safe to call while another thread is in read().
  3748. //
  3749. // Only a timeout set here is reported as Timeout. The compile-time default
  3750. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3751. // than a request for control, so when it elapses read() returns Fail and
  3752. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3753. void set_read_timeout(time_t sec, time_t usec = 0);
  3754. template <class Rep, class Period>
  3755. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3756. private:
  3757. friend class httplib::Server;
  3758. friend class httplib::ws::WebSocketClient;
  3759. WebSocket(
  3760. Stream &strm, const Request &req, bool is_server,
  3761. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3762. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3763. : strm_(strm), req_(req), is_server_(is_server),
  3764. ping_interval_sec_(ping_interval_sec),
  3765. max_missed_pongs_(max_missed_pongs) {
  3766. start_heartbeat();
  3767. }
  3768. WebSocket(
  3769. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3770. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3771. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3772. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3773. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3774. max_missed_pongs_(max_missed_pongs) {
  3775. start_heartbeat();
  3776. }
  3777. void start_heartbeat();
  3778. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3779. Stream &strm_;
  3780. std::unique_ptr<Stream> owned_strm_;
  3781. Request req_;
  3782. bool is_server_;
  3783. time_t ping_interval_sec_;
  3784. int max_missed_pongs_;
  3785. int unacked_pings_ = 0;
  3786. std::atomic<bool> closed_{false};
  3787. // Set once the caller has bounded read() through set_read_timeout(). Until
  3788. // then the timeout in effect is the compile-time default, and elapsing it
  3789. // is a failure that closes the connection, not a Timeout.
  3790. std::atomic<bool> read_timeout_set_{false};
  3791. std::mutex write_mutex_;
  3792. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3793. // may do so: read_websocket_frame() reads a payload until it has the whole
  3794. // declared length, so a second parser stealing bytes silently corrupts the
  3795. // message the first one is assembling.
  3796. std::mutex read_mutex_;
  3797. std::thread ping_thread_;
  3798. std::mutex ping_mutex_;
  3799. std::condition_variable ping_cv_;
  3800. };
  3801. class WebSocketClient {
  3802. public:
  3803. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3804. const Headers &headers = {});
  3805. ~WebSocketClient();
  3806. WebSocketClient(const WebSocketClient &) = delete;
  3807. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3808. bool is_valid() const;
  3809. Result connect();
  3810. ReadResult read(std::string &msg);
  3811. bool send(const std::string &data);
  3812. bool send(const char *data, size_t len);
  3813. void close(CloseStatus status = CloseStatus::Normal,
  3814. const std::string &reason = "");
  3815. bool is_open() const;
  3816. const std::string &subprotocol() const;
  3817. void set_read_timeout(time_t sec, time_t usec = 0);
  3818. template <class Rep, class Period>
  3819. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3820. void set_write_timeout(time_t sec, time_t usec = 0);
  3821. template <class Rep, class Period>
  3822. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3823. void set_websocket_ping_interval(time_t sec);
  3824. void set_websocket_max_missed_pongs(int count);
  3825. void set_tcp_nodelay(bool on);
  3826. void set_address_family(int family);
  3827. void set_ipv6_v6only(bool on);
  3828. void set_socket_options(SocketOptions socket_options);
  3829. void set_connection_timeout(time_t sec, time_t usec = 0);
  3830. template <class Rep, class Period>
  3831. void
  3832. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3833. void set_interface(const std::string &intf);
  3834. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3835. #ifdef CPPHTTPLIB_SSL_ENABLED
  3836. struct PemMemory {
  3837. const char *cert_pem;
  3838. size_t cert_pem_len;
  3839. const char *key_pem;
  3840. size_t key_pem_len;
  3841. const char *private_key_password;
  3842. };
  3843. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3844. const PemMemory &pem, const Headers &headers = {});
  3845. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3846. const std::string &ca_cert_dir_path = std::string());
  3847. void set_ca_cert_store(tls::ca_store_t store);
  3848. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3849. void enable_server_certificate_verification(bool enabled);
  3850. void enable_server_hostname_verification(bool enabled);
  3851. void enable_system_ca(bool enabled);
  3852. #endif
  3853. private:
  3854. void shutdown_and_close();
  3855. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3856. int &ssl_error, uint64_t &ssl_backend_error);
  3857. void prepare_default_headers(Request &req);
  3858. std::string host_;
  3859. int port_;
  3860. std::string path_;
  3861. Headers headers_;
  3862. std::string subprotocol_;
  3863. bool is_valid_ = false;
  3864. socket_t sock_ = INVALID_SOCKET;
  3865. std::unique_ptr<WebSocket> ws_;
  3866. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3867. time_t read_timeout_usec_ = 0;
  3868. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3869. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3870. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3871. time_t websocket_ping_interval_sec_ =
  3872. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3873. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3874. int address_family_ = AF_UNSPEC;
  3875. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3876. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3877. SocketOptions socket_options_ = nullptr;
  3878. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3879. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3880. std::string interface_;
  3881. // Hostname to connection target map. The value is an IP literal or another
  3882. // hostname; only the connection target changes, never the identity.
  3883. std::map<std::string, std::string> addr_map_;
  3884. #ifdef CPPHTTPLIB_SSL_ENABLED
  3885. bool is_ssl_ = false;
  3886. tls::ctx_t tls_ctx_ = nullptr;
  3887. tls::session_t tls_session_ = nullptr;
  3888. std::string ca_cert_file_path_;
  3889. std::string ca_cert_dir_path_;
  3890. bool custom_ca_loaded_ = false;
  3891. bool certs_loaded_ = false;
  3892. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3893. bool server_certificate_verification_ = true;
  3894. bool server_hostname_verification_ = true;
  3895. #endif
  3896. };
  3897. template <class Rep, class Period>
  3898. inline void WebSocket::set_read_timeout(
  3899. const std::chrono::duration<Rep, Period> &duration) {
  3900. detail::duration_to_sec_and_usec(
  3901. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3902. }
  3903. template <class Rep, class Period>
  3904. inline void WebSocketClient::set_read_timeout(
  3905. const std::chrono::duration<Rep, Period> &duration) {
  3906. detail::duration_to_sec_and_usec(
  3907. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3908. }
  3909. template <class Rep, class Period>
  3910. inline void WebSocketClient::set_write_timeout(
  3911. const std::chrono::duration<Rep, Period> &duration) {
  3912. detail::duration_to_sec_and_usec(
  3913. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3914. }
  3915. template <class Rep, class Period>
  3916. inline void WebSocketClient::set_connection_timeout(
  3917. const std::chrono::duration<Rep, Period> &duration) {
  3918. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3919. set_connection_timeout(sec, usec);
  3920. });
  3921. }
  3922. namespace impl {
  3923. bool is_valid_utf8(const std::string &s);
  3924. // Three states, because a failure that consumed bytes and one that consumed
  3925. // none are not the same thing: the first has left the stream in the middle of
  3926. // a frame and the connection cannot be reused, the second can just be retried.
  3927. enum class FrameRead { Ok, Fail, Timeout };
  3928. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3929. std::string &payload, bool &fin,
  3930. bool expect_masked, size_t max_len);
  3931. } // namespace impl
  3932. } // namespace ws
  3933. // ----------------------------------------------------------------------------
  3934. /*
  3935. * Implementation that will be part of the .cc file if split into .h + .cc.
  3936. */
  3937. namespace stream {
  3938. // stream::Result implementations
  3939. inline Result::Result() : chunk_size_(8192) {}
  3940. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3941. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3942. inline Result::Result(Result &&other) noexcept
  3943. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3944. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3945. finished_(other.finished_) {
  3946. other.current_size_ = 0;
  3947. other.finished_ = true;
  3948. }
  3949. inline Result &Result::operator=(Result &&other) noexcept {
  3950. if (this != &other) {
  3951. handle_ = std::move(other.handle_);
  3952. buffer_ = std::move(other.buffer_);
  3953. current_size_ = other.current_size_;
  3954. chunk_size_ = other.chunk_size_;
  3955. finished_ = other.finished_;
  3956. other.current_size_ = 0;
  3957. other.finished_ = true;
  3958. }
  3959. return *this;
  3960. }
  3961. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3962. inline Result::operator bool() const { return is_valid(); }
  3963. inline int Result::status() const {
  3964. return handle_.response ? handle_.response->status : -1;
  3965. }
  3966. inline const Headers &Result::headers() const {
  3967. static const Headers empty_headers;
  3968. return handle_.response ? handle_.response->headers : empty_headers;
  3969. }
  3970. inline std::string Result::get_header_value(const std::string &key,
  3971. const char *def) const {
  3972. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3973. }
  3974. inline bool Result::has_header(const std::string &key) const {
  3975. return handle_.response ? handle_.response->has_header(key) : false;
  3976. }
  3977. inline Error Result::error() const { return handle_.error; }
  3978. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3979. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3980. inline bool Result::next() {
  3981. if (!handle_.is_valid() || finished_) { return false; }
  3982. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3983. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3984. if (n > 0) {
  3985. current_size_ = static_cast<size_t>(n);
  3986. return true;
  3987. }
  3988. current_size_ = 0;
  3989. finished_ = true;
  3990. return false;
  3991. }
  3992. inline const char *Result::data() const { return buffer_.data(); }
  3993. inline size_t Result::size() const { return current_size_; }
  3994. inline std::string Result::read_all() {
  3995. std::string result;
  3996. while (next()) {
  3997. result.append(data(), size());
  3998. }
  3999. return result;
  4000. }
  4001. } // namespace stream
  4002. namespace sse {
  4003. // SSEMessage implementations
  4004. inline SSEMessage::SSEMessage() : event("message") {}
  4005. inline void SSEMessage::clear() {
  4006. event = "message";
  4007. data.clear();
  4008. id.clear();
  4009. }
  4010. // SSEClient implementations
  4011. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4012. : client_(client), path_(path) {}
  4013. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4014. const Headers &headers)
  4015. : client_(client), path_(path), headers_(headers) {}
  4016. inline SSEClient::~SSEClient() { stop(); }
  4017. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4018. on_message_ = std::move(handler);
  4019. return *this;
  4020. }
  4021. inline SSEClient &SSEClient::on_event(const std::string &type,
  4022. MessageHandler handler) {
  4023. event_handlers_[type] = std::move(handler);
  4024. return *this;
  4025. }
  4026. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4027. on_open_ = std::move(handler);
  4028. return *this;
  4029. }
  4030. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4031. on_error_ = std::move(handler);
  4032. return *this;
  4033. }
  4034. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4035. reconnect_interval_ms_ = ms;
  4036. return *this;
  4037. }
  4038. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4039. max_reconnect_attempts_ = n;
  4040. return *this;
  4041. }
  4042. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4043. std::lock_guard<std::mutex> lock(headers_mutex_);
  4044. headers_ = headers;
  4045. return *this;
  4046. }
  4047. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4048. inline const std::string &SSEClient::last_event_id() const {
  4049. return last_event_id_;
  4050. }
  4051. inline void SSEClient::start() {
  4052. running_.store(true);
  4053. run_event_loop();
  4054. }
  4055. inline void SSEClient::start_async() {
  4056. running_.store(true);
  4057. async_thread_ = std::thread([this]() { run_event_loop(); });
  4058. }
  4059. inline void SSEClient::stop() {
  4060. running_.store(false);
  4061. client_.stop(); // Cancel any pending operations
  4062. if (async_thread_.joinable()) { async_thread_.join(); }
  4063. }
  4064. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4065. int &retry_ms, bool &has_data,
  4066. bool &has_id) {
  4067. // Blank line signals end of event
  4068. if (line.empty()) { return true; }
  4069. // Lines starting with ':' are comments (ignored)
  4070. if (line[0] == ':') { return false; }
  4071. // Find the colon separator
  4072. auto colon_pos = line.find(':');
  4073. auto field = line.substr(0, colon_pos);
  4074. std::string value;
  4075. // Value starts after colon, skip optional single space
  4076. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4077. auto value_start = colon_pos + 1;
  4078. if (line[value_start] == ' ') { value_start++; }
  4079. value = line.substr(value_start);
  4080. }
  4081. // Handle known fields
  4082. if (field == "event") {
  4083. msg.event = value;
  4084. } else if (field == "data") {
  4085. // Multiple data lines are concatenated with newlines
  4086. if (has_data) { msg.data += "\n"; }
  4087. msg.data += value;
  4088. has_data = true;
  4089. } else if (field == "id") {
  4090. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4091. // valid (clears the last event ID)
  4092. if (detail::fields::is_field_value(value)) {
  4093. msg.id = value;
  4094. has_id = true;
  4095. }
  4096. } else if (field == "retry") {
  4097. // Parse retry interval in milliseconds
  4098. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4099. if (detail::is_numeric(value)) {
  4100. int v = 0;
  4101. auto res =
  4102. detail::from_chars(value.data(), value.data() + value.size(), v);
  4103. if (res.ec == std::errc{}) { retry_ms = v; }
  4104. }
  4105. }
  4106. // Unknown fields are ignored per SSE spec
  4107. return false;
  4108. }
  4109. inline void SSEClient::run_event_loop() {
  4110. auto reconnect_count = 0;
  4111. while (running_.load()) {
  4112. // Build headers, including Last-Event-ID if we have one
  4113. Headers request_headers;
  4114. {
  4115. std::lock_guard<std::mutex> lock(headers_mutex_);
  4116. request_headers = headers_;
  4117. }
  4118. if (!last_event_id_.empty()) {
  4119. request_headers.emplace("Last-Event-ID", last_event_id_);
  4120. }
  4121. // Open streaming connection
  4122. auto result = stream::Get(client_, path_, request_headers);
  4123. // Connection error handling
  4124. if (!result) {
  4125. connected_.store(false);
  4126. if (on_error_) { on_error_(result.error()); }
  4127. if (!should_reconnect(reconnect_count)) { break; }
  4128. wait_for_reconnect();
  4129. reconnect_count++;
  4130. continue;
  4131. }
  4132. if (result.status() != StatusCode::OK_200) {
  4133. connected_.store(false);
  4134. if (on_error_) { on_error_(Error::Connection); }
  4135. // For certain errors, don't reconnect.
  4136. // Note: 401 is intentionally absent so that handlers can refresh
  4137. // credentials via set_headers() and let the client reconnect.
  4138. if (result.status() == StatusCode::NoContent_204 ||
  4139. result.status() == StatusCode::NotFound_404 ||
  4140. result.status() == StatusCode::Forbidden_403) {
  4141. break;
  4142. }
  4143. if (!should_reconnect(reconnect_count)) { break; }
  4144. wait_for_reconnect();
  4145. reconnect_count++;
  4146. continue;
  4147. }
  4148. // Connection successful
  4149. connected_.store(true);
  4150. reconnect_count = 0;
  4151. if (on_open_) { on_open_(); }
  4152. // Event receiving loop
  4153. std::string buffer;
  4154. SSEMessage current_msg;
  4155. auto has_data = false;
  4156. auto has_id = false;
  4157. auto first_line = true;
  4158. auto after_cr = false;
  4159. while (running_.load() && result.next()) {
  4160. // What is left in the buffer has no line ending
  4161. auto search_pos = buffer.size();
  4162. buffer.append(result.data(), result.size());
  4163. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4164. // per the SSE spec
  4165. size_t line_start = 0;
  4166. size_t eol_pos;
  4167. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4168. std::string::npos) {
  4169. auto line = buffer.substr(line_start, eol_pos - line_start);
  4170. line_start = eol_pos + 1;
  4171. search_pos = line_start;
  4172. // The \n of a \r\n may arrive in a later chunk than its \r
  4173. auto is_lf_of_crlf =
  4174. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4175. after_cr = buffer[eol_pos] == '\r';
  4176. if (is_lf_of_crlf) { continue; }
  4177. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4178. if (first_line) {
  4179. first_line = false;
  4180. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4181. }
  4182. // Parse the line and check if event is complete
  4183. auto event_complete = parse_sse_line(
  4184. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4185. if (event_complete) {
  4186. // Update last_event_id for reconnection, even for an event that
  4187. // has no data. An empty id clears it.
  4188. if (has_id) { last_event_id_ = current_msg.id; }
  4189. // An event without a data field is not dispatched
  4190. if (has_data) { dispatch_event(current_msg); }
  4191. // Reset the message for the next event either way
  4192. current_msg.clear();
  4193. has_data = false;
  4194. has_id = false;
  4195. }
  4196. }
  4197. // Keep unprocessed data in buffer
  4198. buffer.erase(0, line_start);
  4199. // Neither an event nor a line still waiting for its end may grow
  4200. // without bound. 0 means no limit.
  4201. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4202. buffer.size() + current_msg.data.size() >
  4203. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4204. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4205. break;
  4206. }
  4207. }
  4208. // Connection ended
  4209. connected_.store(false);
  4210. if (!running_.load()) { break; }
  4211. // Check for read errors
  4212. if (result.has_read_error()) {
  4213. if (on_error_) { on_error_(result.read_error()); }
  4214. }
  4215. if (!should_reconnect(reconnect_count)) { break; }
  4216. wait_for_reconnect();
  4217. reconnect_count++;
  4218. }
  4219. connected_.store(false);
  4220. }
  4221. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4222. // Check for specific event type handler first
  4223. auto it = event_handlers_.find(msg.event);
  4224. if (it != event_handlers_.end()) {
  4225. it->second(msg);
  4226. return;
  4227. }
  4228. // Fall back to generic message handler
  4229. if (on_message_) { on_message_(msg); }
  4230. }
  4231. inline bool SSEClient::should_reconnect(int count) const {
  4232. if (!running_.load()) { return false; }
  4233. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4234. return count < max_reconnect_attempts_;
  4235. }
  4236. inline void SSEClient::wait_for_reconnect() {
  4237. // Use small increments to check running_ flag frequently.
  4238. // Always wait at least one increment, so that a zero interval (e.g.
  4239. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4240. const auto step_ms = 100;
  4241. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4242. auto waited = 0;
  4243. while (running_.load() && waited < interval_ms) {
  4244. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4245. waited += step_ms;
  4246. }
  4247. }
  4248. } // namespace sse
  4249. #ifdef CPPHTTPLIB_SSL_ENABLED
  4250. /*
  4251. * TLS abstraction layer - internal function declarations
  4252. * These are implementation details and not part of the public API.
  4253. */
  4254. namespace tls {
  4255. // Client context
  4256. ctx_t create_client_context();
  4257. void free_context(ctx_t ctx);
  4258. bool set_min_version(ctx_t ctx, Version version);
  4259. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4260. bool load_ca_file(ctx_t ctx, const char *file_path);
  4261. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4262. bool load_system_certs(ctx_t ctx);
  4263. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4264. const char *password);
  4265. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4266. const char *key_path, const char *password);
  4267. // Server context
  4268. ctx_t create_server_context();
  4269. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4270. const char *password);
  4271. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4272. const char *key_path, const char *password);
  4273. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4274. void set_verify_client(ctx_t ctx, bool require);
  4275. // Session management
  4276. session_t create_session(ctx_t ctx, socket_t sock);
  4277. void free_session(session_t session);
  4278. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4279. // Handshake (non-blocking capable)
  4280. TlsError connect(session_t session);
  4281. TlsError accept(session_t session);
  4282. // Handshake with timeout (blocking until timeout)
  4283. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4284. time_t timeout_usec, TlsError *err);
  4285. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4286. time_t timeout_usec, TlsError *err);
  4287. // I/O (non-blocking capable)
  4288. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4289. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4290. int pending(const_session_t session);
  4291. void shutdown(session_t session, bool graceful);
  4292. // Connection state
  4293. bool is_peer_closed(session_t session, socket_t sock);
  4294. // Certificate verification
  4295. cert_t get_peer_cert(const_session_t session);
  4296. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4297. // do not use them after free_session(), as with get_peer_cert().
  4298. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4299. void free_cert(cert_t cert);
  4300. bool verify_hostname(cert_t cert, const char *hostname);
  4301. uint64_t hostname_mismatch_code();
  4302. long get_verify_result(const_session_t session);
  4303. // Certificate introspection
  4304. std::string get_cert_subject_cn(cert_t cert);
  4305. std::string get_cert_issuer_name(cert_t cert);
  4306. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4307. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4308. std::string get_cert_serial(cert_t cert);
  4309. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4310. const char *get_sni(const_session_t session);
  4311. // CA store management
  4312. ca_store_t create_ca_store(const char *pem, size_t len);
  4313. void free_ca_store(ca_store_t store);
  4314. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4315. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4316. std::vector<std::string> get_ca_names(ctx_t ctx);
  4317. // Dynamic certificate update (for servers)
  4318. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4319. const char *password);
  4320. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4321. // Certificate verification callback
  4322. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4323. long get_verify_error(const_session_t session);
  4324. std::string verify_error_string(long error_code);
  4325. // TlsError information
  4326. uint64_t peek_error();
  4327. uint64_t get_error();
  4328. std::string error_string(uint64_t code);
  4329. } // namespace tls
  4330. #endif // CPPHTTPLIB_SSL_ENABLED
  4331. /*
  4332. * Group 1: detail namespace - Non-SSL utilities
  4333. */
  4334. namespace detail {
  4335. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4336. const void *optval, socklen_t optlen) {
  4337. return setsockopt(sock, level, optname,
  4338. #ifdef _WIN32
  4339. reinterpret_cast<const char *>(optval),
  4340. #else
  4341. optval,
  4342. #endif
  4343. optlen) == 0;
  4344. }
  4345. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4346. time_t sec, time_t usec) {
  4347. #ifdef _WIN32
  4348. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4349. #else
  4350. timeval timeout;
  4351. timeout.tv_sec = static_cast<long>(sec);
  4352. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4353. #endif
  4354. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4355. }
  4356. inline bool is_hex(char c, int &v) {
  4357. if (is_ascii_digit(c)) {
  4358. v = c - '0';
  4359. return true;
  4360. } else if ('A' <= c && c <= 'F') {
  4361. v = c - 'A' + 10;
  4362. return true;
  4363. } else if ('a' <= c && c <= 'f') {
  4364. v = c - 'a' + 10;
  4365. return true;
  4366. }
  4367. return false;
  4368. }
  4369. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4370. int &val) {
  4371. if (i >= s.size()) { return false; }
  4372. val = 0;
  4373. for (; cnt; i++, cnt--) {
  4374. if (!s[i]) { return false; }
  4375. auto v = 0;
  4376. if (is_hex(s[i], v)) {
  4377. val = val * 16 + v;
  4378. } else {
  4379. return false;
  4380. }
  4381. }
  4382. return true;
  4383. }
  4384. inline std::string from_i_to_hex(size_t n) {
  4385. static const auto charset = "0123456789abcdef";
  4386. std::string ret;
  4387. do {
  4388. ret = charset[n & 15] + ret;
  4389. n >>= 4;
  4390. } while (n > 0);
  4391. return ret;
  4392. }
  4393. inline std::string compute_etag(const FileStat &fs,
  4394. const std::string &suffix = std::string()) {
  4395. if (!fs.is_file()) { return std::string(); }
  4396. // If mtime cannot be determined (negative value indicates an error
  4397. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4398. // value like 0 could collide with a real file that legitimately has
  4399. // mtime == 0 (epoch) and lead to misleading validators.
  4400. auto mtime_raw = fs.mtime();
  4401. if (mtime_raw < 0) { return std::string(); }
  4402. auto mtime = static_cast<size_t>(mtime_raw);
  4403. auto size = fs.size();
  4404. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4405. from_i_to_hex(size) + suffix + "\"";
  4406. }
  4407. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4408. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4409. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4410. inline std::string file_mtime_to_http_date(time_t mtime) {
  4411. if (mtime < 0) { return std::string(); }
  4412. struct tm tm_buf;
  4413. #ifdef _WIN32
  4414. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4415. #else
  4416. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4417. #endif
  4418. char buf[64];
  4419. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4420. return std::string();
  4421. }
  4422. return std::string(buf);
  4423. }
  4424. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4425. inline time_t parse_http_date(const std::string &date_str) {
  4426. struct tm tm_buf;
  4427. // Create a classic locale object once for all parsing attempts
  4428. const std::locale classic_locale = std::locale::classic();
  4429. // Try to parse using std::get_time (C++11, cross-platform)
  4430. auto try_parse = [&](const char *fmt) -> bool {
  4431. std::istringstream ss(date_str);
  4432. ss.imbue(classic_locale);
  4433. memset(&tm_buf, 0, sizeof(tm_buf));
  4434. ss >> std::get_time(&tm_buf, fmt);
  4435. return !ss.fail();
  4436. };
  4437. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4438. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4439. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4440. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4441. // asctime format: "Sun Nov 6 08:49:37 1994"
  4442. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4443. return static_cast<time_t>(-1);
  4444. }
  4445. }
  4446. }
  4447. #ifdef _WIN32
  4448. return _mkgmtime(&tm_buf);
  4449. #elif defined _AIX
  4450. return mktime(&tm_buf);
  4451. #else
  4452. return timegm(&tm_buf);
  4453. #endif
  4454. }
  4455. inline bool is_weak_etag(const std::string &s) {
  4456. // Check if the string is a weak ETag (starts with 'W/"')
  4457. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4458. }
  4459. inline bool is_strong_etag(const std::string &s) {
  4460. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4461. // chars)
  4462. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4463. }
  4464. inline size_t to_utf8(int code, char *buff) {
  4465. if (code < 0x0080) {
  4466. buff[0] = static_cast<char>(code & 0x7F);
  4467. return 1;
  4468. } else if (code < 0x0800) {
  4469. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4470. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4471. return 2;
  4472. } else if (code < 0xD800) {
  4473. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4474. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4475. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4476. return 3;
  4477. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4478. return 0;
  4479. } else if (code < 0x10000) {
  4480. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4481. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4482. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4483. return 3;
  4484. } else if (code < 0x110000) {
  4485. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4486. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4487. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4488. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4489. return 4;
  4490. }
  4491. // NOTREACHED
  4492. return 0;
  4493. }
  4494. } // namespace detail
  4495. namespace ws {
  4496. namespace impl {
  4497. inline bool is_valid_utf8(const std::string &s) {
  4498. size_t i = 0;
  4499. auto n = s.size();
  4500. while (i < n) {
  4501. auto c = static_cast<unsigned char>(s[i]);
  4502. size_t len;
  4503. uint32_t cp;
  4504. if (c < 0x80) {
  4505. i++;
  4506. continue;
  4507. } else if ((c & 0xE0) == 0xC0) {
  4508. len = 2;
  4509. cp = c & 0x1F;
  4510. } else if ((c & 0xF0) == 0xE0) {
  4511. len = 3;
  4512. cp = c & 0x0F;
  4513. } else if ((c & 0xF8) == 0xF0) {
  4514. len = 4;
  4515. cp = c & 0x07;
  4516. } else {
  4517. return false;
  4518. }
  4519. if (i + len > n) { return false; }
  4520. for (size_t j = 1; j < len; j++) {
  4521. auto b = static_cast<unsigned char>(s[i + j]);
  4522. if ((b & 0xC0) != 0x80) { return false; }
  4523. cp = (cp << 6) | (b & 0x3F);
  4524. }
  4525. // Overlong encoding check
  4526. if (len == 2 && cp < 0x80) { return false; }
  4527. if (len == 3 && cp < 0x800) { return false; }
  4528. if (len == 4 && cp < 0x10000) { return false; }
  4529. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4530. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4531. if (cp > 0x10FFFF) { return false; }
  4532. i += len;
  4533. }
  4534. return true;
  4535. }
  4536. } // namespace impl
  4537. } // namespace ws
  4538. namespace detail {
  4539. // NOTE: This code came up with the following stackoverflow post:
  4540. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4541. inline std::string base64_encode(const std::string &in) {
  4542. static const auto lookup =
  4543. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4544. std::string out;
  4545. out.reserve(in.size());
  4546. // Unsigned: the accumulator is never masked, so with a signed int the
  4547. // `val << 8` below overflows once enough bytes are folded in (undefined
  4548. // behaviour before C++20). Only the low bits are ever emitted, so the
  4549. // wrap-around of an unsigned accumulator does not affect the output.
  4550. uint32_t val = 0;
  4551. auto valb = -6;
  4552. for (auto c : in) {
  4553. val = (val << 8) + static_cast<uint8_t>(c);
  4554. valb += 8;
  4555. while (valb >= 0) {
  4556. out.push_back(lookup[(val >> valb) & 0x3F]);
  4557. valb -= 6;
  4558. }
  4559. }
  4560. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4561. while (out.size() % 4) {
  4562. out.push_back('=');
  4563. }
  4564. return out;
  4565. }
  4566. inline std::string sha1(const std::string &input) {
  4567. // RFC 3174 SHA-1 implementation
  4568. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4569. return (x << n) | (x >> (32 - n));
  4570. };
  4571. uint32_t h0 = 0x67452301;
  4572. uint32_t h1 = 0xEFCDAB89;
  4573. uint32_t h2 = 0x98BADCFE;
  4574. uint32_t h3 = 0x10325476;
  4575. uint32_t h4 = 0xC3D2E1F0;
  4576. // Pre-processing: adding padding bits
  4577. std::string msg = input;
  4578. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4579. msg.push_back(static_cast<char>(0x80u));
  4580. while (msg.size() % 64 != 56) {
  4581. msg.push_back(0);
  4582. }
  4583. // Append original length in bits as 64-bit big-endian
  4584. for (int i = 56; i >= 0; i -= 8) {
  4585. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4586. }
  4587. // Process each 512-bit chunk
  4588. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4589. uint32_t w[80];
  4590. for (size_t i = 0; i < 16; i++) {
  4591. w[i] =
  4592. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4593. << 24) |
  4594. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4595. << 16) |
  4596. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4597. << 8) |
  4598. (static_cast<uint32_t>(
  4599. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4600. }
  4601. for (int i = 16; i < 80; i++) {
  4602. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4603. }
  4604. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4605. for (int i = 0; i < 80; i++) {
  4606. uint32_t f, k;
  4607. if (i < 20) {
  4608. f = (b & c) | ((~b) & d);
  4609. k = 0x5A827999;
  4610. } else if (i < 40) {
  4611. f = b ^ c ^ d;
  4612. k = 0x6ED9EBA1;
  4613. } else if (i < 60) {
  4614. f = (b & c) | (b & d) | (c & d);
  4615. k = 0x8F1BBCDC;
  4616. } else {
  4617. f = b ^ c ^ d;
  4618. k = 0xCA62C1D6;
  4619. }
  4620. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4621. e = d;
  4622. d = c;
  4623. c = left_rotate(b, 30);
  4624. b = a;
  4625. a = temp;
  4626. }
  4627. h0 += a;
  4628. h1 += b;
  4629. h2 += c;
  4630. h3 += d;
  4631. h4 += e;
  4632. }
  4633. // Produce the final hash as a 20-byte binary string
  4634. std::string hash(20, '\0');
  4635. for (size_t i = 0; i < 4; i++) {
  4636. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4637. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4638. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4639. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4640. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4641. }
  4642. return hash;
  4643. }
  4644. inline std::string websocket_accept_key(const std::string &client_key) {
  4645. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4646. return base64_encode(sha1(client_key + magic));
  4647. }
  4648. inline bool is_websocket_upgrade(const Request &req) {
  4649. if (req.method != "GET") { return false; }
  4650. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4651. // list of protocols and asks recipients to match each name
  4652. // case-insensitively, so look for the token rather than compare the whole
  4653. // field value.
  4654. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4655. // Check Connection: Upgrade
  4656. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4657. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4658. // RFC 6455 Section 4.2.1
  4659. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4660. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4661. return false;
  4662. }
  4663. static const std::string b64chars =
  4664. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4665. for (size_t i = 0; i < 22; i++) {
  4666. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4667. }
  4668. // Check Sec-WebSocket-Version: 13
  4669. auto version = req.get_header_value("Sec-WebSocket-Version");
  4670. if (version != "13") { return false; }
  4671. return true;
  4672. }
  4673. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4674. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4675. thread_local std::random_device rd;
  4676. size_t filled = 0;
  4677. while (filled < n) {
  4678. auto v = rd();
  4679. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4680. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4681. }
  4682. }
  4683. }
  4684. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4685. const char *data, size_t len, bool fin,
  4686. bool mask) {
  4687. // First byte: FIN + opcode
  4688. uint8_t header[2];
  4689. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4690. (static_cast<uint8_t>(opcode) & 0x0F));
  4691. // Second byte: MASK + payload length
  4692. if (len < 126) {
  4693. header[1] = static_cast<uint8_t>(len);
  4694. if (mask) { header[1] |= 0x80; }
  4695. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4696. } else if (len <= 0xFFFF) {
  4697. header[1] = 126;
  4698. if (mask) { header[1] |= 0x80; }
  4699. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4700. uint8_t ext[2];
  4701. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4702. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4703. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4704. } else {
  4705. header[1] = 127;
  4706. if (mask) { header[1] |= 0x80; }
  4707. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4708. uint8_t ext[8];
  4709. for (int i = 7; i >= 0; i--) {
  4710. ext[7 - i] =
  4711. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4712. }
  4713. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4714. }
  4715. if (mask) {
  4716. // Generate random mask key
  4717. uint8_t mask_key[4];
  4718. fill_random_bytes(mask_key, sizeof(mask_key));
  4719. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4720. // Write masked payload in chunks
  4721. const size_t chunk_size = 4096;
  4722. std::vector<char> buf((std::min)(len, chunk_size));
  4723. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4724. size_t n = (std::min)(chunk_size, len - offset);
  4725. for (size_t i = 0; i < n; i++) {
  4726. buf[i] =
  4727. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4728. }
  4729. if (strm.write(buf.data(), n) < 0) { return false; }
  4730. }
  4731. } else {
  4732. if (len > 0) {
  4733. if (strm.write(data, len) < 0) { return false; }
  4734. }
  4735. }
  4736. return true;
  4737. }
  4738. } // namespace detail
  4739. namespace ws {
  4740. namespace impl {
  4741. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4742. // hands back whatever its buffer already holds -- so every multi-byte field has
  4743. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4744. // header straddles the read buffer's boundary.
  4745. //
  4746. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4747. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4748. // there is a failure like any other. (When read() fails it always records why,
  4749. // so the error belongs to this call and not to an earlier one.)
  4750. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4751. auto p = static_cast<char *>(buf);
  4752. size_t total = 0;
  4753. while (total < size) {
  4754. auto n = strm.read(p + total, size - total);
  4755. if (n <= 0) {
  4756. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4757. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4758. }
  4759. total += static_cast<size_t>(n);
  4760. }
  4761. return FrameRead::Ok;
  4762. }
  4763. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4764. std::string &payload, bool &fin,
  4765. bool expect_masked, size_t max_len) {
  4766. // Read first 2 bytes. This is the only read that may report a timeout: it
  4767. // sits on a frame boundary, where nothing has been consumed yet.
  4768. uint8_t header[2];
  4769. FrameRead first = read_exact(strm, header, 2);
  4770. if (first != FrameRead::Ok) { return first; }
  4771. fin = (header[0] & 0x80) != 0;
  4772. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4773. if (header[0] & 0x70) { return FrameRead::Fail; }
  4774. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4775. bool masked = (header[1] & 0x80) != 0;
  4776. uint64_t payload_len = header[1] & 0x7F;
  4777. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4778. // MUST have a payload length of 125 bytes or less
  4779. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4780. if (is_control) {
  4781. if (!fin) { return FrameRead::Fail; }
  4782. if (payload_len > 125) { return FrameRead::Fail; }
  4783. }
  4784. if (masked != expect_masked) { return FrameRead::Fail; }
  4785. // Extended payload length
  4786. if (payload_len == 126) {
  4787. uint8_t ext[2];
  4788. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4789. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4790. } else if (payload_len == 127) {
  4791. uint8_t ext[8];
  4792. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4793. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4794. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4795. payload_len = 0;
  4796. for (int i = 0; i < 8; i++) {
  4797. payload_len = (payload_len << 8) | ext[i];
  4798. }
  4799. }
  4800. // A max_len of 0 means no limit, as payload_max_length does.
  4801. if ((max_len > 0 && payload_len > max_len) ||
  4802. payload_len > (std::numeric_limits<size_t>::max)()) {
  4803. return FrameRead::Fail;
  4804. }
  4805. // Read mask key if present
  4806. uint8_t mask_key[4] = {0};
  4807. if (masked) {
  4808. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4809. return FrameRead::Fail;
  4810. }
  4811. }
  4812. // Grow the payload only as it arrives, since a header alone can announce
  4813. // max_len bytes that never come.
  4814. payload.clear();
  4815. auto len = static_cast<size_t>(payload_len);
  4816. while (payload.size() < len) {
  4817. auto offset = payload.size();
  4818. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4819. payload.resize(offset + n);
  4820. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4821. return FrameRead::Fail;
  4822. }
  4823. }
  4824. // Unmask if needed
  4825. if (masked) {
  4826. for (size_t i = 0; i < payload.size(); i++) {
  4827. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4828. }
  4829. }
  4830. return FrameRead::Ok;
  4831. }
  4832. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4833. // be sent followed by a UTF-8 reason.
  4834. inline bool is_valid_close_payload(const std::string &payload) {
  4835. if (payload.empty()) { return true; }
  4836. if (payload.size() < 2) { return false; }
  4837. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  4838. static_cast<uint8_t>(payload[1]);
  4839. auto may_be_sent = (1000 <= code && code <= 1003) ||
  4840. (1007 <= code && code <= 1014) ||
  4841. (3000 <= code && code <= 4999);
  4842. return may_be_sent && is_valid_utf8(payload.substr(2));
  4843. }
  4844. } // namespace impl
  4845. } // namespace ws
  4846. namespace detail {
  4847. inline bool is_valid_path(const std::string &path) {
  4848. size_t level = 0;
  4849. size_t i = 0;
  4850. // Skip slash
  4851. while (i < path.size() && path[i] == '/') {
  4852. i++;
  4853. }
  4854. while (i < path.size()) {
  4855. // Read component
  4856. auto beg = i;
  4857. while (i < path.size() && path[i] != '/') {
  4858. if (path[i] == '\0') {
  4859. return false;
  4860. } else if (path[i] == '\\') {
  4861. return false;
  4862. }
  4863. i++;
  4864. }
  4865. auto len = i - beg;
  4866. assert(len > 0);
  4867. if (!path.compare(beg, len, ".")) {
  4868. ;
  4869. } else if (!path.compare(beg, len, "..")) {
  4870. if (level == 0) { return false; }
  4871. level--;
  4872. } else {
  4873. level++;
  4874. }
  4875. // Skip slash
  4876. while (i < path.size() && path[i] == '/') {
  4877. i++;
  4878. }
  4879. }
  4880. return true;
  4881. }
  4882. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4883. #if defined(_WIN32)
  4884. char buf[_MAX_PATH];
  4885. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4886. resolved = buf;
  4887. #elif defined(PATH_MAX)
  4888. char buf[PATH_MAX];
  4889. if (realpath(path, buf) == nullptr) { return false; }
  4890. resolved = buf;
  4891. #else
  4892. auto buf = realpath(path, nullptr);
  4893. auto guard = scope_exit([&]() { std::free(buf); });
  4894. if (buf == nullptr) { return false; }
  4895. resolved = buf;
  4896. #endif
  4897. return true;
  4898. }
  4899. inline bool is_path_within_base(const std::string &resolved_path,
  4900. const std::string &resolved_base) {
  4901. #if defined(_WIN32)
  4902. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4903. resolved_base.size()) == 0;
  4904. #else
  4905. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4906. resolved_base.size()) == 0;
  4907. #endif
  4908. }
  4909. inline FileStat::FileStat(const std::string &path) {
  4910. #if defined(_WIN32)
  4911. auto wpath = u8string_to_wstring(path.c_str());
  4912. ret_ = _wstat(wpath.c_str(), &st_);
  4913. #else
  4914. ret_ = stat(path.c_str(), &st_);
  4915. #endif
  4916. }
  4917. inline bool FileStat::is_file() const {
  4918. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4919. }
  4920. inline bool FileStat::is_dir() const {
  4921. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4922. }
  4923. inline time_t FileStat::mtime() const {
  4924. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4925. : static_cast<time_t>(-1);
  4926. }
  4927. inline size_t FileStat::size() const {
  4928. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4929. }
  4930. inline std::string encode_path(const std::string &s) {
  4931. std::string result;
  4932. result.reserve(s.size());
  4933. for (size_t i = 0; s[i]; i++) {
  4934. switch (s[i]) {
  4935. case ' ': result += "%20"; break;
  4936. case '+': result += "%2B"; break;
  4937. case '\'': result += "%27"; break;
  4938. case ',': result += "%2C"; break;
  4939. // case ':': result += "%3A"; break; // ok? probably...
  4940. case ';': result += "%3B"; break;
  4941. default:
  4942. auto c = static_cast<uint8_t>(s[i]);
  4943. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4944. // in a request-target as-is.
  4945. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4946. result += '%';
  4947. char hex[4];
  4948. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4949. assert(len == 2);
  4950. result.append(hex, static_cast<size_t>(len));
  4951. } else {
  4952. result += s[i];
  4953. }
  4954. break;
  4955. }
  4956. }
  4957. return result;
  4958. }
  4959. inline std::string file_extension(const std::string &path) {
  4960. auto i = path.size();
  4961. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  4962. i--;
  4963. }
  4964. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  4965. return std::string();
  4966. }
  4967. return path.substr(i);
  4968. }
  4969. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4970. template <typename T>
  4971. inline bool parse_header(const char *beg, const char *end, T fn);
  4972. template <typename T>
  4973. inline bool parse_header(const char *beg, const char *end, T fn) {
  4974. // Skip trailing spaces and tabs.
  4975. while (beg < end && is_space_or_tab(end[-1])) {
  4976. end--;
  4977. }
  4978. auto p = beg;
  4979. while (p < end && *p != ':') {
  4980. p++;
  4981. }
  4982. auto name = std::string(beg, p);
  4983. if (!detail::fields::is_field_name(name)) { return false; }
  4984. if (p == end) { return false; }
  4985. auto key_end = p;
  4986. if (*p++ != ':') { return false; }
  4987. while (p < end && is_space_or_tab(*p)) {
  4988. p++;
  4989. }
  4990. if (p <= end) {
  4991. auto key_len = key_end - beg;
  4992. if (!key_len) { return false; }
  4993. auto key = std::string(beg, key_end);
  4994. auto val = std::string(p, end);
  4995. if (!detail::fields::is_field_value(val)) { return false; }
  4996. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4997. // percent-decoded by the recipient. Applications that need to interpret a
  4998. // value as a URI component should call httplib::decode_uri_component()
  4999. // (or decode_path_component()) explicitly.
  5000. fn(key, val);
  5001. return true;
  5002. }
  5003. return false;
  5004. }
  5005. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5006. const Headers &src_headers) {
  5007. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5008. // transfer coding is complete when a chunk with a chunk-size of zero is
  5009. // received, possibly followed by a trailer section, and finally terminated by
  5010. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5011. //
  5012. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5013. // doesn't care for the existence of the final CRLF. In other words, it seems
  5014. // to be ok whether the final CRLF exists or not in the chunked data.
  5015. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5016. //
  5017. // According to the reference code in RFC 9112, cpp-httplib now allows
  5018. // chunked transfer coding data without the final CRLF.
  5019. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5020. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5021. "transfer-encoding",
  5022. "content-length",
  5023. "host",
  5024. "authorization",
  5025. "www-authenticate",
  5026. "proxy-authenticate",
  5027. "proxy-authorization",
  5028. "cookie",
  5029. "set-cookie",
  5030. "cache-control",
  5031. "expect",
  5032. "max-forwards",
  5033. "pragma",
  5034. "range",
  5035. "te",
  5036. "age",
  5037. "expires",
  5038. "date",
  5039. "location",
  5040. "retry-after",
  5041. "vary",
  5042. "warning",
  5043. "content-encoding",
  5044. "content-type",
  5045. "content-range",
  5046. "trailer"};
  5047. case_ignore::unordered_set<std::string> declared_trailers;
  5048. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5049. if (!trailer_header.empty()) {
  5050. // split() trims each token and skips empty ones, so the name arrives ready
  5051. // to look up.
  5052. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5053. ',', [&](const char *b, const char *e) {
  5054. // A legitimate message declares only a handful of trailers. Cap the
  5055. // set so a peer cannot grow it without bound: an oversized set only
  5056. // arises from an attempt to force many colliding names into
  5057. // quadratic lookups (case_ignore::hash is unkeyed).
  5058. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5059. return;
  5060. }
  5061. std::string key(b, e);
  5062. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5063. declared_trailers.insert(key);
  5064. }
  5065. });
  5066. }
  5067. size_t trailer_header_count = 0;
  5068. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5069. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5070. // Count every received trailer field, not only the declared ones stored in
  5071. // dest, so undeclared fields cannot keep this loop running past the limit.
  5072. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5073. constexpr auto line_terminator_len = 2;
  5074. auto line_beg = line_reader.ptr();
  5075. auto line_end =
  5076. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5077. if (!parse_header(line_beg, line_end,
  5078. [&](const std::string &key, const std::string &val) {
  5079. if (declared_trailers.find(key) !=
  5080. declared_trailers.end()) {
  5081. dest.emplace(key, val);
  5082. }
  5083. })) {
  5084. return false;
  5085. }
  5086. trailer_header_count++;
  5087. if (!line_reader.getline()) { return false; }
  5088. }
  5089. return true;
  5090. }
  5091. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5092. size_t right) {
  5093. while (b + left < e && is_space_or_tab(b[left])) {
  5094. left++;
  5095. }
  5096. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5097. right--;
  5098. }
  5099. return std::make_pair(left, right);
  5100. }
  5101. inline std::string trim_copy(const std::string &s) {
  5102. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5103. return s.substr(r.first, r.second - r.first);
  5104. }
  5105. inline std::string trim_double_quotes_copy(const std::string &s) {
  5106. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5107. return s.substr(1, s.size() - 2);
  5108. }
  5109. return s;
  5110. }
  5111. inline void
  5112. divide(const char *data, std::size_t size, char d,
  5113. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5114. fn) {
  5115. const auto it = std::find(data, data + size, d);
  5116. const auto found = static_cast<std::size_t>(it != data + size);
  5117. const auto lhs_data = data;
  5118. const auto lhs_size = static_cast<std::size_t>(it - data);
  5119. const auto rhs_data = it + found;
  5120. const auto rhs_size = size - lhs_size - found;
  5121. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5122. }
  5123. inline void
  5124. divide(const std::string &str, char d,
  5125. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5126. fn) {
  5127. divide(str.data(), str.size(), d, std::move(fn));
  5128. }
  5129. inline void split(const char *b, const char *e, char d,
  5130. std::function<void(const char *, const char *)> fn) {
  5131. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5132. }
  5133. inline void split(const char *b, const char *e, char d, size_t m,
  5134. std::function<void(const char *, const char *)> fn) {
  5135. size_t i = 0;
  5136. size_t beg = 0;
  5137. size_t count = 1;
  5138. while (e ? (b + i < e) : (b[i] != '\0')) {
  5139. if (b[i] == d && count < m) {
  5140. auto r = trim(b, e, beg, i);
  5141. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5142. beg = i + 1;
  5143. count++;
  5144. }
  5145. i++;
  5146. }
  5147. if (i) {
  5148. auto r = trim(b, e, beg, i);
  5149. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5150. }
  5151. }
  5152. // Same contract as split(), except that a delimiter inside a quoted-string is
  5153. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5154. // quoted-string, and ';' and '=' are legal characters inside one.
  5155. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5156. std::function<void(const char *, const char *)> fn) {
  5157. size_t i = 0;
  5158. size_t beg = 0;
  5159. size_t count = 1;
  5160. auto in_quotes = false;
  5161. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5162. while (has(i)) {
  5163. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5164. // A quoted-pair, whose second character does not end the string.
  5165. i++;
  5166. } else if (b[i] == '"') {
  5167. in_quotes = !in_quotes;
  5168. } else if (b[i] == d && !in_quotes && count < m) {
  5169. auto r = trim(b, e, beg, i);
  5170. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5171. beg = i + 1;
  5172. count++;
  5173. }
  5174. i++;
  5175. }
  5176. if (i) {
  5177. auto r = trim(b, e, beg, i);
  5178. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5179. }
  5180. }
  5181. inline void split_unquoted(const char *b, const char *e, char d,
  5182. std::function<void(const char *, const char *)> fn) {
  5183. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5184. std::move(fn));
  5185. }
  5186. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5187. // key a token, so the first '=' is the separator even when the value is a
  5188. // quoted-string carrying more of them.
  5189. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5190. std::string &val) {
  5191. divide(
  5192. b, static_cast<std::size_t>(e - b), '=',
  5193. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5194. const auto kr = trim(kb, kb + klen, 0, klen);
  5195. key.assign(kb + kr.first, kb + kr.second);
  5196. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5197. val.assign(vb + vr.first, vb + vr.second);
  5198. });
  5199. }
  5200. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5201. std::function<bool(const char *, const char *)> fn) {
  5202. size_t i = 0;
  5203. size_t beg = 0;
  5204. size_t count = 1;
  5205. while (e ? (b + i < e) : (b[i] != '\0')) {
  5206. if (b[i] == d && count < m) {
  5207. auto r = trim(b, e, beg, i);
  5208. if (r.first < r.second) {
  5209. auto found = fn(&b[r.first], &b[r.second]);
  5210. if (found) { return true; }
  5211. }
  5212. beg = i + 1;
  5213. count++;
  5214. }
  5215. i++;
  5216. }
  5217. if (i) {
  5218. auto r = trim(b, e, beg, i);
  5219. if (r.first < r.second) {
  5220. auto found = fn(&b[r.first], &b[r.second]);
  5221. if (found) { return true; }
  5222. }
  5223. }
  5224. return false;
  5225. }
  5226. inline bool split_find(const char *b, const char *e, char d,
  5227. std::function<bool(const char *, const char *)> fn) {
  5228. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5229. std::move(fn));
  5230. }
  5231. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5232. size_t fixed_buffer_size)
  5233. : strm_(strm), fixed_buffer_(fixed_buffer),
  5234. fixed_buffer_size_(fixed_buffer_size) {}
  5235. inline const char *stream_line_reader::ptr() const {
  5236. if (growable_buffer_.empty()) {
  5237. return fixed_buffer_;
  5238. } else {
  5239. return growable_buffer_.data();
  5240. }
  5241. }
  5242. inline size_t stream_line_reader::size() const {
  5243. if (growable_buffer_.empty()) {
  5244. return fixed_buffer_used_size_;
  5245. } else {
  5246. return growable_buffer_.size();
  5247. }
  5248. }
  5249. inline bool stream_line_reader::end_with_crlf() const {
  5250. auto end = ptr() + size();
  5251. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5252. }
  5253. inline bool stream_line_reader::getline() {
  5254. fixed_buffer_used_size_ = 0;
  5255. growable_buffer_.clear();
  5256. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5257. char prev_byte = 0;
  5258. #endif
  5259. for (size_t i = 0;; i++) {
  5260. // Fast path: whatever the stream has already buffered can be scanned for
  5261. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5262. // call, a bounds check and a one-byte copy per character of the request.
  5263. size_t buffered_size = 0;
  5264. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5265. auto take = buffered_size;
  5266. auto terminated = false;
  5267. for (size_t at = 0; at < buffered_size;) {
  5268. auto nl = static_cast<const char *>(
  5269. memchr(buffered + at, '\n', buffered_size - at));
  5270. if (!nl) { break; }
  5271. auto pos = static_cast<size_t>(nl - buffered);
  5272. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5273. take = pos + 1;
  5274. terminated = true;
  5275. break;
  5276. #else
  5277. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5278. // be the last byte of an earlier chunk, hence prev_byte.
  5279. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5280. take = pos + 1;
  5281. terminated = true;
  5282. break;
  5283. }
  5284. at = pos + 1;
  5285. #endif
  5286. }
  5287. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5288. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5289. prev_byte = buffered[take - 1];
  5290. #endif
  5291. append(buffered, take);
  5292. strm_.consume_buffered(take);
  5293. i += take;
  5294. if (terminated) { return true; }
  5295. continue;
  5296. }
  5297. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5298. // Treat exceptionally long lines as an error to
  5299. // prevent infinite loops/memory exhaustion
  5300. return false;
  5301. }
  5302. char byte;
  5303. auto n = strm_.read(&byte, 1);
  5304. if (n < 0) {
  5305. return false;
  5306. } else if (n == 0) {
  5307. if (i == 0) {
  5308. return false;
  5309. } else {
  5310. break;
  5311. }
  5312. }
  5313. append(byte);
  5314. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5315. if (byte == '\n') { break; }
  5316. #else
  5317. if (prev_byte == '\r' && byte == '\n') { break; }
  5318. prev_byte = byte;
  5319. #endif
  5320. }
  5321. return true;
  5322. }
  5323. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5324. inline void stream_line_reader::append(const char *data, size_t size) {
  5325. // Once the line has outgrown the fixed buffer everything must keep going to
  5326. // the growable one, even if a later chunk would have fit. Without the
  5327. // emptiness check a short append after a long one would land in the fixed
  5328. // buffer, which ptr() and size() no longer look at, and be lost.
  5329. if (growable_buffer_.empty() &&
  5330. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5331. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5332. fixed_buffer_used_size_ += size;
  5333. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5334. } else {
  5335. // Unlike the per-character overload, this can be the very first append of
  5336. // the line, so the fixed buffer may hold nothing and carry no terminator
  5337. // yet. assign() takes an explicit length and does not need one.
  5338. if (growable_buffer_.empty()) {
  5339. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5340. }
  5341. growable_buffer_.append(data, size);
  5342. }
  5343. }
  5344. inline mmap::mmap(const char *path) { open(path); }
  5345. inline mmap::~mmap() { close(); }
  5346. inline bool mmap::open(const char *path) {
  5347. close();
  5348. #if defined(_WIN32)
  5349. auto wpath = u8string_to_wstring(path);
  5350. if (wpath.empty()) { return false; }
  5351. hFile_ =
  5352. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5353. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5354. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5355. LARGE_INTEGER size{};
  5356. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5357. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5358. // See:
  5359. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5360. if (static_cast<ULONGLONG>(size.QuadPart) >
  5361. (std::numeric_limits<decltype(size_)>::max)()) {
  5362. // `size_t` might be 32-bits, on 32-bits Windows.
  5363. return false;
  5364. }
  5365. size_ = static_cast<size_t>(size.QuadPart);
  5366. hMapping_ =
  5367. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5368. // Special treatment for an empty file...
  5369. if (hMapping_ == NULL && size_ == 0) {
  5370. close();
  5371. is_open_empty_file = true;
  5372. return true;
  5373. }
  5374. if (hMapping_ == NULL) {
  5375. close();
  5376. return false;
  5377. }
  5378. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5379. if (addr_ == nullptr) {
  5380. close();
  5381. return false;
  5382. }
  5383. #else
  5384. fd_ = ::open(path, O_RDONLY);
  5385. if (fd_ == -1) { return false; }
  5386. struct stat sb;
  5387. if (fstat(fd_, &sb) == -1) {
  5388. close();
  5389. return false;
  5390. }
  5391. size_ = static_cast<size_t>(sb.st_size);
  5392. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5393. // Special treatment for an empty file...
  5394. if (addr_ == MAP_FAILED && size_ == 0) {
  5395. close();
  5396. is_open_empty_file = true;
  5397. return false;
  5398. }
  5399. if (addr_ == MAP_FAILED) {
  5400. // Clear the sentinel before `close()`, since `is_open()` only checks
  5401. // `addr_` against nullptr and `munmap()` must not be called with it.
  5402. addr_ = nullptr;
  5403. close();
  5404. return false;
  5405. }
  5406. #endif
  5407. return true;
  5408. }
  5409. inline bool mmap::is_open() const {
  5410. return is_open_empty_file ? true : addr_ != nullptr;
  5411. }
  5412. inline size_t mmap::size() const { return size_; }
  5413. inline const char *mmap::data() const {
  5414. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5415. }
  5416. inline void mmap::close() {
  5417. #if defined(_WIN32)
  5418. if (addr_) {
  5419. ::UnmapViewOfFile(addr_);
  5420. addr_ = nullptr;
  5421. }
  5422. if (hMapping_) {
  5423. ::CloseHandle(hMapping_);
  5424. hMapping_ = NULL;
  5425. }
  5426. if (hFile_ != INVALID_HANDLE_VALUE) {
  5427. ::CloseHandle(hFile_);
  5428. hFile_ = INVALID_HANDLE_VALUE;
  5429. }
  5430. is_open_empty_file = false;
  5431. #else
  5432. if (addr_ != nullptr) {
  5433. munmap(addr_, size_);
  5434. addr_ = nullptr;
  5435. }
  5436. if (fd_ != -1) {
  5437. ::close(fd_);
  5438. fd_ = -1;
  5439. }
  5440. #endif
  5441. size_ = 0;
  5442. }
  5443. inline int close_socket(socket_t sock) noexcept {
  5444. #ifdef _WIN32
  5445. return closesocket(sock);
  5446. #else
  5447. return close(sock);
  5448. #endif
  5449. }
  5450. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5451. ssize_t res = 0;
  5452. while (true) {
  5453. res = fn();
  5454. if (res < 0 && errno == EINTR) {
  5455. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5456. continue;
  5457. }
  5458. break;
  5459. }
  5460. return res;
  5461. }
  5462. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5463. return handle_EINTR([&]() {
  5464. return recv(sock,
  5465. #ifdef _WIN32
  5466. static_cast<char *>(ptr), static_cast<int>(size),
  5467. #else
  5468. ptr, size,
  5469. #endif
  5470. flags);
  5471. });
  5472. }
  5473. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5474. int flags) {
  5475. return handle_EINTR([&]() {
  5476. return send(sock,
  5477. #ifdef _WIN32
  5478. static_cast<const char *>(ptr), static_cast<int>(size),
  5479. #else
  5480. ptr, size,
  5481. #endif
  5482. flags);
  5483. });
  5484. }
  5485. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5486. #ifdef _WIN32
  5487. return ::WSAPoll(fds, nfds, timeout);
  5488. #else
  5489. return ::poll(fds, nfds, timeout);
  5490. #endif
  5491. }
  5492. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5493. time_t usec) {
  5494. struct pollfd pfd;
  5495. pfd.fd = sock;
  5496. pfd.events = events;
  5497. pfd.revents = 0;
  5498. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5499. // "return immediately", which callers here rely on to probe a socket.
  5500. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5501. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5502. }
  5503. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5504. return select_impl(sock, POLLIN, sec, usec);
  5505. }
  5506. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5507. return select_impl(sock, POLLOUT, sec, usec);
  5508. }
  5509. // The point sec and usec from now, for select_until(). A negative sec never
  5510. // comes, as a negative timeout waits forever in select_impl().
  5511. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5512. time_t usec) {
  5513. if (sec < 0) { return std::chrono::steady_clock::time_point::max(); }
  5514. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5515. std::chrono::microseconds(usec);
  5516. }
  5517. // Waits only for the time left until deadline, so that all the waits of one
  5518. // TLS handshake come out of a single timeout.
  5519. inline ssize_t select_until(socket_t sock, short events,
  5520. std::chrono::steady_clock::time_point deadline) {
  5521. if (deadline == std::chrono::steady_clock::time_point::max()) {
  5522. return select_impl(sock, events, -1, 0);
  5523. }
  5524. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5525. deadline - std::chrono::steady_clock::now())
  5526. .count();
  5527. if (left <= 0) { return 0; }
  5528. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5529. static_cast<time_t>(left % 1000000));
  5530. }
  5531. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5532. time_t usec) {
  5533. struct pollfd pfd_read;
  5534. pfd_read.fd = sock;
  5535. pfd_read.events = POLLIN | POLLOUT;
  5536. pfd_read.revents = 0;
  5537. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5538. auto poll_res =
  5539. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5540. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5541. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5542. auto error = 0;
  5543. socklen_t len = sizeof(error);
  5544. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5545. reinterpret_cast<char *>(&error), &len);
  5546. auto successful = res >= 0 && !error;
  5547. return successful ? Error::Success : Error::Connection;
  5548. }
  5549. return Error::Connection;
  5550. }
  5551. inline bool is_socket_alive(socket_t sock) {
  5552. const auto val = detail::select_read(sock, 0, 0);
  5553. if (val == 0) {
  5554. return true;
  5555. } else if (val < 0 && errno == EBADF) {
  5556. return false;
  5557. }
  5558. char buf[1];
  5559. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5560. }
  5561. class SocketStream final : public Stream {
  5562. public:
  5563. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5564. time_t write_timeout_sec, time_t write_timeout_usec,
  5565. time_t max_timeout_msec = 0,
  5566. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5567. (std::chrono::steady_clock::time_point::min)());
  5568. ~SocketStream() override;
  5569. bool is_readable() const override;
  5570. bool wait_readable() const override;
  5571. bool wait_writable() const override;
  5572. bool is_peer_alive() const override;
  5573. ssize_t read(char *ptr, size_t size) override;
  5574. ssize_t write(const char *ptr, size_t size) override;
  5575. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5576. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5577. socket_t socket() const override;
  5578. time_t duration() const override;
  5579. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5580. const char *buffered_data(size_t &size) const override;
  5581. void consume_buffered(size_t size) override;
  5582. // The caller has just seen this socket become readable. Lets the next read
  5583. // skip its own readiness wait, which would otherwise ask the kernel a
  5584. // question that was answered a moment ago. Consumed by that read.
  5585. void set_readable_hint() { readable_hint_ = true; }
  5586. private:
  5587. bool ensure_readable();
  5588. socket_t sock_;
  5589. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5590. // thread while a read is in flight -- that is the point of it, for a caller
  5591. // holding one connection and wanting control back to send on it.
  5592. std::atomic<time_t> read_timeout_sec_;
  5593. std::atomic<time_t> read_timeout_usec_;
  5594. time_t write_timeout_sec_;
  5595. time_t write_timeout_usec_;
  5596. time_t max_timeout_msec_;
  5597. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5598. std::vector<char> read_buff_;
  5599. size_t read_buff_off_ = 0;
  5600. size_t read_buff_content_size_ = 0;
  5601. bool readable_hint_ = false;
  5602. static const size_t read_buff_size_ = 1024l * 4;
  5603. };
  5604. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5605. time_t keep_alive_timeout_sec) {
  5606. using namespace std::chrono;
  5607. const auto interval_usec =
  5608. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5609. // Avoid expensive `steady_clock::now()` call for the first time
  5610. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5611. const auto start = steady_clock::now() - microseconds{interval_usec};
  5612. const auto timeout = seconds{keep_alive_timeout_sec};
  5613. while (true) {
  5614. if (svr_sock == INVALID_SOCKET) {
  5615. break; // Server socket is closed
  5616. }
  5617. auto val = select_read(sock, 0, interval_usec);
  5618. if (val < 0) {
  5619. break; // Ssocket error
  5620. } else if (val == 0) {
  5621. if (steady_clock::now() - start > timeout) {
  5622. break; // Timeout
  5623. }
  5624. } else {
  5625. return true; // Ready for read
  5626. }
  5627. }
  5628. return false;
  5629. }
  5630. // `has_buffered_request` reports whether the connection's stream already holds
  5631. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5632. // 9.3.2), so reading one request can pull the start of the next one into the
  5633. // stream's buffer; that request must be served without waiting for the socket
  5634. // to become readable again, since its bytes are no longer on the socket.
  5635. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5636. template <typename P, typename T>
  5637. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5638. socket_t sock,
  5639. size_t keep_alive_max_count,
  5640. time_t keep_alive_timeout_sec,
  5641. P has_buffered_request, T callback) {
  5642. assert(keep_alive_max_count > 0);
  5643. auto ret = false;
  5644. auto count = keep_alive_max_count;
  5645. while (count > 0) {
  5646. auto socket_readable = false;
  5647. if (!has_buffered_request()) {
  5648. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5649. socket_readable = true;
  5650. }
  5651. auto close_connection = count == 1;
  5652. auto connection_closed = false;
  5653. ret = callback(socket_readable, close_connection, connection_closed);
  5654. if (!ret || connection_closed) { break; }
  5655. count--;
  5656. }
  5657. return ret;
  5658. }
  5659. template <typename T>
  5660. inline bool
  5661. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5662. size_t keep_alive_max_count,
  5663. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5664. time_t read_timeout_usec, time_t write_timeout_sec,
  5665. time_t write_timeout_usec, T callback) {
  5666. // One stream per connection: its read buffer can already hold the start of
  5667. // the next, pipelined request.
  5668. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5669. write_timeout_sec, write_timeout_usec);
  5670. return process_server_socket_core(
  5671. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5672. [&]() { return strm.is_readable(); },
  5673. [&](bool socket_readable, bool close_connection,
  5674. bool &connection_closed) {
  5675. if (socket_readable) { strm.set_readable_hint(); }
  5676. return callback(strm, close_connection, connection_closed);
  5677. });
  5678. }
  5679. inline bool process_client_socket(
  5680. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5681. time_t write_timeout_sec, time_t write_timeout_usec,
  5682. time_t max_timeout_msec,
  5683. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5684. std::function<bool(Stream &)> callback) {
  5685. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5686. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5687. start_time);
  5688. return callback(strm);
  5689. }
  5690. inline int shutdown_socket(socket_t sock) noexcept {
  5691. #ifdef _WIN32
  5692. return shutdown(sock, SD_BOTH);
  5693. #else
  5694. return shutdown(sock, SHUT_RDWR);
  5695. #endif
  5696. }
  5697. // Half-closes the write side and drains any in-flight/queued bytes before
  5698. // the final shutdown+close. Closing with unread data in the receive queue
  5699. // (or bytes arriving after the receive side is closed) makes the stack send
  5700. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5701. // response as a failed read even though it was fully written.
  5702. inline void drain_and_close_socket(socket_t sock) noexcept {
  5703. #ifdef _WIN32
  5704. shutdown(sock, SD_SEND);
  5705. #else
  5706. shutdown(sock, SHUT_WR);
  5707. #endif
  5708. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5709. size_t total = 0;
  5710. const auto deadline = std::chrono::steady_clock::now() +
  5711. std::chrono::milliseconds(100); // bound #1
  5712. while (total < size_t(1024u * 1024u)) { // bound #2
  5713. const auto remaining =
  5714. std::chrono::duration_cast<std::chrono::microseconds>(
  5715. deadline - std::chrono::steady_clock::now())
  5716. .count();
  5717. if (remaining <= 0) { break; }
  5718. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5719. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5720. if (n <= 0) { break; }
  5721. total += static_cast<size_t>(n);
  5722. }
  5723. shutdown_socket(sock);
  5724. close_socket(sock);
  5725. }
  5726. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5727. if (s.size() > 1 && s[0] == '\0') {
  5728. auto ret = s;
  5729. ret[0] = '@';
  5730. return ret;
  5731. }
  5732. return s;
  5733. }
  5734. inline std::string
  5735. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5736. if (s.size() > 1 && s[0] == '@') {
  5737. auto ret = s;
  5738. ret[0] = '\0';
  5739. return ret;
  5740. }
  5741. return s;
  5742. }
  5743. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5744. const struct addrinfo *hints,
  5745. struct addrinfo **res, time_t timeout_sec) {
  5746. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5747. if (timeout_sec <= 0) {
  5748. // No timeout specified, use standard getaddrinfo
  5749. return getaddrinfo(node, service, hints, res);
  5750. }
  5751. #ifdef _WIN32
  5752. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5753. OVERLAPPED overlapped = {};
  5754. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5755. if (!event) { return EAI_FAIL; }
  5756. overlapped.hEvent = event;
  5757. PADDRINFOEXW result_addrinfo = nullptr;
  5758. HANDLE cancel_handle = nullptr;
  5759. ADDRINFOEXW hints_ex = {};
  5760. if (hints) {
  5761. hints_ex.ai_flags = hints->ai_flags;
  5762. hints_ex.ai_family = hints->ai_family;
  5763. hints_ex.ai_socktype = hints->ai_socktype;
  5764. hints_ex.ai_protocol = hints->ai_protocol;
  5765. }
  5766. auto wnode = u8string_to_wstring(node);
  5767. auto wservice = u8string_to_wstring(service);
  5768. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5769. hints ? &hints_ex : nullptr, &result_addrinfo,
  5770. nullptr, &overlapped, nullptr, &cancel_handle);
  5771. if (ret == WSA_IO_PENDING) {
  5772. auto wait_result =
  5773. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5774. if (wait_result == WAIT_TIMEOUT) {
  5775. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5776. ::CloseHandle(event);
  5777. return EAI_AGAIN;
  5778. }
  5779. DWORD bytes_returned;
  5780. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5781. &bytes_returned, FALSE)) {
  5782. ::CloseHandle(event);
  5783. return ::WSAGetLastError();
  5784. }
  5785. }
  5786. ::CloseHandle(event);
  5787. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5788. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5789. return 0;
  5790. }
  5791. return ret;
  5792. #elif TARGET_OS_MAC && defined(__clang__)
  5793. if (!node) { return EAI_NONAME; }
  5794. // macOS implementation using CFHost API for asynchronous DNS resolution
  5795. CFStringRef hostname_ref = CFStringCreateWithCString(
  5796. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5797. if (!hostname_ref) { return EAI_MEMORY; }
  5798. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5799. CFRelease(hostname_ref);
  5800. if (!host_ref) { return EAI_MEMORY; }
  5801. // Set up context for callback
  5802. struct CFHostContext {
  5803. bool completed = false;
  5804. bool success = false;
  5805. CFArrayRef addresses = nullptr;
  5806. std::mutex mutex;
  5807. std::condition_variable cv;
  5808. } context;
  5809. CFHostClientContext client_context;
  5810. memset(&client_context, 0, sizeof(client_context));
  5811. client_context.info = &context;
  5812. // Set callback
  5813. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5814. const CFStreamError *error, void *info) {
  5815. auto ctx = static_cast<CFHostContext *>(info);
  5816. std::lock_guard<std::mutex> lock(ctx->mutex);
  5817. if (error && error->error != 0) {
  5818. ctx->success = false;
  5819. } else {
  5820. Boolean hasBeenResolved;
  5821. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5822. if (ctx->addresses && hasBeenResolved) {
  5823. CFRetain(ctx->addresses);
  5824. ctx->success = true;
  5825. } else {
  5826. ctx->success = false;
  5827. }
  5828. }
  5829. ctx->completed = true;
  5830. ctx->cv.notify_one();
  5831. };
  5832. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5833. CFRelease(host_ref);
  5834. return EAI_SYSTEM;
  5835. }
  5836. // Schedule on run loop
  5837. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5838. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5839. // Start resolution
  5840. CFStreamError stream_error;
  5841. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5842. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5843. CFRelease(host_ref);
  5844. return EAI_FAIL;
  5845. }
  5846. // Wait for completion with timeout
  5847. auto timeout_time =
  5848. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5849. bool timed_out = false;
  5850. {
  5851. std::unique_lock<std::mutex> lock(context.mutex);
  5852. while (!context.completed) {
  5853. auto now = std::chrono::steady_clock::now();
  5854. if (now >= timeout_time) {
  5855. timed_out = true;
  5856. break;
  5857. }
  5858. // Run the runloop for a short time
  5859. lock.unlock();
  5860. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5861. lock.lock();
  5862. }
  5863. }
  5864. // Clean up
  5865. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5866. CFHostSetClient(host_ref, nullptr, nullptr);
  5867. if (timed_out || !context.completed) {
  5868. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5869. CFRelease(host_ref);
  5870. return EAI_AGAIN;
  5871. }
  5872. if (!context.success || !context.addresses) {
  5873. CFRelease(host_ref);
  5874. return EAI_NODATA;
  5875. }
  5876. // Convert CFArray to addrinfo
  5877. CFIndex count = CFArrayGetCount(context.addresses);
  5878. if (count == 0) {
  5879. CFRelease(context.addresses);
  5880. CFRelease(host_ref);
  5881. return EAI_NODATA;
  5882. }
  5883. struct addrinfo *result_addrinfo = nullptr;
  5884. struct addrinfo **current = &result_addrinfo;
  5885. for (CFIndex i = 0; i < count; i++) {
  5886. CFDataRef addr_data =
  5887. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5888. if (!addr_data) continue;
  5889. const struct sockaddr *sockaddr_ptr =
  5890. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5891. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5892. // Allocate addrinfo structure
  5893. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5894. if (!*current) {
  5895. freeaddrinfo(result_addrinfo);
  5896. CFRelease(context.addresses);
  5897. CFRelease(host_ref);
  5898. return EAI_MEMORY;
  5899. }
  5900. memset(*current, 0, sizeof(struct addrinfo));
  5901. // Set up addrinfo fields
  5902. (*current)->ai_family = sockaddr_ptr->sa_family;
  5903. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5904. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5905. (*current)->ai_addrlen = sockaddr_len;
  5906. // Copy sockaddr
  5907. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5908. if (!(*current)->ai_addr) {
  5909. freeaddrinfo(result_addrinfo);
  5910. CFRelease(context.addresses);
  5911. CFRelease(host_ref);
  5912. return EAI_MEMORY;
  5913. }
  5914. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5915. // Set port if service is specified
  5916. if (service && *service) {
  5917. int port = 0;
  5918. if (parse_port(service, strlen(service), port)) {
  5919. if (sockaddr_ptr->sa_family == AF_INET) {
  5920. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5921. ->sin_port = htons(static_cast<uint16_t>(port));
  5922. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5923. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5924. ->sin6_port = htons(static_cast<uint16_t>(port));
  5925. }
  5926. }
  5927. }
  5928. current = &((*current)->ai_next);
  5929. }
  5930. CFRelease(context.addresses);
  5931. CFRelease(host_ref);
  5932. *res = result_addrinfo;
  5933. return 0;
  5934. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5935. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  5936. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  5937. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  5938. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5939. // the resolver worker still references the stack-local gaicb. The cancel
  5940. // path therefore waits (gai_suspend with no timeout) for the worker to
  5941. // actually finish before letting the stack frame go. The trade-off is that
  5942. // a wedged DNS server can hold this thread for the system resolver timeout
  5943. // (~30s by default) past the caller's connection timeout.
  5944. struct gaicb request{};
  5945. struct gaicb *requests[1] = {&request};
  5946. struct sigevent sevp{};
  5947. struct timespec timeout{timeout_sec, 0};
  5948. request.ar_name = node;
  5949. request.ar_service = service;
  5950. request.ar_request = hints;
  5951. sevp.sigev_notify = SIGEV_NONE;
  5952. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5953. if (rc != 0) { return rc; }
  5954. auto cleanup = scope_exit([&] {
  5955. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5956. });
  5957. int wait_result = gai_suspend(requests, 1, &timeout);
  5958. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5959. int gai_result = gai_error(&request);
  5960. if (gai_result == 0) {
  5961. *res = request.ar_result;
  5962. request.ar_result = nullptr;
  5963. return 0;
  5964. }
  5965. return gai_result;
  5966. }
  5967. gai_cancel(&request);
  5968. while (gai_error(&request) == EAI_INPROGRESS) {
  5969. gai_suspend(requests, 1, nullptr);
  5970. }
  5971. return wait_result;
  5972. #else
  5973. // Fallback implementation using thread-based timeout for other Unix systems.
  5974. struct GetAddrInfoState {
  5975. ~GetAddrInfoState() {
  5976. if (info) { freeaddrinfo(info); }
  5977. }
  5978. std::mutex mutex;
  5979. std::condition_variable result_cv;
  5980. bool completed = false;
  5981. int result = EAI_SYSTEM;
  5982. std::string node;
  5983. std::string service;
  5984. struct addrinfo hints;
  5985. struct addrinfo *info = nullptr;
  5986. };
  5987. // Allocate on the heap, so the resolver thread can keep using the data.
  5988. auto state = std::make_shared<GetAddrInfoState>();
  5989. if (node) { state->node = node; }
  5990. state->service = service;
  5991. state->hints = *hints;
  5992. std::thread resolve_thread([state]() {
  5993. auto thread_result =
  5994. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5995. &state->info);
  5996. std::lock_guard<std::mutex> lock(state->mutex);
  5997. state->result = thread_result;
  5998. state->completed = true;
  5999. state->result_cv.notify_one();
  6000. });
  6001. // Wait for completion or timeout
  6002. std::unique_lock<std::mutex> lock(state->mutex);
  6003. auto finished =
  6004. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6005. [&] { return state->completed; });
  6006. if (finished) {
  6007. // Operation completed within timeout
  6008. resolve_thread.join();
  6009. *res = state->info;
  6010. state->info = nullptr; // Pass ownership to caller
  6011. return state->result;
  6012. } else {
  6013. // Timeout occurred
  6014. resolve_thread.detach(); // Let the thread finish in background
  6015. return EAI_AGAIN; // Return timeout error
  6016. }
  6017. #endif
  6018. #else
  6019. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6020. return getaddrinfo(node, service, hints, res);
  6021. #endif
  6022. }
  6023. template <typename BindOrConnect>
  6024. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6025. int address_family, int socket_flags, bool tcp_nodelay,
  6026. bool ipv6_v6only, SocketOptions socket_options,
  6027. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6028. // Get address info
  6029. const char *node = nullptr;
  6030. struct addrinfo hints;
  6031. struct addrinfo *result;
  6032. memset(&hints, 0, sizeof(struct addrinfo));
  6033. hints.ai_socktype = SOCK_STREAM;
  6034. hints.ai_protocol = IPPROTO_IP;
  6035. if (!ip.empty()) {
  6036. node = ip.c_str();
  6037. // Ask getaddrinfo to convert IP in c-string to address
  6038. hints.ai_family = AF_UNSPEC;
  6039. hints.ai_flags = AI_NUMERICHOST;
  6040. } else {
  6041. if (!host.empty()) { node = host.c_str(); }
  6042. hints.ai_family = address_family;
  6043. hints.ai_flags = socket_flags;
  6044. }
  6045. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6046. if (hints.ai_family == AF_UNIX) {
  6047. const auto addrlen = host.length();
  6048. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6049. #ifdef SOCK_CLOEXEC
  6050. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6051. hints.ai_protocol);
  6052. #else
  6053. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6054. #endif
  6055. if (sock != INVALID_SOCKET) {
  6056. sockaddr_un addr{};
  6057. addr.sun_family = AF_UNIX;
  6058. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6059. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6060. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6061. hints.ai_addrlen = static_cast<socklen_t>(
  6062. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6063. #ifndef SOCK_CLOEXEC
  6064. #ifndef _WIN32
  6065. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6066. #endif
  6067. #endif
  6068. if (socket_options) { socket_options(sock); }
  6069. #ifdef _WIN32
  6070. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6071. // remove the option.
  6072. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6073. #endif
  6074. bool dummy;
  6075. if (!bind_or_connect(sock, hints, dummy)) {
  6076. close_socket(sock);
  6077. sock = INVALID_SOCKET;
  6078. }
  6079. }
  6080. return sock;
  6081. }
  6082. #endif
  6083. auto service = std::to_string(port);
  6084. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6085. timeout_sec)) {
  6086. #if defined __linux__ && !defined __ANDROID__
  6087. res_init();
  6088. #endif
  6089. return INVALID_SOCKET;
  6090. }
  6091. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6092. for (auto rp = result; rp; rp = rp->ai_next) {
  6093. // Create a socket
  6094. #ifdef _WIN32
  6095. auto sock =
  6096. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6097. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6098. /**
  6099. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6100. * and above the socket creation fails on older Windows Systems.
  6101. *
  6102. * Let's try to create a socket the old way in this case.
  6103. *
  6104. * Reference:
  6105. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6106. *
  6107. * WSA_FLAG_NO_HANDLE_INHERIT:
  6108. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6109. * SP1, and later
  6110. *
  6111. */
  6112. if (sock == INVALID_SOCKET) {
  6113. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6114. }
  6115. #else
  6116. #ifdef SOCK_CLOEXEC
  6117. auto sock =
  6118. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6119. #else
  6120. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6121. #endif
  6122. #endif
  6123. if (sock == INVALID_SOCKET) { continue; }
  6124. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6125. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6126. close_socket(sock);
  6127. continue;
  6128. }
  6129. #endif
  6130. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6131. if (rp->ai_family == AF_INET6) {
  6132. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6133. }
  6134. if (socket_options) { socket_options(sock); }
  6135. // bind or connect
  6136. auto quit = false;
  6137. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6138. close_socket(sock);
  6139. if (quit) { break; }
  6140. }
  6141. return INVALID_SOCKET;
  6142. }
  6143. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6144. #ifdef _WIN32
  6145. auto flags = nonblocking ? 1UL : 0UL;
  6146. ioctlsocket(sock, FIONBIO, &flags);
  6147. #else
  6148. auto flags = fcntl(sock, F_GETFL, 0);
  6149. fcntl(sock, F_SETFL,
  6150. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6151. #endif
  6152. }
  6153. inline bool is_connection_error() {
  6154. #ifdef _WIN32
  6155. return WSAGetLastError() != WSAEWOULDBLOCK;
  6156. #else
  6157. return errno != EINPROGRESS;
  6158. #endif
  6159. }
  6160. // accept() failed because the process or the network stack is temporarily out
  6161. // of resources. The listening socket is still usable, so back off briefly and
  6162. // try again.
  6163. inline bool is_accept_resource_error() {
  6164. #ifdef _WIN32
  6165. auto err = WSAGetLastError();
  6166. return err == WSAEMFILE || err == WSAENOBUFS;
  6167. #else
  6168. auto err = errno;
  6169. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6170. #endif
  6171. }
  6172. // accept() failed for a reason that says nothing about the listening socket:
  6173. // the pending connection went away before it could be accepted, or the call
  6174. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6175. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6176. // connection that way.
  6177. inline bool is_accept_transient_error() {
  6178. #ifdef _WIN32
  6179. auto err = WSAGetLastError();
  6180. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6181. err == WSAECONNABORTED;
  6182. #else
  6183. auto err = errno;
  6184. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6185. err == ECONNABORTED;
  6186. #endif
  6187. }
  6188. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6189. struct addrinfo hints;
  6190. struct addrinfo *result;
  6191. memset(&hints, 0, sizeof(struct addrinfo));
  6192. hints.ai_family = AF_UNSPEC;
  6193. hints.ai_socktype = SOCK_STREAM;
  6194. hints.ai_protocol = 0;
  6195. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6196. return false;
  6197. }
  6198. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6199. auto ret = false;
  6200. for (auto rp = result; rp; rp = rp->ai_next) {
  6201. const auto &ai = *rp;
  6202. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6203. ret = true;
  6204. break;
  6205. }
  6206. }
  6207. return ret;
  6208. }
  6209. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6210. #define USE_IF2IP
  6211. #endif
  6212. #ifdef USE_IF2IP
  6213. inline std::string if2ip(int address_family, const std::string &ifn) {
  6214. struct ifaddrs *ifap;
  6215. getifaddrs(&ifap);
  6216. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6217. std::string addr_candidate;
  6218. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6219. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6220. (AF_UNSPEC == address_family ||
  6221. ifa->ifa_addr->sa_family == address_family)) {
  6222. if (ifa->ifa_addr->sa_family == AF_INET) {
  6223. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6224. char buf[INET_ADDRSTRLEN];
  6225. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6226. return std::string(buf, INET_ADDRSTRLEN);
  6227. }
  6228. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6229. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6230. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6231. char buf[INET6_ADDRSTRLEN] = {};
  6232. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6233. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6234. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6235. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6236. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6237. } else {
  6238. return std::string(buf, INET6_ADDRSTRLEN);
  6239. }
  6240. }
  6241. }
  6242. }
  6243. }
  6244. }
  6245. return addr_candidate;
  6246. }
  6247. #endif
  6248. inline socket_t create_client_socket(
  6249. const std::string &host, const std::string &ip, int port,
  6250. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6251. SocketOptions socket_options, time_t connection_timeout_sec,
  6252. time_t connection_timeout_usec, time_t read_timeout_sec,
  6253. time_t read_timeout_usec, time_t write_timeout_sec,
  6254. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6255. auto sock = create_socket(
  6256. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6257. std::move(socket_options),
  6258. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6259. if (!intf.empty()) {
  6260. #ifdef USE_IF2IP
  6261. auto ip_from_if = if2ip(address_family, intf);
  6262. if (ip_from_if.empty()) { ip_from_if = intf; }
  6263. if (!bind_ip_address(sock2, ip_from_if)) {
  6264. error = Error::BindIPAddress;
  6265. return false;
  6266. }
  6267. #endif
  6268. }
  6269. set_nonblocking(sock2, true);
  6270. auto ret =
  6271. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6272. if (ret < 0) {
  6273. if (is_connection_error()) {
  6274. error = Error::Connection;
  6275. return false;
  6276. }
  6277. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6278. connection_timeout_usec);
  6279. if (error != Error::Success) {
  6280. if (error == Error::ConnectionTimeout) { quit = true; }
  6281. return false;
  6282. }
  6283. }
  6284. set_nonblocking(sock2, false);
  6285. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6286. read_timeout_usec);
  6287. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6288. write_timeout_usec);
  6289. error = Error::Success;
  6290. return true;
  6291. },
  6292. connection_timeout_sec); // Pass DNS timeout
  6293. if (sock != INVALID_SOCKET) {
  6294. error = Error::Success;
  6295. } else {
  6296. if (error == Error::Success) { error = Error::Connection; }
  6297. }
  6298. return sock;
  6299. }
  6300. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6301. socklen_t addr_len, std::string &ip, int &port) {
  6302. if (addr.ss_family == AF_INET) {
  6303. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6304. } else if (addr.ss_family == AF_INET6) {
  6305. port =
  6306. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6307. } else {
  6308. return false;
  6309. }
  6310. std::array<char, NI_MAXHOST> ipstr{};
  6311. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6312. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6313. 0, NI_NUMERICHOST)) {
  6314. return false;
  6315. }
  6316. ip = ipstr.data();
  6317. return true;
  6318. }
  6319. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6320. struct sockaddr_storage addr;
  6321. socklen_t addr_len = sizeof(addr);
  6322. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6323. &addr_len)) {
  6324. get_ip_and_port(addr, addr_len, ip, port);
  6325. }
  6326. }
  6327. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6328. struct sockaddr_storage addr;
  6329. socklen_t addr_len = sizeof(addr);
  6330. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6331. &addr_len)) {
  6332. #ifndef _WIN32
  6333. if (addr.ss_family == AF_UNIX) {
  6334. #if defined(__linux__)
  6335. struct ucred ucred;
  6336. socklen_t len = sizeof(ucred);
  6337. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6338. port = ucred.pid;
  6339. }
  6340. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6341. pid_t pid;
  6342. socklen_t len = sizeof(pid);
  6343. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6344. port = pid;
  6345. }
  6346. #endif
  6347. return;
  6348. }
  6349. #endif
  6350. get_ip_and_port(addr, addr_len, ip, port);
  6351. }
  6352. }
  6353. inline std::string
  6354. find_content_type(const std::string &path,
  6355. const std::map<std::string, std::string> &user_data,
  6356. const std::string &default_content_type) {
  6357. auto ext = file_extension(path);
  6358. auto it = user_data.find(ext);
  6359. if (it != user_data.end()) { return it->second; }
  6360. static const struct {
  6361. const char *ext;
  6362. const char *type;
  6363. } types[] = {
  6364. {"css", "text/css"},
  6365. {"csv", "text/csv"},
  6366. {"htm", "text/html"},
  6367. {"html", "text/html"},
  6368. {"js", "text/javascript"},
  6369. {"mjs", "text/javascript"},
  6370. {"txt", "text/plain"},
  6371. {"vtt", "text/vtt"},
  6372. {"apng", "image/apng"},
  6373. {"avif", "image/avif"},
  6374. {"bmp", "image/bmp"},
  6375. {"gif", "image/gif"},
  6376. {"png", "image/png"},
  6377. {"svg", "image/svg+xml"},
  6378. {"webp", "image/webp"},
  6379. {"ico", "image/x-icon"},
  6380. {"tif", "image/tiff"},
  6381. {"tiff", "image/tiff"},
  6382. {"jpg", "image/jpeg"},
  6383. {"jpeg", "image/jpeg"},
  6384. {"mp4", "video/mp4"},
  6385. {"mpeg", "video/mpeg"},
  6386. {"webm", "video/webm"},
  6387. {"mp3", "audio/mp3"},
  6388. {"mpga", "audio/mpeg"},
  6389. {"weba", "audio/webm"},
  6390. {"wav", "audio/wave"},
  6391. {"otf", "font/otf"},
  6392. {"ttf", "font/ttf"},
  6393. {"woff", "font/woff"},
  6394. {"woff2", "font/woff2"},
  6395. {"7z", "application/x-7z-compressed"},
  6396. {"atom", "application/atom+xml"},
  6397. {"pdf", "application/pdf"},
  6398. {"json", "application/json"},
  6399. {"rss", "application/rss+xml"},
  6400. {"tar", "application/x-tar"},
  6401. {"xht", "application/xhtml+xml"},
  6402. {"xhtml", "application/xhtml+xml"},
  6403. {"xslt", "application/xslt+xml"},
  6404. {"xml", "application/xml"},
  6405. {"gz", "application/gzip"},
  6406. {"zip", "application/zip"},
  6407. {"wasm", "application/wasm"},
  6408. };
  6409. for (const auto &t : types) {
  6410. if (ext == t.ext) { return t.type; }
  6411. }
  6412. return default_content_type;
  6413. }
  6414. inline std::string
  6415. extract_media_type(const std::string &content_type,
  6416. std::map<std::string, std::string> *params = nullptr) {
  6417. // Extract type/subtype from Content-Type value (RFC 2045)
  6418. // e.g. "application/json; charset=utf-8" -> "application/json"
  6419. auto media_type = content_type;
  6420. auto semicolon_pos = media_type.find(';');
  6421. if (semicolon_pos != std::string::npos) {
  6422. auto param_str = media_type.substr(semicolon_pos + 1);
  6423. media_type = media_type.substr(0, semicolon_pos);
  6424. if (params) {
  6425. // Parse parameters: key=value pairs separated by ';'
  6426. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6427. [&](const char *b, const char *e) {
  6428. std::string key;
  6429. std::string val;
  6430. divide_param_pair(b, e, key, val);
  6431. if (!key.empty()) {
  6432. params->emplace(trim_copy(key),
  6433. trim_double_quotes_copy(val));
  6434. }
  6435. });
  6436. }
  6437. }
  6438. // Trim whitespace from media type
  6439. return trim_copy(media_type);
  6440. }
  6441. inline bool can_compress_content_type(const std::string &content_type) {
  6442. auto mime_type = extract_media_type(content_type);
  6443. static const char *const compressible[] = {
  6444. "image/svg+xml",
  6445. "application/javascript",
  6446. "application/x-javascript",
  6447. "application/json",
  6448. "application/ld+json",
  6449. "application/xml",
  6450. "application/xhtml+xml",
  6451. "application/rss+xml",
  6452. "application/atom+xml",
  6453. "application/xslt+xml",
  6454. "application/protobuf",
  6455. };
  6456. for (auto type : compressible) {
  6457. if (mime_type == type) { return true; }
  6458. }
  6459. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6460. }
  6461. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6462. double &quality) {
  6463. quality = 1.0;
  6464. token.clear();
  6465. // Split on first ';': left = token name, right = parameters
  6466. const char *params_b = nullptr;
  6467. std::size_t params_len = 0;
  6468. divide(
  6469. b, static_cast<std::size_t>(e - b), ';',
  6470. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6471. auto r = trim(lb, lb + llen, 0, llen);
  6472. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6473. params_b = rb;
  6474. params_len = rlen;
  6475. });
  6476. if (token.empty()) { return false; }
  6477. if (params_len == 0) { return true; }
  6478. // Scan parameters for q= (stops on first match)
  6479. bool invalid = false;
  6480. split_find(params_b, params_b + params_len, ';',
  6481. (std::numeric_limits<size_t>::max)(),
  6482. [&](const char *pb, const char *pe) -> bool {
  6483. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6484. auto len = static_cast<size_t>(pe - pb);
  6485. if (len < 2) { return false; }
  6486. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6487. return false;
  6488. }
  6489. // Trim the value portion
  6490. auto r = trim(pb, pe, 2, len);
  6491. if (r.first >= r.second) {
  6492. invalid = true;
  6493. return true;
  6494. }
  6495. double v = 0.0;
  6496. auto res = from_chars(pb + r.first, pb + r.second, v);
  6497. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6498. v < 0.0 || v > 1.0) {
  6499. invalid = true;
  6500. return true;
  6501. }
  6502. quality = v;
  6503. return true;
  6504. });
  6505. return !invalid;
  6506. }
  6507. inline EncodingType encoding_type(const Request &req,
  6508. const std::string &content_type) {
  6509. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6510. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6511. if (s.empty()) { return EncodingType::None; }
  6512. // Single-pass: iterate tokens and track the best supported encoding.
  6513. // Server preference breaks ties (br > gzip > zstd).
  6514. EncodingType best = EncodingType::None;
  6515. double best_q = 0.0; // q=0 means "not acceptable"
  6516. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6517. auto priority = [](EncodingType t) -> int {
  6518. switch (t) {
  6519. case EncodingType::Brotli: return 0;
  6520. case EncodingType::Gzip: return 1;
  6521. case EncodingType::Zstd: return 2;
  6522. default: return 3;
  6523. }
  6524. };
  6525. std::string name;
  6526. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6527. double quality = 1.0;
  6528. if (!parse_quality(b, e, name, quality)) { return; }
  6529. if (quality <= 0.0) { return; }
  6530. EncodingType type = EncodingType::None;
  6531. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6532. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6533. #endif
  6534. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6535. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6536. type = EncodingType::Gzip;
  6537. }
  6538. #endif
  6539. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6540. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6541. type = EncodingType::Zstd;
  6542. }
  6543. #endif
  6544. if (type == EncodingType::None) { return; }
  6545. // Higher q-value wins; for equal q, server preference breaks ties
  6546. if (quality > best_q ||
  6547. (quality == best_q && priority(type) < priority(best))) {
  6548. best_q = quality;
  6549. best = type;
  6550. }
  6551. });
  6552. return best;
  6553. }
  6554. // `content_type` is taken separately because a file-backed response has not
  6555. // been given one yet when its coding has to be decided.
  6556. inline EncodingType encoding_type(const Request &req, const Response &res,
  6557. const std::string &content_type) {
  6558. // The response already names a content coding of its own: a handler serving
  6559. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6560. // point whose headers name the coding its files are stored in. Applying one
  6561. // on top of that would double-encode the body and append a second
  6562. // `Content-Encoding` field line.
  6563. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6564. return encoding_type(req, content_type);
  6565. }
  6566. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6567. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6568. }
  6569. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6570. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6571. if (type == EncodingType::Gzip) {
  6572. return detail::make_unique<gzip_compressor>();
  6573. }
  6574. #endif
  6575. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6576. if (type == EncodingType::Brotli) {
  6577. return detail::make_unique<brotli_compressor>();
  6578. }
  6579. #endif
  6580. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6581. if (type == EncodingType::Zstd) {
  6582. return detail::make_unique<zstd_compressor>();
  6583. }
  6584. #endif
  6585. (void)type;
  6586. return nullptr;
  6587. }
  6588. inline const char *encoding_name(EncodingType type) {
  6589. switch (type) {
  6590. case EncodingType::Gzip: return "gzip";
  6591. case EncodingType::Brotli: return "br";
  6592. case EncodingType::Zstd: return "zstd";
  6593. default: return "";
  6594. }
  6595. }
  6596. inline bool nocompressor::compress(const char *data, size_t data_length,
  6597. bool /*last*/, Callback callback) {
  6598. if (!data_length) { return true; }
  6599. return callback(data, data_length);
  6600. }
  6601. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6602. inline gzip_compressor::gzip_compressor() {
  6603. std::memset(&strm_, 0, sizeof(strm_));
  6604. strm_.zalloc = Z_NULL;
  6605. strm_.zfree = Z_NULL;
  6606. strm_.opaque = Z_NULL;
  6607. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6608. Z_DEFAULT_STRATEGY) == Z_OK;
  6609. }
  6610. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6611. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6612. bool last, Callback callback) {
  6613. assert(is_valid_);
  6614. do {
  6615. constexpr size_t max_avail_in =
  6616. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6617. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6618. (std::min)(data_length, max_avail_in));
  6619. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6620. data_length -= strm_.avail_in;
  6621. data += strm_.avail_in;
  6622. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6623. auto ret = Z_OK;
  6624. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6625. do {
  6626. strm_.avail_out = static_cast<uInt>(buff.size());
  6627. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6628. ret = deflate(&strm_, flush);
  6629. if (ret == Z_STREAM_ERROR) { return false; }
  6630. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6631. return false;
  6632. }
  6633. } while (strm_.avail_out == 0);
  6634. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6635. (flush == Z_NO_FLUSH && ret == Z_OK));
  6636. assert(strm_.avail_in == 0);
  6637. } while (data_length > 0);
  6638. return true;
  6639. }
  6640. inline gzip_decompressor::gzip_decompressor() {
  6641. std::memset(&strm_, 0, sizeof(strm_));
  6642. strm_.zalloc = Z_NULL;
  6643. strm_.zfree = Z_NULL;
  6644. strm_.opaque = Z_NULL;
  6645. // 15 is the value of wbits, which should be at the maximum possible value
  6646. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6647. // that the stream type should be automatically detected either gzip or
  6648. // deflate.
  6649. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6650. }
  6651. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6652. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6653. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6654. Callback callback) {
  6655. assert(is_valid_);
  6656. auto ret = Z_OK;
  6657. do {
  6658. constexpr size_t max_avail_in =
  6659. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6660. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6661. (std::min)(data_length, max_avail_in));
  6662. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6663. data_length -= strm_.avail_in;
  6664. data += strm_.avail_in;
  6665. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6666. while (strm_.avail_in > 0 && ret == Z_OK) {
  6667. strm_.avail_out = static_cast<uInt>(buff.size());
  6668. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6669. ret = inflate(&strm_, Z_NO_FLUSH);
  6670. assert(ret != Z_STREAM_ERROR);
  6671. switch (ret) {
  6672. case Z_NEED_DICT:
  6673. case Z_DATA_ERROR:
  6674. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6675. }
  6676. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6677. return false;
  6678. }
  6679. }
  6680. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6681. } while (data_length > 0);
  6682. return true;
  6683. }
  6684. #endif
  6685. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6686. inline brotli_compressor::brotli_compressor() {
  6687. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6688. }
  6689. inline brotli_compressor::~brotli_compressor() {
  6690. BrotliEncoderDestroyInstance(state_);
  6691. }
  6692. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6693. bool last, Callback callback) {
  6694. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6695. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6696. auto available_in = data_length;
  6697. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6698. for (;;) {
  6699. if (last) {
  6700. if (BrotliEncoderIsFinished(state_)) { break; }
  6701. } else {
  6702. if (!available_in) { break; }
  6703. }
  6704. auto available_out = buff.size();
  6705. auto next_out = buff.data();
  6706. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6707. &available_out, &next_out, nullptr)) {
  6708. return false;
  6709. }
  6710. auto output_bytes = buff.size() - available_out;
  6711. if (output_bytes) {
  6712. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6713. }
  6714. }
  6715. return true;
  6716. }
  6717. inline brotli_decompressor::brotli_decompressor() {
  6718. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6719. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6720. : BROTLI_DECODER_RESULT_ERROR;
  6721. }
  6722. inline brotli_decompressor::~brotli_decompressor() {
  6723. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6724. }
  6725. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6726. inline bool brotli_decompressor::decompress(const char *data,
  6727. size_t data_length,
  6728. Callback callback) {
  6729. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6730. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6731. return 0;
  6732. }
  6733. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6734. size_t avail_in = data_length;
  6735. size_t total_out;
  6736. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6737. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6738. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6739. char *next_out = buff.data();
  6740. size_t avail_out = buff.size();
  6741. decoder_r = BrotliDecoderDecompressStream(
  6742. decoder_s, &avail_in, &next_in, &avail_out,
  6743. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6744. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6745. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6746. }
  6747. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6748. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6749. }
  6750. #endif
  6751. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6752. inline zstd_compressor::zstd_compressor() {
  6753. ctx_ = ZSTD_createCCtx();
  6754. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6755. }
  6756. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6757. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6758. bool last, Callback callback) {
  6759. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6760. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6761. ZSTD_inBuffer input = {data, data_length, 0};
  6762. bool finished;
  6763. do {
  6764. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6765. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6766. if (ZSTD_isError(remaining)) { return false; }
  6767. if (!callback(buff.data(), output.pos)) { return false; }
  6768. finished = last ? (remaining == 0) : (input.pos == input.size);
  6769. } while (!finished);
  6770. return true;
  6771. }
  6772. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6773. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6774. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6775. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6776. Callback callback) {
  6777. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6778. ZSTD_inBuffer input = {data, data_length, 0};
  6779. while (input.pos < input.size) {
  6780. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6781. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6782. if (ZSTD_isError(remaining)) { return false; }
  6783. if (!callback(buff.data(), output.pos)) { return false; }
  6784. }
  6785. return true;
  6786. }
  6787. #endif
  6788. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6789. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6790. // unknown coding, and its payload would be handed back still compressed.
  6791. inline bool is_zlib_encoding(const std::string &encoding) {
  6792. return case_ignore::equal(encoding, "gzip") ||
  6793. case_ignore::equal(encoding, "deflate");
  6794. }
  6795. inline bool is_brotli_encoding(const std::string &encoding) {
  6796. return case_ignore::equal(encoding, "br");
  6797. }
  6798. inline bool is_zstd_encoding(const std::string &encoding) {
  6799. return case_ignore::equal(encoding, "zstd");
  6800. }
  6801. // Returns true if the content coding is one cpp-httplib is able to decompress
  6802. // when the corresponding support is compiled in.
  6803. inline bool is_known_content_encoding(const std::string &encoding) {
  6804. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6805. is_zstd_encoding(encoding);
  6806. }
  6807. inline std::unique_ptr<decompressor>
  6808. create_decompressor(const std::string &encoding) {
  6809. std::unique_ptr<decompressor> decompressor;
  6810. if (is_zlib_encoding(encoding)) {
  6811. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6812. decompressor = detail::make_unique<gzip_decompressor>();
  6813. #endif
  6814. } else if (is_brotli_encoding(encoding)) {
  6815. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6816. decompressor = detail::make_unique<brotli_decompressor>();
  6817. #endif
  6818. } else if (is_zstd_encoding(encoding)) {
  6819. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6820. decompressor = detail::make_unique<zstd_decompressor>();
  6821. #endif
  6822. }
  6823. return decompressor;
  6824. }
  6825. // Returns the best available compressor and its Content-Encoding name.
  6826. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6827. inline std::pair<std::unique_ptr<compressor>, const char *>
  6828. create_compressor() {
  6829. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6830. return {detail::make_unique<brotli_compressor>(), "br"};
  6831. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6832. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6833. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6834. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6835. #else
  6836. return {nullptr, nullptr};
  6837. #endif
  6838. }
  6839. // s == lit, comparing the lengths first, which operator== may not do.
  6840. template <size_t N>
  6841. inline bool equals_literal(const std::string &s, const char (&lit)[N]) {
  6842. return s.size() == N - 1 && !s.compare(0, N - 1, lit);
  6843. }
  6844. inline bool is_prohibited_header_name(const std::string &name) {
  6845. // Every header lookup by name runs this.
  6846. return equals_literal(name, "REMOTE_ADDR") ||
  6847. equals_literal(name, "REMOTE_PORT") ||
  6848. equals_literal(name, "LOCAL_ADDR") ||
  6849. equals_literal(name, "LOCAL_PORT");
  6850. }
  6851. inline bool has_header(const Headers &headers, const std::string &key) {
  6852. if (is_prohibited_header_name(key)) { return false; }
  6853. return headers.find(key) != headers.end();
  6854. }
  6855. inline const char *get_header_value(const Headers &headers,
  6856. const std::string &key, const char *def,
  6857. size_t id) {
  6858. if (is_prohibited_header_name(key)) {
  6859. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6860. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6861. throw std::invalid_argument(msg);
  6862. #else
  6863. return "";
  6864. #endif
  6865. }
  6866. auto rng = headers.equal_range(key);
  6867. auto it = bounded_next(rng.first, id, rng.second);
  6868. if (it != rng.second) { return it->second.c_str(); }
  6869. return def;
  6870. }
  6871. inline size_t get_header_value_count(const Headers &headers,
  6872. const std::string &key) {
  6873. return headers.count(key);
  6874. }
  6875. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6876. // list may be sent as several field lines, and the combined field value is
  6877. // those values joined by commas in the order they were received. Callers that
  6878. // parse such a list must work on the combined value; reading only the first
  6879. // occurrence silently drops whatever the later field lines carry.
  6880. inline std::string get_combined_header_value(const Headers &headers,
  6881. const std::string &key) {
  6882. std::string combined;
  6883. auto rng = headers.equal_range(key);
  6884. for (auto it = rng.first; it != rng.second; ++it) {
  6885. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6886. // elements, so an empty field line must not contribute a bare comma to the
  6887. // combined value.
  6888. if (it->second.empty()) { continue; }
  6889. if (!combined.empty()) { combined += ", "; }
  6890. combined += it->second;
  6891. }
  6892. return combined;
  6893. }
  6894. inline bool has_header_token(const Headers &headers, const std::string &key,
  6895. const std::string &token) {
  6896. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6897. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6898. // several lines. Match complete tokens rather than searching the raw value,
  6899. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6900. auto rng = headers.equal_range(key);
  6901. for (auto it = rng.first; it != rng.second; ++it) {
  6902. const auto &value = it->second;
  6903. if (split_find(value.data(), value.data() + value.size(), ',',
  6904. [&](const char *b, const char *e) {
  6905. return case_ignore::equal(std::string(b, e), token);
  6906. })) {
  6907. return true;
  6908. }
  6909. }
  6910. return false;
  6911. }
  6912. template <typename Map>
  6913. inline typename Map::mapped_type
  6914. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6915. auto rng = m.equal_range(key);
  6916. auto it = bounded_next(rng.first, id, rng.second);
  6917. if (it != rng.second) { return it->second; }
  6918. return typename Map::mapped_type();
  6919. }
  6920. inline void set_header(Headers &headers, const std::string &key,
  6921. const std::string &val) {
  6922. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6923. }
  6924. inline bool read_headers(Stream &strm, Headers &headers) {
  6925. const auto bufsiz = 2048;
  6926. char buf[bufsiz];
  6927. stream_line_reader line_reader(strm, buf, bufsiz);
  6928. size_t header_count = 0;
  6929. for (;;) {
  6930. if (!line_reader.getline()) { return false; }
  6931. // Check if the line ends with CRLF.
  6932. auto line_terminator_len = 2;
  6933. if (line_reader.end_with_crlf()) {
  6934. // Blank line indicates end of headers.
  6935. if (line_reader.size() == 2) { break; }
  6936. } else {
  6937. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6938. // Blank line indicates end of headers.
  6939. if (line_reader.size() == 1) { break; }
  6940. line_terminator_len = 1;
  6941. #else
  6942. continue; // Skip invalid line.
  6943. #endif
  6944. }
  6945. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6946. // Check header count limit
  6947. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6948. // Exclude line terminator
  6949. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6950. if (!parse_header(line_reader.ptr(), end,
  6951. [&](const std::string &key, const std::string &val) {
  6952. headers.emplace(key, val);
  6953. })) {
  6954. return false;
  6955. }
  6956. header_count++;
  6957. }
  6958. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6959. // headers that have different values to prevent request smuggling.
  6960. auto cl_range = headers.equal_range("Content-Length");
  6961. if (cl_range.first != cl_range.second) {
  6962. const auto &first_val = cl_range.first->second;
  6963. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6964. if (it->second != first_val) { return false; }
  6965. }
  6966. }
  6967. return true;
  6968. }
  6969. // Parsed by hand: std::regex_match recurses once per character of the reason
  6970. // phrase, which a server can make as long as a whole line.
  6971. inline bool parse_status_line(const char *line, std::string &version,
  6972. int &status, std::string &reason) {
  6973. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  6974. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  6975. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  6976. !is_ascii_digit(line[11])) {
  6977. return false;
  6978. }
  6979. auto p = line + 12;
  6980. auto reason_begin = p;
  6981. if (*p == ' ') {
  6982. reason_begin = ++p;
  6983. p += std::strcspn(p, "\r\n");
  6984. }
  6985. auto reason_end = p;
  6986. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6987. if (*p == '\r') { p++; }
  6988. #else
  6989. if (*p++ != '\r') { return false; }
  6990. #endif
  6991. if (*p++ != '\n' || *p != '\0') { return false; }
  6992. version.assign(line, 8);
  6993. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  6994. reason.assign(reason_begin, reason_end);
  6995. return true;
  6996. }
  6997. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6998. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6999. struct WebSocketUpgradeResponse {
  7000. Error error = Error::Success;
  7001. int status = -1;
  7002. Headers headers;
  7003. std::string selected_subprotocol;
  7004. };
  7005. inline bool
  7006. read_websocket_upgrade_response(Stream &strm,
  7007. const std::string &expected_accept,
  7008. const std::string &offered_subprotocols,
  7009. WebSocketUpgradeResponse &upgrade) {
  7010. // Read status line
  7011. const auto bufsiz = 2048;
  7012. char buf[bufsiz];
  7013. stream_line_reader line_reader(strm, buf, bufsiz);
  7014. if (!line_reader.getline()) {
  7015. upgrade.error = Error::Read;
  7016. return false;
  7017. }
  7018. std::string version;
  7019. std::string reason;
  7020. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  7021. upgrade.error = Error::WebSocketHandshake;
  7022. return false;
  7023. }
  7024. // Read the headers even for a rejection so the caller can see why the
  7025. // server refused the upgrade. A non-101 response may carry a body; it is
  7026. // deliberately left unread since the caller closes the socket right away.
  7027. if (!read_headers(strm, upgrade.headers)) {
  7028. upgrade.error = Error::Read;
  7029. return false;
  7030. }
  7031. const auto &headers = upgrade.headers;
  7032. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7033. upgrade.error = Error::WebSocketHandshake;
  7034. return false;
  7035. }
  7036. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7037. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7038. upgrade.error = Error::WebSocketHandshake;
  7039. return false;
  7040. }
  7041. // Verify Connection: Upgrade
  7042. if (!has_header_token(headers, "Connection", "upgrade")) {
  7043. upgrade.error = Error::WebSocketHandshake;
  7044. return false;
  7045. }
  7046. // Verify Sec-WebSocket-Accept header value
  7047. auto it = headers.find("Sec-WebSocket-Accept");
  7048. if (it == headers.end() || it->second != expected_accept) {
  7049. upgrade.error = Error::WebSocketHandshake;
  7050. return false;
  7051. }
  7052. // Extract negotiated subprotocol
  7053. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7054. if (proto_it != headers.end()) {
  7055. upgrade.selected_subprotocol = proto_it->second;
  7056. }
  7057. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7058. if (!upgrade.selected_subprotocol.empty()) {
  7059. auto was_offered = false;
  7060. split(offered_subprotocols.data(),
  7061. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7062. [&](const char *b, const char *e) {
  7063. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7064. was_offered = true;
  7065. }
  7066. });
  7067. if (!was_offered) {
  7068. upgrade.error = Error::WebSocketHandshake;
  7069. return false;
  7070. }
  7071. }
  7072. return true;
  7073. }
  7074. enum class ReadContentResult {
  7075. Success, // Successfully read the content
  7076. PayloadTooLarge, // The content exceeds the specified payload limit
  7077. Error // An error occurred while reading the content
  7078. };
  7079. inline ReadContentResult read_content_with_length(
  7080. Stream &strm, size_t len, DownloadProgress progress,
  7081. ContentReceiverWithProgress out,
  7082. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7083. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7084. detail::BodyReader br;
  7085. br.stream = &strm;
  7086. br.has_content_length = true;
  7087. br.content_length = len;
  7088. br.payload_max_length = payload_max_length;
  7089. br.chunked = false;
  7090. br.bytes_read = 0;
  7091. br.last_error = Error::Success;
  7092. size_t r = 0;
  7093. while (r < len) {
  7094. auto read_len = static_cast<size_t>(len - r);
  7095. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7096. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7097. if (n <= 0) {
  7098. // Check if it was a payload size error
  7099. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7100. return ReadContentResult::PayloadTooLarge;
  7101. }
  7102. return ReadContentResult::Error;
  7103. }
  7104. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7105. return ReadContentResult::Error;
  7106. }
  7107. r += static_cast<size_t>(n);
  7108. if (progress) {
  7109. if (!progress(r, len)) { return ReadContentResult::Error; }
  7110. }
  7111. }
  7112. return ReadContentResult::Success;
  7113. }
  7114. inline ReadContentResult
  7115. read_content_without_length(Stream &strm, size_t payload_max_length,
  7116. ContentReceiverWithProgress out) {
  7117. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7118. size_t r = 0;
  7119. for (;;) {
  7120. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7121. if (n == 0) { return ReadContentResult::Success; }
  7122. if (n < 0) { return ReadContentResult::Error; }
  7123. // Check if adding this data would exceed the payload limit
  7124. if (payload_max_length > 0 &&
  7125. (r > payload_max_length ||
  7126. payload_max_length - r < static_cast<size_t>(n))) {
  7127. return ReadContentResult::PayloadTooLarge;
  7128. }
  7129. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7130. return ReadContentResult::Error;
  7131. }
  7132. r += static_cast<size_t>(n);
  7133. }
  7134. return ReadContentResult::Success;
  7135. }
  7136. template <typename T>
  7137. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7138. size_t payload_max_length,
  7139. ContentReceiverWithProgress out) {
  7140. detail::ChunkedDecoder dec(strm);
  7141. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7142. size_t total_len = 0;
  7143. for (;;) {
  7144. size_t chunk_offset = 0;
  7145. size_t chunk_total = 0;
  7146. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7147. if (n < 0) { return ReadContentResult::Error; }
  7148. if (n == 0) {
  7149. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7150. return ReadContentResult::Error;
  7151. }
  7152. return ReadContentResult::Success;
  7153. }
  7154. if (payload_max_length > 0 &&
  7155. (total_len > payload_max_length ||
  7156. payload_max_length - total_len < static_cast<size_t>(n))) {
  7157. return ReadContentResult::PayloadTooLarge;
  7158. }
  7159. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7160. return ReadContentResult::Error;
  7161. }
  7162. total_len += static_cast<size_t>(n);
  7163. }
  7164. }
  7165. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7166. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7167. // is the final transfer coding. A single field value may list several
  7168. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7169. // several Transfer-Encoding lines, which combine into one comma-separated
  7170. // list in the order the lines were received. Headers preserves that order,
  7171. // so the final coding is the last token of the last line. Match it
  7172. // case-insensitively rather than comparing the whole value against
  7173. // "chunked".
  7174. //
  7175. // Security: reading a chunked message as unframed leaves its body in the
  7176. // socket, where a keep-alive connection parses it as a smuggled request.
  7177. // Server::process_request() answers 400 and closes when the final coding is
  7178. // not chunked, so a request whose framing cannot be determined never
  7179. // reaches the "no body" path.
  7180. auto rng = headers.equal_range("Transfer-Encoding");
  7181. if (rng.first == rng.second) { return false; }
  7182. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7183. // combined list ending in nothing rather than inheriting the line before it.
  7184. std::string last_coding;
  7185. for (auto it = rng.first; it != rng.second; ++it) {
  7186. const auto &value = it->second;
  7187. last_coding.clear();
  7188. split(value.data(), value.data() + value.size(), ',',
  7189. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7190. }
  7191. return case_ignore::equal(last_coding, "chunked");
  7192. }
  7193. inline bool has_conflicting_content_length(const Headers &headers) {
  7194. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7195. // Content-Length is framed ambiguously. The body readers here delimit it by
  7196. // the transfer coding and drop Content-Length, while an intermediary may do
  7197. // the reverse, so the two disagree on where the body ends and a reused
  7198. // connection is desynchronised (request/response smuggling). Content-Length:
  7199. // 0 is tolerated for compatibility with existing peers.
  7200. return has_header(headers, "Transfer-Encoding") &&
  7201. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7202. }
  7203. template <typename T, typename U>
  7204. bool prepare_content_receiver(T &x, int &status,
  7205. ContentReceiverWithProgress receiver,
  7206. bool decompress, size_t payload_max_length,
  7207. bool &exceed_payload_max_length, U callback) {
  7208. if (decompress) {
  7209. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7210. std::unique_ptr<decompressor> decompressor;
  7211. if (!encoding.empty()) {
  7212. // A coding we know about but were not built with is an error. An
  7213. // unrecognized coding (including "identity") is left alone and the
  7214. // payload is passed through as-is, since some servers misuse the header,
  7215. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7216. decompressor = detail::create_decompressor(encoding);
  7217. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7218. status = StatusCode::UnsupportedMediaType_415;
  7219. return false;
  7220. }
  7221. }
  7222. if (decompressor) {
  7223. if (decompressor->is_valid()) {
  7224. size_t decompressed_size = 0;
  7225. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7226. size_t off, size_t len) {
  7227. return decompressor->decompress(
  7228. buf, n, [&](const char *buf2, size_t n2) {
  7229. // Guard against zip-bomb: check
  7230. // decompressed size against limit.
  7231. if (payload_max_length > 0 &&
  7232. (decompressed_size >= payload_max_length ||
  7233. n2 > payload_max_length - decompressed_size)) {
  7234. exceed_payload_max_length = true;
  7235. return false;
  7236. }
  7237. decompressed_size += n2;
  7238. return receiver(buf2, n2, off, len);
  7239. });
  7240. };
  7241. return callback(std::move(out));
  7242. } else {
  7243. status = StatusCode::InternalServerError_500;
  7244. return false;
  7245. }
  7246. }
  7247. }
  7248. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7249. size_t len) {
  7250. return receiver(buf, n, off, len);
  7251. };
  7252. return callback(std::move(out));
  7253. }
  7254. template <typename T>
  7255. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7256. DownloadProgress progress,
  7257. ContentReceiverWithProgress receiver, bool decompress) {
  7258. bool exceed_payload_max_length = false;
  7259. return prepare_content_receiver(
  7260. x, status, std::move(receiver), decompress, payload_max_length,
  7261. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7262. auto ret = true;
  7263. // Note: exceed_payload_max_length may also be set by the decompressor
  7264. // wrapper in prepare_content_receiver when the decompressed payload
  7265. // size exceeds the limit.
  7266. if (is_chunked_transfer_encoding(x.headers)) {
  7267. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7268. if (result == ReadContentResult::Success) {
  7269. ret = true;
  7270. } else if (result == ReadContentResult::PayloadTooLarge) {
  7271. exceed_payload_max_length = true;
  7272. ret = false;
  7273. } else {
  7274. ret = false;
  7275. }
  7276. } else if (!has_header(x.headers, "Content-Length")) {
  7277. auto result =
  7278. read_content_without_length(strm, payload_max_length, out);
  7279. if (result == ReadContentResult::Success) {
  7280. ret = true;
  7281. } else if (result == ReadContentResult::PayloadTooLarge) {
  7282. exceed_payload_max_length = true;
  7283. ret = false;
  7284. } else {
  7285. ret = false;
  7286. }
  7287. } else {
  7288. auto is_invalid_value = false;
  7289. auto len = get_header_value_u64(x.headers, "Content-Length",
  7290. (std::numeric_limits<size_t>::max)(),
  7291. 0, is_invalid_value);
  7292. if (is_invalid_value) {
  7293. ret = false;
  7294. } else if (len > 0) {
  7295. auto result = read_content_with_length(
  7296. strm, len, std::move(progress), out, payload_max_length);
  7297. ret = (result == ReadContentResult::Success);
  7298. if (result == ReadContentResult::PayloadTooLarge) {
  7299. exceed_payload_max_length = true;
  7300. }
  7301. }
  7302. }
  7303. if (!ret) {
  7304. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7305. : StatusCode::BadRequest_400;
  7306. }
  7307. return ret;
  7308. });
  7309. }
  7310. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7311. const std::string &path) {
  7312. // Neither the method nor the request target may carry CR/LF, SP or other
  7313. // control octets; otherwise a value smuggled into either splits the request
  7314. // line and injects headers or a whole request.
  7315. if (!fields::is_token(method)) { return -1; }
  7316. if (!fields::is_request_target(path)) { return -1; }
  7317. std::string s = method;
  7318. s += ' ';
  7319. s += path;
  7320. s += " HTTP/1.1\r\n";
  7321. return strm.write(s.data(), s.size());
  7322. }
  7323. inline ssize_t write_response_line(Stream &strm, int status) {
  7324. std::string s = "HTTP/1.1 ";
  7325. s += std::to_string(status);
  7326. s += ' ';
  7327. s += httplib::status_message(status);
  7328. s += "\r\n";
  7329. return strm.write(s.data(), s.size());
  7330. }
  7331. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7332. ssize_t write_len = 0;
  7333. for (const auto &x : headers) {
  7334. // Skip fields with invalid names or values to prevent response splitting
  7335. // via CR/LF injection, matching set_header(). The client validates request
  7336. // headers up front in check_and_write_headers, but the server passes
  7337. // res.headers straight to this writer, and res.headers is a public field
  7338. // an application can populate directly with request-derived values.
  7339. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7340. std::string s;
  7341. s = x.first;
  7342. s += ": ";
  7343. s += x.second;
  7344. s += "\r\n";
  7345. auto len = strm.write(s.data(), s.size());
  7346. if (len < 0) { return len; }
  7347. write_len += len;
  7348. }
  7349. auto len = strm.write("\r\n");
  7350. if (len < 0) { return len; }
  7351. write_len += len;
  7352. return write_len;
  7353. }
  7354. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7355. size_t offset = 0;
  7356. while (offset < l) {
  7357. auto length = strm.write(d + offset, l - offset);
  7358. if (length < 0) { return false; }
  7359. offset += static_cast<size_t>(length);
  7360. }
  7361. return true;
  7362. }
  7363. template <typename T>
  7364. inline bool write_content_with_progress(Stream &strm,
  7365. const ContentProvider &content_provider,
  7366. size_t offset, size_t length,
  7367. T is_shutting_down,
  7368. const UploadProgress &upload_progress,
  7369. Error &error) {
  7370. size_t end_offset = offset + length;
  7371. size_t start_offset = offset;
  7372. auto ok = true;
  7373. auto finished = false;
  7374. DataSink data_sink;
  7375. data_sink.write = [&](const char *d, size_t l) -> bool {
  7376. if (ok) {
  7377. if (write_data(strm, d, l)) {
  7378. offset += l;
  7379. if (upload_progress && length > 0) {
  7380. size_t current_written = offset - start_offset;
  7381. if (!upload_progress(current_written, length)) {
  7382. ok = false;
  7383. return false;
  7384. }
  7385. }
  7386. } else {
  7387. ok = false;
  7388. }
  7389. }
  7390. return ok;
  7391. };
  7392. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7393. // The body is framed by `length`, so a provider that reports itself done
  7394. // early has truncated it. Record that and let the short-body check below
  7395. // fail the write, rather than calling the provider again forever.
  7396. data_sink.done = [&]() { finished = true; };
  7397. while (offset < end_offset && !finished && !is_shutting_down()) {
  7398. auto last_offset = offset;
  7399. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7400. error = Error::Write;
  7401. return false;
  7402. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7403. error = Error::Canceled;
  7404. return false;
  7405. } else if (!ok) {
  7406. error = Error::Write;
  7407. return false;
  7408. }
  7409. // A provider that reports success without writing anything and without
  7410. // reporting itself done gets handed the same offset and length again on
  7411. // the next pass, so it would spin here for as long as the peer stays
  7412. // connected. Treat making no progress as a short body, like done() early.
  7413. if (!finished && offset == last_offset) {
  7414. error = Error::Write;
  7415. return false;
  7416. }
  7417. }
  7418. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7419. error = Error::Write;
  7420. return false;
  7421. }
  7422. error = Error::Success;
  7423. return true;
  7424. }
  7425. template <typename T>
  7426. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7427. size_t offset, size_t length, T is_shutting_down,
  7428. Error &error) {
  7429. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7430. is_shutting_down, nullptr, error);
  7431. }
  7432. template <typename T>
  7433. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7434. size_t offset, size_t length,
  7435. const T &is_shutting_down) {
  7436. auto error = Error::Success;
  7437. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7438. error);
  7439. }
  7440. template <typename T>
  7441. inline bool
  7442. write_content_without_length(Stream &strm,
  7443. const ContentProvider &content_provider,
  7444. const T &is_shutting_down) {
  7445. size_t offset = 0;
  7446. auto data_available = true;
  7447. auto ok = true;
  7448. DataSink data_sink;
  7449. data_sink.write = [&](const char *d, size_t l) -> bool {
  7450. if (ok) {
  7451. offset += l;
  7452. if (!write_data(strm, d, l)) { ok = false; }
  7453. }
  7454. return ok;
  7455. };
  7456. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7457. data_sink.done = [&](void) { data_available = false; };
  7458. while (data_available && !is_shutting_down()) {
  7459. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7460. return false;
  7461. } else if (!content_provider(offset, 0, data_sink)) {
  7462. return false;
  7463. } else if (!ok) {
  7464. return false;
  7465. }
  7466. }
  7467. return !data_available; // true only if done() was called, false if shutting
  7468. // down
  7469. }
  7470. // Runs a known-length content provider to completion and compresses what it
  7471. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7472. // by an mmap hands the compressor a pointer straight into the mapping.
  7473. inline bool compress_content_provider(const ContentProvider &content_provider,
  7474. size_t length, compressor &cmp,
  7475. std::string &out) {
  7476. size_t offset = 0;
  7477. auto ok = true;
  7478. auto finished = false;
  7479. DataSink data_sink;
  7480. auto append = [&](const char *data, size_t data_len) {
  7481. out.append(data, data_len);
  7482. return true;
  7483. };
  7484. data_sink.write = [&](const char *d, size_t l) -> bool {
  7485. if (!ok) { return false; }
  7486. offset += l;
  7487. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7488. return ok;
  7489. };
  7490. // The body is framed by `length`, so a provider that reports itself done
  7491. // early has truncated it; the short-body check below turns that into a
  7492. // failure rather than calling the provider again forever.
  7493. data_sink.done = [&]() { finished = true; };
  7494. while (offset < length && !finished) {
  7495. auto prev_offset = offset;
  7496. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7497. return false;
  7498. }
  7499. // No Stream to block on here, so a provider that keeps returning true
  7500. // without writing would spin. Treat a pass that made no progress as a
  7501. // failure.
  7502. if (offset == prev_offset) { return false; }
  7503. }
  7504. if (offset != length) { return false; }
  7505. return cmp.compress(nullptr, 0, true, append);
  7506. }
  7507. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7508. // and the file flag, so recording them has to come after; keeping all of it
  7509. // here means a third file-serving path cannot get that order wrong.
  7510. inline void set_file_content_provider(Response &res,
  7511. const std::shared_ptr<mmap> &m,
  7512. const std::string &content_type,
  7513. EncodingType encoding) {
  7514. res.set_content_provider(
  7515. m->size(), content_type,
  7516. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7517. // Never read past the mapping.
  7518. if (offset >= m->size()) { return false; }
  7519. sink.write(m->data() + offset, (std::min)(length, m->size() - offset));
  7520. return true;
  7521. });
  7522. res.is_file_content_provider_ = true;
  7523. res.content_coding_ = encoding;
  7524. }
  7525. template <typename T, typename U>
  7526. inline bool
  7527. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7528. const T &is_shutting_down, U &compressor, Error &error) {
  7529. size_t offset = 0;
  7530. auto data_available = true;
  7531. auto ok = true;
  7532. DataSink data_sink;
  7533. data_sink.write = [&](const char *d, size_t l) -> bool {
  7534. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7535. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7536. // zero-length chunk is the terminator, so it must not be emitted here.
  7537. if (ok && l > 0) {
  7538. offset += l;
  7539. std::string payload;
  7540. if (compressor.compress(d, l, false,
  7541. [&](const char *data, size_t data_len) {
  7542. payload.append(data, data_len);
  7543. return true;
  7544. })) {
  7545. if (!payload.empty()) {
  7546. // Emit chunked response header and footer for each chunk
  7547. auto chunk =
  7548. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7549. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7550. }
  7551. } else {
  7552. ok = false;
  7553. }
  7554. }
  7555. return ok;
  7556. };
  7557. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7558. auto done_with_trailer = [&](const Headers *trailer) {
  7559. if (!ok) { return; }
  7560. data_available = false;
  7561. std::string payload;
  7562. if (!compressor.compress(nullptr, 0, true,
  7563. [&](const char *data, size_t data_len) {
  7564. payload.append(data, data_len);
  7565. return true;
  7566. })) {
  7567. ok = false;
  7568. return;
  7569. }
  7570. if (!payload.empty()) {
  7571. // Emit chunked response header and footer for each chunk
  7572. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7573. if (!write_data(strm, chunk.data(), chunk.size())) {
  7574. ok = false;
  7575. return;
  7576. }
  7577. }
  7578. constexpr const char done_marker[] = "0\r\n";
  7579. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7580. // Trailer
  7581. if (trailer) {
  7582. for (const auto &kv : *trailer) {
  7583. // Skip fields with invalid names or values to prevent response
  7584. // splitting via CR/LF injection, matching set_header().
  7585. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7586. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7587. if (!write_data(strm, field_line.data(), field_line.size())) {
  7588. ok = false;
  7589. }
  7590. }
  7591. }
  7592. constexpr const char crlf[] = "\r\n";
  7593. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7594. };
  7595. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7596. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7597. done_with_trailer(&trailer);
  7598. };
  7599. while (data_available && !is_shutting_down()) {
  7600. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7601. error = Error::Write;
  7602. return false;
  7603. } else if (!content_provider(offset, 0, data_sink)) {
  7604. error = Error::Canceled;
  7605. return false;
  7606. } else if (!ok) {
  7607. error = Error::Write;
  7608. return false;
  7609. }
  7610. }
  7611. if (data_available) { // exited due to is_shutting_down(), not done()
  7612. error = Error::Write;
  7613. return false;
  7614. }
  7615. error = Error::Success;
  7616. return true;
  7617. }
  7618. template <typename T, typename U>
  7619. inline bool write_content_chunked(Stream &strm,
  7620. const ContentProvider &content_provider,
  7621. const T &is_shutting_down, U &compressor) {
  7622. auto error = Error::Success;
  7623. return write_content_chunked(strm, content_provider, is_shutting_down,
  7624. compressor, error);
  7625. }
  7626. template <typename T>
  7627. inline bool redirect(T &cli, Request &req, Response &res,
  7628. const std::string &path, const std::string &location,
  7629. Error &error) {
  7630. Request new_req = req;
  7631. new_req.path = path;
  7632. new_req.redirect_count_ -= 1;
  7633. if (res.status == StatusCode::SeeOther_303 &&
  7634. (req.method != "GET" && req.method != "HEAD")) {
  7635. new_req.method = "GET";
  7636. new_req.body.clear();
  7637. new_req.headers.clear();
  7638. new_req.content_length_ = 0;
  7639. new_req.content_provider_ = nullptr;
  7640. new_req.is_chunked_content_provider_ = false;
  7641. }
  7642. Response new_res;
  7643. auto ret = cli.send(new_req, new_res, error);
  7644. if (ret) {
  7645. req = std::move(new_req);
  7646. res = std::move(new_res);
  7647. if (res.location.empty()) { res.location = location; }
  7648. }
  7649. return ret;
  7650. }
  7651. inline std::string params_to_query_str(const Params &params) {
  7652. std::string query;
  7653. for (auto it = params.begin(); it != params.end(); ++it) {
  7654. if (it != params.begin()) { query += '&'; }
  7655. query += encode_query_component(it->first);
  7656. query += '=';
  7657. query += encode_query_component(it->second);
  7658. }
  7659. return query;
  7660. }
  7661. // Splits one "key=value" span of a query string at its first '='. A span with
  7662. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7663. // "?flag" keeps its name.
  7664. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7665. std::string &val) {
  7666. divide(b, static_cast<std::size_t>(e - b), '=',
  7667. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7668. std::size_t rhs_size) {
  7669. key.assign(lhs_data, lhs_size);
  7670. val.assign(rhs_data, rhs_size);
  7671. });
  7672. }
  7673. inline void parse_query_text(const char *data, std::size_t size,
  7674. Params &params) {
  7675. std::set<std::string> cache;
  7676. split(data, data + size, '&', [&](const char *b, const char *e) {
  7677. std::string kv(b, e);
  7678. if (cache.find(kv) != cache.end()) { return; }
  7679. cache.insert(std::move(kv));
  7680. std::string key;
  7681. std::string val;
  7682. divide_query_pair(b, e, key, val);
  7683. if (!key.empty()) {
  7684. params.emplace(decode_query_component(key), decode_query_component(val));
  7685. }
  7686. });
  7687. }
  7688. inline void parse_query_text(const std::string &s, Params &params) {
  7689. parse_query_text(s.data(), s.size(), params);
  7690. }
  7691. // Normalize a query string by decoding and re-encoding each key/value pair
  7692. // while preserving the original parameter order. This avoids double-encoding
  7693. // and ensures consistent encoding. It works on the raw string rather than
  7694. // parsing into Params and re-serializing, because that round trip cannot
  7695. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7696. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7697. // duplicated pairs.
  7698. inline std::string normalize_query_string(const std::string &query) {
  7699. std::string result;
  7700. split(query.data(), query.data() + query.size(), '&',
  7701. [&](const char *b, const char *e) {
  7702. std::string key;
  7703. std::string val;
  7704. divide_query_pair(b, e, key, val);
  7705. if (!key.empty()) {
  7706. auto dec_key = decode_query_component(key);
  7707. auto dec_val = decode_query_component(val);
  7708. if (!result.empty()) { result += '&'; }
  7709. result += encode_query_component(dec_key);
  7710. if (!val.empty() || std::find(b, e, '=') != e) {
  7711. result += '=';
  7712. result += encode_query_component(dec_val);
  7713. }
  7714. }
  7715. });
  7716. return result;
  7717. }
  7718. // Build the request target that goes on the wire from a caller-supplied path.
  7719. // Shared by the buffered send path and the streaming API so that both put the
  7720. // same bytes in the request line for the same input.
  7721. inline std::string encode_request_target(const std::string &uri,
  7722. bool path_encode) {
  7723. // The fragment stays with the client (RFC 9110 §7.1).
  7724. auto target = uri.substr(0, uri.find('#'));
  7725. // `substr(0, npos)` yields the whole string, which is what the no-query
  7726. // case needs.
  7727. auto query_pos = target.find('?');
  7728. auto path_part = target.substr(0, query_pos);
  7729. std::string query_part;
  7730. if (query_pos != std::string::npos) {
  7731. query_part = target.substr(query_pos + 1);
  7732. }
  7733. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7734. if (!query_part.empty()) {
  7735. // When path encoding is disabled the caller has supplied an already-encoded
  7736. // target and expects the exact bytes to be sent on the wire, so skip
  7737. // normalization for the query too. Normalizing would decode-then-re-encode
  7738. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7739. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7740. if (path_encode) {
  7741. auto normalized = normalize_query_string(query_part);
  7742. if (!normalized.empty()) {
  7743. result += '?';
  7744. result += normalized;
  7745. }
  7746. } else {
  7747. result += '?';
  7748. result += query_part;
  7749. }
  7750. }
  7751. return result;
  7752. }
  7753. inline bool parse_multipart_boundary(const std::string &content_type,
  7754. std::string &boundary) {
  7755. std::map<std::string, std::string> params;
  7756. extract_media_type(content_type, &params);
  7757. auto it = params.find("boundary");
  7758. if (it == params.end()) { return false; }
  7759. boundary = it->second;
  7760. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7761. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7762. // bytes costs a nearly full comparison at nearly every position: the
  7763. // boundary's length multiplies the worst-case cost of scanning a body.
  7764. return !boundary.empty() && boundary.size() <= 70;
  7765. }
  7766. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  7767. // here, as browsers send any other backslash, such as one in a Windows path,
  7768. // as it is.
  7769. inline std::string unquote_disposition_param(const std::string &s) {
  7770. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  7771. std::string out;
  7772. for (size_t i = 1; i + 1 < s.size(); i++) {
  7773. if (s[i] == '\\' && i + 2 < s.size() &&
  7774. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  7775. i++;
  7776. }
  7777. out += s[i];
  7778. }
  7779. return out;
  7780. }
  7781. inline void parse_disposition_params(const std::string &s, Params &params) {
  7782. std::set<std::string> cache;
  7783. split_unquoted(s.data(), s.data() + s.size(), ';',
  7784. [&](const char *b, const char *e) {
  7785. std::string kv(b, e);
  7786. if (cache.find(kv) != cache.end()) { return; }
  7787. cache.insert(kv);
  7788. std::string key;
  7789. std::string val;
  7790. divide_param_pair(b, e, key, val);
  7791. if (!key.empty()) {
  7792. params.emplace(trim_double_quotes_copy(key),
  7793. unquote_disposition_param(val));
  7794. }
  7795. });
  7796. }
  7797. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7798. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7799. #else
  7800. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7801. #endif
  7802. auto is_valid = [](const std::string &str) {
  7803. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7804. };
  7805. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7806. const auto pos = static_cast<size_t>(6);
  7807. const auto len = static_cast<size_t>(s.size() - 6);
  7808. auto all_valid_ranges = true;
  7809. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7810. if (!all_valid_ranges) { return; }
  7811. const auto it = std::find(b, e, '-');
  7812. if (it == e) {
  7813. all_valid_ranges = false;
  7814. return;
  7815. }
  7816. const auto lhs = std::string(b, it);
  7817. const auto rhs = std::string(it + 1, e);
  7818. if (!is_valid(lhs) || !is_valid(rhs)) {
  7819. all_valid_ranges = false;
  7820. return;
  7821. }
  7822. ssize_t first = -1;
  7823. if (!lhs.empty()) {
  7824. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7825. // would turn the range into a suffix range.
  7826. auto res =
  7827. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7828. if (res.ec != std::errc{}) {
  7829. all_valid_ranges = false;
  7830. return;
  7831. }
  7832. }
  7833. ssize_t last = -1;
  7834. if (!rhs.empty()) {
  7835. // An overflowing last-byte-pos is past any content length, so keeping
  7836. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7837. ssize_t v;
  7838. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7839. if (res.ec == std::errc{}) { last = v; }
  7840. }
  7841. if ((first == -1 && last == -1) ||
  7842. (first != -1 && last != -1 && first > last)) {
  7843. all_valid_ranges = false;
  7844. return;
  7845. }
  7846. ranges.emplace_back(first, last);
  7847. });
  7848. return all_valid_ranges && !ranges.empty();
  7849. }
  7850. return false;
  7851. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7852. }
  7853. #else
  7854. } catch (...) { return false; }
  7855. #endif
  7856. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7857. inline std::string remove_quoted_strings(const std::string &s) {
  7858. std::string out;
  7859. auto in_quotes = false;
  7860. for (size_t i = 0; i < s.size(); i++) {
  7861. if (s[i] == '"') {
  7862. in_quotes = !in_quotes;
  7863. } else if (!in_quotes) {
  7864. out += s[i];
  7865. } else if (s[i] == '\\') {
  7866. i++;
  7867. }
  7868. }
  7869. return out;
  7870. }
  7871. inline bool parse_accept_header(const std::string &s,
  7872. std::vector<std::string> &content_types) {
  7873. // Parameter values are not used here, so a quoted-string is dropped rather
  7874. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  7875. if (s.find('"') != std::string::npos) {
  7876. return parse_accept_header(remove_quoted_strings(s), content_types);
  7877. }
  7878. content_types.clear();
  7879. // Empty string is considered valid (no preference)
  7880. if (s.empty()) { return true; }
  7881. struct AcceptEntry {
  7882. std::string media_type;
  7883. double quality;
  7884. int order;
  7885. };
  7886. std::vector<AcceptEntry> entries;
  7887. int order = 0;
  7888. bool has_invalid_entry = false;
  7889. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7890. // has to parse and ignore empty list elements, so a leading, trailing or
  7891. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7892. // split() skips them, and the header length limit bounds how many a sender
  7893. // can send, so ignoring all of them cannot be used as a denial-of-service
  7894. // vector.
  7895. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7896. std::string entry(b, e);
  7897. entry = trim_copy(entry);
  7898. AcceptEntry accept_entry;
  7899. accept_entry.order = order++;
  7900. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7901. accept_entry.media_type, accept_entry.quality)) {
  7902. has_invalid_entry = true;
  7903. return;
  7904. }
  7905. // Remove additional parameters from media type
  7906. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7907. // Basic validation of media type format
  7908. if (accept_entry.media_type.empty()) {
  7909. has_invalid_entry = true;
  7910. return;
  7911. }
  7912. // Check for basic media type format (should contain '/' or be '*')
  7913. if (accept_entry.media_type != "*" &&
  7914. accept_entry.media_type.find('/') == std::string::npos) {
  7915. has_invalid_entry = true;
  7916. return;
  7917. }
  7918. entries.push_back(std::move(accept_entry));
  7919. });
  7920. // Return false if any invalid entry was found
  7921. if (has_invalid_entry) { return false; }
  7922. // Sort by quality (descending), then by original order (ascending)
  7923. std::sort(entries.begin(), entries.end(),
  7924. [](const AcceptEntry &a, const AcceptEntry &b) {
  7925. if (a.quality != b.quality) {
  7926. return a.quality > b.quality; // Higher quality first
  7927. }
  7928. return a.order < b.order; // Earlier order first for same quality
  7929. });
  7930. // Extract sorted media types
  7931. content_types.reserve(entries.size());
  7932. for (auto &entry : entries) {
  7933. content_types.push_back(std::move(entry.media_type));
  7934. }
  7935. return true;
  7936. }
  7937. class FormDataParser {
  7938. public:
  7939. FormDataParser() = default;
  7940. void set_boundary(std::string &&boundary) {
  7941. boundary_ = std::move(boundary);
  7942. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7943. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7944. }
  7945. bool is_valid() const { return is_valid_; }
  7946. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7947. const ContentReceiver &content_callback) {
  7948. // Once the close delimiter has been seen the rest of the body is epilogue
  7949. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7950. // spread across reads is not copied in only to be erased right away.
  7951. if (state_ == 5) { return true; }
  7952. buf_append(buf, n);
  7953. while (buf_size() > 0) {
  7954. switch (state_) {
  7955. case 0: { // Initial boundary
  7956. auto pos = buf_find(dash_boundary_crlf_);
  7957. if (pos == buf_size()) {
  7958. // Not found yet: keep only a possible partial boundary at the tail so
  7959. // that a body which never contains the boundary cannot grow the
  7960. // buffer (and get rescanned from the start) without bound.
  7961. auto keep = dash_boundary_crlf_.size() - 1;
  7962. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7963. return true;
  7964. }
  7965. buf_erase(pos + dash_boundary_crlf_.size());
  7966. state_ = 1;
  7967. break;
  7968. }
  7969. case 1: { // New entry
  7970. clear_file_info();
  7971. header_searched_ = 0;
  7972. state_ = 2;
  7973. break;
  7974. }
  7975. case 2: { // Headers
  7976. // Resume where the last call stopped looking, so that a line arriving
  7977. // a few bytes at a time is not searched from its start each time.
  7978. auto pos = buf_find(crlf_, header_searched_);
  7979. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7980. while (pos < buf_size()) {
  7981. // Empty line
  7982. if (pos == 0) {
  7983. if (!header_callback(file_)) {
  7984. is_valid_ = false;
  7985. return false;
  7986. }
  7987. buf_erase(crlf_.size());
  7988. state_ = 3;
  7989. break;
  7990. }
  7991. // Check header count limit
  7992. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7993. is_valid_ = false;
  7994. return false;
  7995. }
  7996. header_count_++;
  7997. const auto header = buf_head(pos);
  7998. if (!parse_header(header.data(), header.data() + header.size(),
  7999. [&](const std::string &, const std::string &) {})) {
  8000. is_valid_ = false;
  8001. return false;
  8002. }
  8003. // Parse and emplace space trimmed headers into a map
  8004. if (!parse_header(
  8005. header.data(), header.data() + header.size(),
  8006. [&](const std::string &key, const std::string &val) {
  8007. file_.headers.emplace(key, val);
  8008. })) {
  8009. is_valid_ = false;
  8010. return false;
  8011. }
  8012. constexpr const char header_content_type[] = "Content-Type:";
  8013. if (start_with_case_ignore(header, header_content_type)) {
  8014. file_.content_type =
  8015. trim_copy(header.substr(str_len(header_content_type)));
  8016. } else {
  8017. std::string disposition_params;
  8018. if (parse_content_disposition(header, disposition_params)) {
  8019. Params params;
  8020. parse_disposition_params(disposition_params, params);
  8021. auto it = params.find("name");
  8022. if (it != params.end()) {
  8023. file_.name = it->second;
  8024. } else {
  8025. is_valid_ = false;
  8026. return false;
  8027. }
  8028. it = params.find("filename");
  8029. if (it != params.end()) { file_.filename = it->second; }
  8030. it = params.find("filename*");
  8031. if (it != params.end()) {
  8032. // RFC 5987: only UTF-8 encoding is allowed
  8033. const auto &val = it->second;
  8034. constexpr const char utf8_prefix[] = "UTF-8''";
  8035. constexpr size_t prefix_len = str_len(utf8_prefix);
  8036. if (val.size() > prefix_len &&
  8037. start_with_case_ignore(val, utf8_prefix)) {
  8038. file_.filename = decode_path_component(
  8039. val.substr(prefix_len)); // override...
  8040. } else {
  8041. is_valid_ = false;
  8042. return false;
  8043. }
  8044. }
  8045. }
  8046. }
  8047. buf_erase(pos + crlf_.size());
  8048. pos = buf_find(crlf_);
  8049. }
  8050. if (state_ != 3) {
  8051. // The CR of the CRLF may be the last byte so far.
  8052. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8053. return true;
  8054. }
  8055. break;
  8056. }
  8057. case 3: { // Body
  8058. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8059. auto pos = buf_find(crlf_dash_boundary_);
  8060. if (pos < buf_size()) {
  8061. if (!content_callback(buf_data(), pos)) {
  8062. is_valid_ = false;
  8063. return false;
  8064. }
  8065. buf_erase(pos + crlf_dash_boundary_.size());
  8066. state_ = 4;
  8067. } else {
  8068. auto len = buf_size() - crlf_dash_boundary_.size();
  8069. if (len > 0) {
  8070. if (!content_callback(buf_data(), len)) {
  8071. is_valid_ = false;
  8072. return false;
  8073. }
  8074. buf_erase(len);
  8075. }
  8076. return true;
  8077. }
  8078. break;
  8079. }
  8080. case 4: { // Boundary
  8081. if (crlf_.size() > buf_size()) { return true; }
  8082. if (buf_start_with(crlf_)) {
  8083. buf_erase(crlf_.size());
  8084. state_ = 1;
  8085. } else if (buf_start_with(dash_)) {
  8086. buf_erase(dash_.size());
  8087. is_valid_ = true;
  8088. state_ = 5;
  8089. } else {
  8090. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8091. // accepted after a boundary; RFC 2046 allows transport-padding in
  8092. // between, but this parser has never supported it. Either way the
  8093. // body is already destined to be rejected, so fail now instead of
  8094. // buffering the rest of it. Both are two bytes, so the check above
  8095. // already guarantees enough buffered data to decide.
  8096. is_valid_ = false;
  8097. return false;
  8098. }
  8099. break;
  8100. }
  8101. case 5: { // Epilogue
  8102. buf_erase(buf_size());
  8103. break;
  8104. }
  8105. }
  8106. }
  8107. return true;
  8108. }
  8109. private:
  8110. void clear_file_info() {
  8111. file_.name.clear();
  8112. file_.filename.clear();
  8113. file_.content_type.clear();
  8114. file_.headers.clear();
  8115. header_count_ = 0;
  8116. }
  8117. bool start_with_case_ignore(const std::string &a, const char *b,
  8118. size_t offset = 0) const {
  8119. const auto b_len = strlen(b);
  8120. if (a.size() < offset + b_len) { return false; }
  8121. for (size_t i = 0; i < b_len; i++) {
  8122. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8123. return false;
  8124. }
  8125. }
  8126. return true;
  8127. }
  8128. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8129. // Returns true if header matches, with the params portion in `params_out`.
  8130. bool parse_content_disposition(const std::string &header,
  8131. std::string &params_out) const {
  8132. constexpr const char prefix[] = "Content-Disposition:";
  8133. constexpr size_t prefix_len = str_len(prefix);
  8134. if (!start_with_case_ignore(header, prefix)) { return false; }
  8135. // Skip whitespace after "Content-Disposition:"
  8136. auto pos = prefix_len;
  8137. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8138. pos++;
  8139. }
  8140. // Match "form-data;" (case-insensitive)
  8141. constexpr const char form_data[] = "form-data;";
  8142. constexpr size_t form_data_len = str_len(form_data);
  8143. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8144. pos += form_data_len;
  8145. // Skip whitespace after "form-data;"
  8146. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8147. pos++;
  8148. }
  8149. params_out = header.substr(pos);
  8150. return true;
  8151. }
  8152. const std::string dash_ = "--";
  8153. const std::string crlf_ = "\r\n";
  8154. std::string boundary_;
  8155. std::string dash_boundary_crlf_;
  8156. std::string crlf_dash_boundary_;
  8157. size_t state_ = 0;
  8158. bool is_valid_ = false;
  8159. FormData file_;
  8160. size_t header_count_ = 0;
  8161. size_t header_searched_ = 0;
  8162. // Buffer
  8163. bool start_with(const std::string &a, size_t spos, size_t epos,
  8164. const std::string &b) const {
  8165. if (epos - spos < b.size()) { return false; }
  8166. for (size_t i = 0; i < b.size(); i++) {
  8167. if (a[i + spos] != b[i]) { return false; }
  8168. }
  8169. return true;
  8170. }
  8171. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8172. const char *buf_data() const { return &buf_[buf_spos_]; }
  8173. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8174. bool buf_start_with(const std::string &s) const {
  8175. return start_with(buf_, buf_spos_, buf_epos_, s);
  8176. }
  8177. size_t buf_find(const std::string &s, size_t from = 0) const {
  8178. auto c = s.front();
  8179. size_t off = buf_spos_ + from;
  8180. while (off < buf_epos_) {
  8181. auto pos = off;
  8182. while (true) {
  8183. if (pos == buf_epos_) { return buf_size(); }
  8184. if (buf_[pos] == c) { break; }
  8185. pos++;
  8186. }
  8187. auto remaining_size = buf_epos_ - pos;
  8188. if (s.size() > remaining_size) { return buf_size(); }
  8189. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8190. off = pos + 1;
  8191. }
  8192. return buf_size();
  8193. }
  8194. void buf_append(const char *data, size_t n) {
  8195. auto remaining_size = buf_size();
  8196. if (remaining_size > 0 && buf_spos_ > 0) {
  8197. for (size_t i = 0; i < remaining_size; i++) {
  8198. buf_[i] = buf_[buf_spos_ + i];
  8199. }
  8200. }
  8201. buf_spos_ = 0;
  8202. buf_epos_ = remaining_size;
  8203. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8204. for (size_t i = 0; i < n; i++) {
  8205. buf_[buf_epos_ + i] = data[i];
  8206. }
  8207. buf_epos_ += n;
  8208. }
  8209. void buf_erase(size_t size) { buf_spos_ += size; }
  8210. std::string buf_;
  8211. size_t buf_spos_ = 0;
  8212. size_t buf_epos_ = 0;
  8213. };
  8214. inline std::string random_string(size_t length) {
  8215. constexpr const char data[] =
  8216. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8217. std::string result(length, '\0');
  8218. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8219. for (auto &c : result) {
  8220. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8221. }
  8222. return result;
  8223. }
  8224. inline std::string make_multipart_data_boundary() {
  8225. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8226. }
  8227. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8228. auto valid = true;
  8229. for (size_t i = 0; i < boundary.size(); i++) {
  8230. auto c = boundary[i];
  8231. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8232. valid = false;
  8233. break;
  8234. }
  8235. }
  8236. return valid;
  8237. }
  8238. // Escape a multipart field name/filename following the WHATWG HTML standard
  8239. // ("escape a multipart form-data name"), which is what browsers send:
  8240. // '"' -> %22, CR -> %0D, LF -> %0A
  8241. // With escape_quote = false, only CR and LF are escaped; this is for header
  8242. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8243. inline std::string escape_multipart_field(const std::string &s,
  8244. bool escape_quote = true) {
  8245. std::string result;
  8246. result.reserve(s.size());
  8247. for (auto c : s) {
  8248. switch (c) {
  8249. case '"':
  8250. if (escape_quote) {
  8251. result += "%22";
  8252. } else {
  8253. result += c;
  8254. }
  8255. break;
  8256. case '\r': result += "%0D"; break;
  8257. case '\n': result += "%0A"; break;
  8258. default: result += c; break;
  8259. }
  8260. }
  8261. return result;
  8262. }
  8263. template <typename T>
  8264. inline std::string
  8265. serialize_multipart_formdata_item_begin(const T &item,
  8266. const std::string &boundary) {
  8267. std::string body = "--" + boundary + "\r\n";
  8268. body += "Content-Disposition: form-data; name=\"" +
  8269. escape_multipart_field(item.name) + "\"";
  8270. if (!item.filename.empty()) {
  8271. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8272. }
  8273. body += "\r\n";
  8274. if (!item.content_type.empty()) {
  8275. body +=
  8276. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8277. "\r\n";
  8278. }
  8279. body += "\r\n";
  8280. return body;
  8281. }
  8282. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8283. inline std::string
  8284. serialize_multipart_formdata_finish(const std::string &boundary) {
  8285. return "--" + boundary + "--\r\n";
  8286. }
  8287. inline std::string
  8288. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8289. return "multipart/form-data; boundary=" + boundary;
  8290. }
  8291. inline std::string
  8292. serialize_multipart_formdata(const UploadFormDataItems &items,
  8293. const std::string &boundary, bool finish = true) {
  8294. std::string body;
  8295. for (const auto &item : items) {
  8296. body += serialize_multipart_formdata_item_begin(item, boundary);
  8297. body += item.content + serialize_multipart_formdata_item_end();
  8298. }
  8299. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8300. return body;
  8301. }
  8302. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8303. const std::string &boundary) {
  8304. size_t total = 0;
  8305. for (const auto &item : items) {
  8306. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8307. total += item.content.size();
  8308. total += serialize_multipart_formdata_item_end().size();
  8309. }
  8310. total += serialize_multipart_formdata_finish(boundary).size();
  8311. return total;
  8312. }
  8313. struct MultipartSegment {
  8314. const char *data;
  8315. size_t size;
  8316. };
  8317. // NOTE: items must outlive the returned ContentProvider
  8318. // (safe for synchronous use inside Post/Put/Patch)
  8319. inline ContentProvider
  8320. make_multipart_content_provider(const UploadFormDataItems &items,
  8321. const std::string &boundary) {
  8322. // Own the per-item header strings and the finish string
  8323. std::vector<std::string> owned;
  8324. owned.reserve(items.size() + 1);
  8325. for (const auto &item : items)
  8326. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8327. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8328. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8329. std::vector<MultipartSegment> segs;
  8330. segs.reserve(items.size() * 3 + 1);
  8331. static const char crlf[] = "\r\n";
  8332. for (size_t i = 0; i < items.size(); i++) {
  8333. segs.push_back({owned[i].data(), owned[i].size()});
  8334. segs.push_back({items[i].content.data(), items[i].content.size()});
  8335. segs.push_back({crlf, 2});
  8336. }
  8337. segs.push_back({owned.back().data(), owned.back().size()});
  8338. struct MultipartState {
  8339. std::vector<std::string> owned;
  8340. std::vector<MultipartSegment> segs;
  8341. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8342. };
  8343. auto state = std::make_shared<MultipartState>();
  8344. state->owned = std::move(owned);
  8345. // `segs` holds raw pointers into owned strings; std::string move preserves
  8346. // the data pointer, so these pointers remain valid after the move above.
  8347. state->segs = std::move(segs);
  8348. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8349. // Buffer multiple small segments into fewer, larger writes to avoid
  8350. // excessive TCP packets when there are many form data items (#2410)
  8351. auto &buf = state->buf;
  8352. auto buf_size = buf.size();
  8353. size_t buf_len = 0;
  8354. size_t remaining = length;
  8355. // Find the first segment containing 'offset'
  8356. size_t pos = 0;
  8357. size_t seg_idx = 0;
  8358. for (; seg_idx < state->segs.size(); seg_idx++) {
  8359. const auto &seg = state->segs[seg_idx];
  8360. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8361. pos += seg.size;
  8362. }
  8363. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8364. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8365. const auto &seg = state->segs[seg_idx];
  8366. size_t available = seg.size - seg_offset;
  8367. size_t to_copy = (std::min)(available, remaining);
  8368. const char *src = seg.data + seg_offset;
  8369. seg_offset = 0; // only the first segment has a non-zero offset
  8370. while (to_copy > 0) {
  8371. size_t space = buf_size - buf_len;
  8372. size_t chunk = (std::min)(to_copy, space);
  8373. std::memcpy(buf.data() + buf_len, src, chunk);
  8374. buf_len += chunk;
  8375. src += chunk;
  8376. to_copy -= chunk;
  8377. remaining -= chunk;
  8378. if (buf_len == buf_size) {
  8379. if (!sink.write(buf.data(), buf_len)) { return false; }
  8380. buf_len = 0;
  8381. }
  8382. }
  8383. }
  8384. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8385. return true;
  8386. };
  8387. }
  8388. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8389. if (ranges.size() <= 1) return;
  8390. // Sort ranges by start position
  8391. std::sort(ranges.begin(), ranges.end(),
  8392. [](const Range &a, const Range &b) { return a.first < b.first; });
  8393. Ranges coalesced;
  8394. coalesced.reserve(ranges.size());
  8395. for (auto &r : ranges) {
  8396. auto first_pos = r.first;
  8397. auto last_pos = r.second;
  8398. // Handle special cases like in range_error
  8399. if (first_pos == -1 && last_pos == -1) {
  8400. first_pos = 0;
  8401. last_pos = static_cast<ssize_t>(content_length);
  8402. }
  8403. if (first_pos == -1) {
  8404. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8405. last_pos = static_cast<ssize_t>(content_length) - 1;
  8406. }
  8407. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8408. last_pos = static_cast<ssize_t>(content_length) - 1;
  8409. }
  8410. // Skip invalid ranges
  8411. if (!(0 <= first_pos && first_pos <= last_pos &&
  8412. last_pos < static_cast<ssize_t>(content_length))) {
  8413. continue;
  8414. }
  8415. // Coalesce with previous range if overlapping or adjacent (but not
  8416. // identical)
  8417. if (!coalesced.empty()) {
  8418. auto &prev = coalesced.back();
  8419. // Check if current range overlaps or is adjacent to previous range
  8420. // but don't coalesce identical ranges (allow duplicates)
  8421. if (first_pos <= prev.second + 1 &&
  8422. !(first_pos == prev.first && last_pos == prev.second)) {
  8423. // Extend the previous range
  8424. prev.second = (std::max)(prev.second, last_pos);
  8425. continue;
  8426. }
  8427. }
  8428. // Add new range
  8429. coalesced.emplace_back(first_pos, last_pos);
  8430. }
  8431. ranges = std::move(coalesced);
  8432. }
  8433. inline bool range_error(Request &req, Response &res) {
  8434. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8435. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8436. req.ranges.clear();
  8437. if (res.status == StatusCode::PartialContent_206) {
  8438. res.status = StatusCode::OK_200;
  8439. }
  8440. return false;
  8441. }
  8442. ssize_t content_len = static_cast<ssize_t>(
  8443. res.content_length_ ? res.content_length_ : res.body.size());
  8444. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8445. size_t overwrapping_count = 0;
  8446. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8447. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8448. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8449. // Too many ranges
  8450. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8451. for (auto &r : req.ranges) {
  8452. auto &first_pos = r.first;
  8453. auto &last_pos = r.second;
  8454. if (first_pos == -1 && last_pos == -1) {
  8455. first_pos = 0;
  8456. last_pos = content_len;
  8457. }
  8458. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8459. // selects the entire representation.
  8460. if (first_pos == -1) {
  8461. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8462. last_pos = content_len - 1;
  8463. }
  8464. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8465. // A client can limit the number of bytes requested without knowing the
  8466. // size of the selected representation. If the last-pos value is absent,
  8467. // or if the value is greater than or equal to the current length of the
  8468. // representation data, the byte range is interpreted as the remainder of
  8469. // the representation (i.e., the server replaces the value of last-pos
  8470. // with a value that is one less than the current length of the selected
  8471. // representation).
  8472. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8473. if (last_pos == -1 || last_pos >= content_len) {
  8474. last_pos = content_len - 1;
  8475. }
  8476. // Range must be within content length
  8477. if (!(0 <= first_pos && first_pos <= last_pos &&
  8478. last_pos <= content_len - 1)) {
  8479. return true;
  8480. }
  8481. // Request must not have more than two overlapping ranges
  8482. for (const auto &processed_range : processed_ranges) {
  8483. if (!(last_pos < processed_range.first ||
  8484. first_pos > processed_range.second)) {
  8485. overwrapping_count++;
  8486. if (overwrapping_count > 2) { return true; }
  8487. break; // Only count once per range
  8488. }
  8489. }
  8490. processed_ranges.emplace_back(first_pos, last_pos);
  8491. }
  8492. // After validation, coalesce overlapping ranges as per RFC 9110
  8493. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8494. }
  8495. return false;
  8496. }
  8497. inline std::pair<size_t, size_t>
  8498. get_range_offset_and_length(Range r, size_t content_length) {
  8499. assert(r.first != -1 && r.second != -1);
  8500. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8501. assert(r.first <= r.second &&
  8502. r.second < static_cast<ssize_t>(content_length));
  8503. (void)(content_length);
  8504. return std::make_pair(static_cast<size_t>(r.first),
  8505. static_cast<size_t>(r.second - r.first) + 1);
  8506. }
  8507. inline std::string make_content_range_header_field(
  8508. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8509. auto st = offset_and_length.first;
  8510. auto ed = st + offset_and_length.second - 1;
  8511. std::string field = "bytes ";
  8512. field += std::to_string(st);
  8513. field += '-';
  8514. field += std::to_string(ed);
  8515. field += '/';
  8516. field += std::to_string(content_length);
  8517. return field;
  8518. }
  8519. template <typename SToken, typename CToken, typename Content>
  8520. bool process_multipart_ranges_data(const Request &req,
  8521. const std::string &boundary,
  8522. const std::string &content_type,
  8523. size_t content_length, SToken stoken,
  8524. CToken ctoken, Content content) {
  8525. for (size_t i = 0; i < req.ranges.size(); i++) {
  8526. ctoken("--");
  8527. stoken(boundary);
  8528. ctoken("\r\n");
  8529. if (!content_type.empty()) {
  8530. ctoken("Content-Type: ");
  8531. stoken(content_type);
  8532. ctoken("\r\n");
  8533. }
  8534. auto offset_and_length =
  8535. get_range_offset_and_length(req.ranges[i], content_length);
  8536. ctoken("Content-Range: ");
  8537. stoken(make_content_range_header_field(offset_and_length, content_length));
  8538. ctoken("\r\n");
  8539. ctoken("\r\n");
  8540. if (!content(offset_and_length.first, offset_and_length.second)) {
  8541. return false;
  8542. }
  8543. ctoken("\r\n");
  8544. }
  8545. ctoken("--");
  8546. stoken(boundary);
  8547. ctoken("--");
  8548. return true;
  8549. }
  8550. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8551. const std::string &boundary,
  8552. const std::string &content_type,
  8553. size_t content_length,
  8554. std::string &data) {
  8555. process_multipart_ranges_data(
  8556. req, boundary, content_type, content_length,
  8557. [&](const std::string &token) { data += token; },
  8558. [&](const std::string &token) { data += token; },
  8559. [&](size_t offset, size_t length) {
  8560. assert(offset + length <= content_length);
  8561. data += res.body.substr(offset, length);
  8562. return true;
  8563. });
  8564. }
  8565. inline size_t get_multipart_ranges_data_length(const Request &req,
  8566. const std::string &boundary,
  8567. const std::string &content_type,
  8568. size_t content_length) {
  8569. size_t data_length = 0;
  8570. process_multipart_ranges_data(
  8571. req, boundary, content_type, content_length,
  8572. [&](const std::string &token) { data_length += token.size(); },
  8573. [&](const std::string &token) { data_length += token.size(); },
  8574. [&](size_t /*offset*/, size_t length) {
  8575. data_length += length;
  8576. return true;
  8577. });
  8578. return data_length;
  8579. }
  8580. template <typename T>
  8581. inline bool
  8582. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8583. const std::string &boundary,
  8584. const std::string &content_type,
  8585. size_t content_length, const T &is_shutting_down) {
  8586. return process_multipart_ranges_data(
  8587. req, boundary, content_type, content_length,
  8588. [&](const std::string &token) { strm.write(token); },
  8589. [&](const std::string &token) { strm.write(token); },
  8590. [&](size_t offset, size_t length) {
  8591. return write_content(strm, res.content_provider_, offset, length,
  8592. is_shutting_down);
  8593. });
  8594. }
  8595. inline bool has_framed_body(const Request &req) {
  8596. return is_chunked_transfer_encoding(req.headers) ||
  8597. req.get_header_value_u64("Content-Length") > 0;
  8598. }
  8599. inline bool is_connection_persistent(const Request &req) {
  8600. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8601. if (req.version == "HTTP/1.0" &&
  8602. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8603. return false;
  8604. }
  8605. return true;
  8606. }
  8607. inline bool expect_content(const Request &req) {
  8608. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8609. req.method == "DELETE") {
  8610. return true;
  8611. }
  8612. return has_framed_body(req);
  8613. }
  8614. #ifdef _WIN32
  8615. class WSInit {
  8616. public:
  8617. WSInit() {
  8618. WSADATA wsaData;
  8619. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8620. }
  8621. ~WSInit() {
  8622. if (is_valid_) WSACleanup();
  8623. }
  8624. bool is_valid_ = false;
  8625. };
  8626. static WSInit wsinit_;
  8627. #endif
  8628. // RFC 9110 Section 11.6.1 defines a challenge list as
  8629. // WWW-Authenticate = #challenge
  8630. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8631. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8632. // so a server may offer several schemes, each with its own comma-separated
  8633. // auth-param list, in either order and either as separate field lines or
  8634. // packed into one. Splitting on every comma would break apart a challenge's
  8635. // own param list; splitting only on the first space would miss a Digest
  8636. // challenge that isn't first. Split on commas that aren't inside a
  8637. // quoted-string instead, then track which scheme each resulting segment
  8638. // belongs to: a segment whose text before "=" contains whitespace (or that
  8639. // has no "=" at all) starts a new challenge named by its leading token.
  8640. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8641. std::vector<std::string> segments;
  8642. size_t start = 0;
  8643. auto in_quotes = false;
  8644. for (size_t i = 0; i < s.size(); i++) {
  8645. auto c = s[i];
  8646. if (in_quotes) {
  8647. if (c == '\\' && i + 1 < s.size()) {
  8648. i++;
  8649. } else if (c == '"') {
  8650. in_quotes = false;
  8651. }
  8652. } else if (c == '"') {
  8653. in_quotes = true;
  8654. } else if (c == ',') {
  8655. segments.push_back(s.substr(start, i - start));
  8656. start = i + 1;
  8657. }
  8658. }
  8659. segments.push_back(s.substr(start));
  8660. return segments;
  8661. }
  8662. inline std::string unescape_quoted_pairs(const std::string &s) {
  8663. std::string out;
  8664. out.reserve(s.size());
  8665. for (size_t i = 0; i < s.size(); i++) {
  8666. if (s[i] == '\\' && i + 1 < s.size()) {
  8667. out += s[++i];
  8668. } else {
  8669. out += s[i];
  8670. }
  8671. }
  8672. return out;
  8673. }
  8674. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8675. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8676. // quoted-pair, so the recipient recovers the original value.
  8677. inline std::string escape_quoted_pairs(const std::string &s) {
  8678. std::string out;
  8679. out.reserve(s.size());
  8680. for (auto c : s) {
  8681. if (c == '\\' || c == '"') { out += '\\'; }
  8682. out += c;
  8683. }
  8684. return out;
  8685. }
  8686. inline bool parse_www_authenticate(const Response &res,
  8687. std::map<std::string, std::string> &auth,
  8688. bool is_proxy) {
  8689. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8690. auto combined = get_combined_header_value(res.headers, auth_key);
  8691. if (combined.empty()) { return false; }
  8692. auto found_digest = false;
  8693. auto in_digest_challenge = false;
  8694. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8695. auto segment = trim_copy(raw_segment);
  8696. if (segment.empty()) { continue; }
  8697. auto eq_pos = segment.find('=');
  8698. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8699. // for the first segment of a challenge, "<scheme> <key>") must be
  8700. // trimmed before its boundaries are inspected.
  8701. auto key_part = trim_copy(
  8702. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8703. auto space_pos = key_part.find_last_of(" \t");
  8704. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8705. // "<scheme>[ <key>]" starts a new challenge.
  8706. auto scheme_end =
  8707. space_pos == std::string::npos ? key_part.size() : space_pos;
  8708. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8709. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8710. // from one challenge is never paired with another's algorithm.
  8711. in_digest_challenge =
  8712. !found_digest &&
  8713. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8714. if (in_digest_challenge) { found_digest = true; }
  8715. if (space_pos == std::string::npos) {
  8716. // Bare scheme (or a token68), no auth-param on this segment.
  8717. continue;
  8718. }
  8719. key_part = key_part.substr(space_pos + 1);
  8720. }
  8721. if (!in_digest_challenge) { continue; }
  8722. auto val = trim_copy(segment.substr(eq_pos + 1));
  8723. auto unquoted = trim_double_quotes_copy(val);
  8724. if (unquoted.size() != val.size()) {
  8725. unquoted = unescape_quoted_pairs(unquoted);
  8726. }
  8727. auth[std::move(key_part)] = std::move(unquoted);
  8728. }
  8729. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8730. // make_digest_authentication_header() dereferences both unconditionally, so
  8731. // a challenge missing either can't produce a usable Authorization header.
  8732. // Treat it the same as no Digest challenge at all.
  8733. return found_digest && auth.find("realm") != auth.end() &&
  8734. auth.find("nonce") != auth.end();
  8735. }
  8736. class ContentProviderAdapter {
  8737. public:
  8738. explicit ContentProviderAdapter(
  8739. ContentProviderWithoutLength &&content_provider)
  8740. : content_provider_(std::move(content_provider)) {}
  8741. bool operator()(size_t offset, size_t, DataSink &sink) {
  8742. return content_provider_(offset, sink);
  8743. }
  8744. private:
  8745. ContentProviderWithoutLength content_provider_;
  8746. };
  8747. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8748. namespace fields {
  8749. inline bool is_token_char(char c) {
  8750. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8751. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8752. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8753. }
  8754. inline bool is_token(const std::string &s) {
  8755. if (s.empty()) { return false; }
  8756. for (auto c : s) {
  8757. if (!is_token_char(c)) { return false; }
  8758. }
  8759. return true;
  8760. }
  8761. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8762. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8763. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8764. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8765. inline bool is_field_content(const std::string &s) {
  8766. if (s.empty()) { return true; }
  8767. if (s.size() == 1) {
  8768. return is_field_vchar(s[0]);
  8769. } else if (s.size() == 2) {
  8770. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8771. } else {
  8772. size_t i = 0;
  8773. if (!is_field_vchar(s[i])) { return false; }
  8774. i++;
  8775. while (i < s.size() - 1) {
  8776. auto c = s[i++];
  8777. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8778. } else {
  8779. return false;
  8780. }
  8781. }
  8782. return is_field_vchar(s[i]);
  8783. }
  8784. }
  8785. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8786. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8787. return is_field_name(name) && is_field_value(value);
  8788. }
  8789. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8790. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8791. inline bool is_request_target(const std::string &s) {
  8792. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8793. }
  8794. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8795. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8796. inline bool is_host(const std::string &s) {
  8797. return std::all_of(s.begin(), s.end(), [](char c) {
  8798. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8799. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8800. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8801. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8802. });
  8803. }
  8804. } // namespace fields
  8805. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8806. WebSocketUpgradeResponse &upgrade) {
  8807. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8808. std::string key_bytes(16, '\0');
  8809. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8810. key_bytes.size());
  8811. auto client_key = base64_encode(key_bytes);
  8812. req.headers.erase("Upgrade");
  8813. req.headers.erase("Connection");
  8814. req.headers.erase("Sec-WebSocket-Key");
  8815. req.headers.erase("Sec-WebSocket-Version");
  8816. req.headers.emplace("Upgrade", "websocket");
  8817. req.headers.emplace("Connection", "Upgrade");
  8818. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8819. req.headers.emplace("Sec-WebSocket-Version", "13");
  8820. // Build the request in memory first, like ClientImpl::write_request does.
  8821. // Writing straight to the socket would leak a request line onto the wire
  8822. // before check_and_write_headers gets a chance to reject an invalid header,
  8823. // and would emit one small write per header.
  8824. BufferStream bstrm;
  8825. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8826. upgrade.error = Error::Write;
  8827. return false;
  8828. }
  8829. auto error = Error::Success;
  8830. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8831. upgrade.error = error;
  8832. return false;
  8833. }
  8834. const auto &data = bstrm.get_buffer();
  8835. if (!write_data(strm, data.data(), data.size())) {
  8836. upgrade.error = Error::Write;
  8837. return false;
  8838. }
  8839. // Verify 101 response and Sec-WebSocket-Accept header
  8840. auto expected_accept = websocket_accept_key(client_key);
  8841. auto offered_subprotocols =
  8842. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8843. return read_websocket_upgrade_response(strm, expected_accept,
  8844. offered_subprotocols, upgrade);
  8845. }
  8846. inline bool is_ip_address(const std::string &host) {
  8847. struct in_addr addr4;
  8848. struct in6_addr addr6;
  8849. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8850. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8851. }
  8852. // Resolve where a client should connect for `host`, honoring a user-supplied
  8853. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8854. // supplying the Host header and SNI; only the connection target changes.
  8855. //
  8856. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8857. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8858. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8859. // absent or empty mapping leaves `host` as the connection target; without the
  8860. // empty check the value would reach getaddrinfo as a null node and silently
  8861. // resolve to loopback.
  8862. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8863. const std::string &host, std::string &connect_host,
  8864. std::string &ip) {
  8865. connect_host = host;
  8866. ip.clear();
  8867. auto it = addr_map.find(host);
  8868. if (it == addr_map.end() || it->second.empty()) { return; }
  8869. if (is_ip_address(it->second)) {
  8870. ip = it->second;
  8871. } else {
  8872. connect_host = it->second;
  8873. }
  8874. }
  8875. } // namespace detail
  8876. /*
  8877. * Group 2: detail namespace - SSL common utilities
  8878. */
  8879. #ifdef CPPHTTPLIB_SSL_ENABLED
  8880. namespace detail {
  8881. class SSLSocketStream final : public Stream {
  8882. public:
  8883. SSLSocketStream(
  8884. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8885. time_t read_timeout_usec, time_t write_timeout_sec,
  8886. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8887. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8888. (std::chrono::steady_clock::time_point::min)());
  8889. ~SSLSocketStream() override;
  8890. bool is_readable() const override;
  8891. bool wait_readable() const override;
  8892. bool wait_writable() const override;
  8893. bool is_peer_alive() const override;
  8894. ssize_t read(char *ptr, size_t size) override;
  8895. ssize_t write(const char *ptr, size_t size) override;
  8896. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8897. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8898. socket_t socket() const override;
  8899. time_t duration() const override;
  8900. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8901. // See SocketStream::set_readable_hint().
  8902. void set_readable_hint() { readable_hint_ = true; }
  8903. private:
  8904. bool ensure_readable();
  8905. socket_t sock_;
  8906. tls::session_t session_;
  8907. time_t read_timeout_sec_;
  8908. time_t read_timeout_usec_;
  8909. time_t write_timeout_sec_;
  8910. time_t write_timeout_usec_;
  8911. time_t max_timeout_msec_;
  8912. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8913. bool readable_hint_ = false;
  8914. };
  8915. // A TLS stream for WebSocket connections, where the receive path and the
  8916. // send path (application send() plus the heartbeat ping thread) run on
  8917. // different threads. A single TLS session must never be entered
  8918. // concurrently, so every call into the session is serialized by one mutex.
  8919. //
  8920. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8921. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8922. // call under the lock, then waits for readiness with select() outside the
  8923. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8924. // blocked waiting for data never stalls a concurrent sender.
  8925. //
  8926. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8927. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8928. class WebSocketSSLStream final : public Stream {
  8929. public:
  8930. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8931. time_t read_timeout_sec, time_t read_timeout_usec,
  8932. time_t write_timeout_sec, time_t write_timeout_usec);
  8933. ~WebSocketSSLStream() override;
  8934. bool is_readable() const override;
  8935. bool wait_readable() const override;
  8936. bool wait_writable() const override;
  8937. ssize_t read(char *ptr, size_t size) override;
  8938. ssize_t write(const char *ptr, size_t size) override;
  8939. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8940. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8941. socket_t socket() const override;
  8942. time_t duration() const override;
  8943. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8944. private:
  8945. mutable std::mutex session_mutex_;
  8946. socket_t sock_;
  8947. tls::session_t session_;
  8948. // WebSocket::close() shortens the read timeout from the closing thread
  8949. // while the receive thread is inside wait_readable(), so these two are read
  8950. // and written concurrently. The write timeouts are never mutated.
  8951. std::atomic<time_t> read_timeout_sec_;
  8952. std::atomic<time_t> read_timeout_usec_;
  8953. time_t write_timeout_sec_;
  8954. time_t write_timeout_usec_;
  8955. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8956. };
  8957. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8958. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8959. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8960. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8961. unsigned int hash_length = 0;
  8962. unsigned char hash[EVP_MAX_MD_SIZE];
  8963. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8964. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8965. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8966. std::stringstream ss;
  8967. for (auto i = 0u; i < hash_length; ++i) {
  8968. ss << std::hex << std::setw(2) << std::setfill('0')
  8969. << static_cast<unsigned int>(hash[i]);
  8970. }
  8971. return ss.str();
  8972. }
  8973. inline std::string MD5(const std::string &s) {
  8974. return message_digest(s, EVP_md5());
  8975. }
  8976. inline std::string SHA_256(const std::string &s) {
  8977. return message_digest(s, EVP_sha256());
  8978. }
  8979. inline std::string SHA_512(const std::string &s) {
  8980. return message_digest(s, EVP_sha512());
  8981. }
  8982. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8983. namespace {
  8984. template <size_t N>
  8985. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8986. std::stringstream ss;
  8987. for (size_t i = 0; i < N; ++i) {
  8988. ss << std::hex << std::setw(2) << std::setfill('0')
  8989. << static_cast<unsigned int>(hash[i]);
  8990. }
  8991. return ss.str();
  8992. }
  8993. } // namespace
  8994. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8995. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8996. // initialized once. PSA state is process-global; do not free it.
  8997. inline bool ensure_mbedtls_psa_crypto() {
  8998. static std::once_flag once;
  8999. static bool ok = false;
  9000. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9001. return ok;
  9002. }
  9003. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9004. unsigned char *out, size_t out_size) {
  9005. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9006. size_t olen = 0;
  9007. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9008. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9009. olen == out_size;
  9010. }
  9011. #endif
  9012. inline std::string MD5(const std::string &s) {
  9013. unsigned char hash[16];
  9014. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9015. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9016. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9017. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9018. hash);
  9019. #else
  9020. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9021. hash);
  9022. #endif
  9023. return hash_to_hex(hash);
  9024. }
  9025. inline std::string SHA_256(const std::string &s) {
  9026. unsigned char hash[32];
  9027. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9028. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9029. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9030. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9031. hash, 0);
  9032. #else
  9033. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9034. s.size(), hash, 0);
  9035. #endif
  9036. return hash_to_hex(hash);
  9037. }
  9038. inline std::string SHA_512(const std::string &s) {
  9039. unsigned char hash[64];
  9040. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9041. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9042. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9043. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9044. hash, 0);
  9045. #else
  9046. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9047. s.size(), hash, 0);
  9048. #endif
  9049. return hash_to_hex(hash);
  9050. }
  9051. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9052. namespace {
  9053. template <size_t N>
  9054. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9055. std::stringstream ss;
  9056. for (size_t i = 0; i < N; ++i) {
  9057. ss << std::hex << std::setw(2) << std::setfill('0')
  9058. << static_cast<unsigned int>(hash[i]);
  9059. }
  9060. return ss.str();
  9061. }
  9062. } // namespace
  9063. inline std::string MD5(const std::string &s) {
  9064. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9065. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9066. static_cast<word32>(s.size()), hash);
  9067. return hash_to_hex(hash);
  9068. }
  9069. inline std::string SHA_256(const std::string &s) {
  9070. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9071. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9072. static_cast<word32>(s.size()), hash);
  9073. return hash_to_hex(hash);
  9074. }
  9075. inline std::string SHA_512(const std::string &s) {
  9076. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9077. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9078. static_cast<word32>(s.size()), hash);
  9079. return hash_to_hex(hash);
  9080. }
  9081. #endif
  9082. template <typename T>
  9083. inline bool process_server_socket_ssl(
  9084. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9085. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9086. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9087. time_t write_timeout_usec, T callback) {
  9088. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9089. // of a pipelined request, which keep_alive() cannot see on the socket.
  9090. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9091. write_timeout_sec, write_timeout_usec);
  9092. return process_server_socket_core(
  9093. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9094. [&]() { return strm.is_readable(); },
  9095. [&](bool socket_readable, bool close_connection,
  9096. bool &connection_closed) {
  9097. if (socket_readable) { strm.set_readable_hint(); }
  9098. return callback(strm, close_connection, connection_closed);
  9099. });
  9100. }
  9101. template <typename T>
  9102. inline bool process_client_socket_ssl(
  9103. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9104. time_t read_timeout_usec, time_t write_timeout_sec,
  9105. time_t write_timeout_usec, time_t max_timeout_msec,
  9106. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9107. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9108. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9109. start_time);
  9110. return callback(strm);
  9111. }
  9112. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9113. const Request &req, const std::map<std::string, std::string> &auth,
  9114. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  9115. const std::string &password, bool is_proxy = false) {
  9116. std::string nc;
  9117. {
  9118. std::stringstream ss;
  9119. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9120. nc = ss.str();
  9121. }
  9122. std::string qop;
  9123. if (auth.find("qop") != auth.end()) {
  9124. qop = auth.at("qop");
  9125. if (qop.find("auth-int") != std::string::npos) {
  9126. qop = "auth-int";
  9127. } else if (qop.find("auth") != std::string::npos) {
  9128. qop = "auth";
  9129. } else {
  9130. qop.clear();
  9131. }
  9132. }
  9133. std::string algo = "MD5";
  9134. if (auth.find("algorithm") != auth.end()) {
  9135. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9136. // not a token would otherwise be emitted verbatim and could carry commas
  9137. // or quotes that inject further auth-params into the header below.
  9138. const auto &a = auth.at("algorithm");
  9139. if (fields::is_token(a)) { algo = a; }
  9140. }
  9141. std::string response;
  9142. {
  9143. auto H = algo == "SHA-256" ? detail::SHA_256
  9144. : algo == "SHA-512" ? detail::SHA_512
  9145. : detail::MD5;
  9146. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9147. auto A2 = req.method + ":" + req.path;
  9148. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9149. if (qop.empty()) {
  9150. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9151. } else {
  9152. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9153. ":" + qop + ":" + H(A2));
  9154. }
  9155. }
  9156. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9157. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9158. // close the string early. realm, nonce and opaque come straight from the
  9159. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9160. // without this a crafted challenge injects extra auth-params into the header.
  9161. auto field =
  9162. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9163. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9164. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9165. "\", uri=\"" + detail::escape_quoted_pairs(req.path) +
  9166. "\", algorithm=" + algo +
  9167. (qop.empty() ? ", response=\""
  9168. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9169. "\", response=\"") +
  9170. response + "\"" +
  9171. (opaque.empty()
  9172. ? ""
  9173. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9174. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9175. return std::make_pair(key, field);
  9176. }
  9177. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9178. // backend accepts the same names.
  9179. inline bool match_hostname(const std::string &pattern,
  9180. const std::string &hostname) {
  9181. // A trailing dot on the host is ignored
  9182. auto host = hostname;
  9183. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9184. // Exact match (case-insensitive)
  9185. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9186. // Split both pattern and hostname into components by '.', keeping any empty
  9187. // one, which no name may have
  9188. auto labels = [](const std::string &s) {
  9189. std::vector<std::string> v;
  9190. size_t b = 0;
  9191. while (true) {
  9192. auto e = s.find('.', b);
  9193. v.push_back(s.substr(b, e - b));
  9194. if (e == std::string::npos) { return v; }
  9195. b = e + 1;
  9196. }
  9197. };
  9198. auto pattern_components = labels(pattern);
  9199. auto host_components = labels(host);
  9200. auto has_empty_label = [](const std::vector<std::string> &v) {
  9201. return std::any_of(v.begin(), v.end(),
  9202. [](const std::string &l) { return l.empty(); });
  9203. };
  9204. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9205. return false;
  9206. }
  9207. // Component count must match
  9208. if (host_components.size() != pattern_components.size()) { return false; }
  9209. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9210. // and an IDNA label may not have one
  9211. const auto &leftmost = pattern_components.front();
  9212. if (leftmost.find('*') != std::string::npos &&
  9213. (pattern_components.size() < 3 ||
  9214. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9215. return false;
  9216. }
  9217. // Compare each component with wildcard support
  9218. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9219. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9220. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9221. auto itr = pattern_components.begin();
  9222. for (const auto &h : host_components) {
  9223. auto &p = *itr;
  9224. auto is_leftmost = itr == pattern_components.begin();
  9225. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9226. bool partial_match = false;
  9227. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9228. const auto prefix_length = p.size() - 1;
  9229. if (prefix_length == 0) {
  9230. partial_match = true;
  9231. } else if (h.size() >= prefix_length) {
  9232. partial_match =
  9233. std::equal(p.begin(),
  9234. p.begin() + static_cast<std::string::difference_type>(
  9235. prefix_length),
  9236. h.begin(), [](const char ca, const char cb) {
  9237. return detail::case_ignore::to_lower(ca) ==
  9238. detail::case_ignore::to_lower(cb);
  9239. });
  9240. }
  9241. }
  9242. if (!partial_match) { return false; }
  9243. }
  9244. ++itr;
  9245. }
  9246. return true;
  9247. }
  9248. #ifdef _WIN32
  9249. // Verify certificate using Windows CertGetCertificateChain API.
  9250. // This provides real-time certificate validation with Windows Update
  9251. // integration, independent of the TLS backend.
  9252. inline bool verify_cert_with_windows_schannel(
  9253. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9254. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9255. if (der_cert.empty()) { return false; }
  9256. out_error = 0;
  9257. // Create Windows certificate context from DER data
  9258. auto cert_context = CertCreateCertificateContext(
  9259. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9260. static_cast<DWORD>(der_cert.size()));
  9261. if (!cert_context) {
  9262. out_error = GetLastError();
  9263. return false;
  9264. }
  9265. auto cert_guard =
  9266. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9267. // Give CryptoAPI the certificates the server sent. Without them it follows
  9268. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9269. std::vector<tls::cert_t> peer_certs;
  9270. tls::get_peer_certs(session, peer_certs);
  9271. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9272. auto store_guard = scope_exit([&] {
  9273. for (auto cert : peer_certs) {
  9274. tls::free_cert(cert);
  9275. }
  9276. if (store) { CertCloseStore(store, 0); }
  9277. });
  9278. for (auto cert : peer_certs) {
  9279. std::vector<unsigned char> der;
  9280. if (store && tls::get_cert_der(cert, der)) {
  9281. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9282. static_cast<DWORD>(der.size()),
  9283. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9284. }
  9285. }
  9286. // Setup chain parameters
  9287. CERT_CHAIN_PARA chain_para = {};
  9288. chain_para.cbSize = sizeof(chain_para);
  9289. // Require the server authentication usage along the chain, which also
  9290. // rejects roots that Windows trusts only for other purposes.
  9291. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9292. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9293. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9294. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9295. // Build certificate chain with revocation checking
  9296. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9297. auto chain_result = CertGetCertificateChain(
  9298. nullptr, cert_context, nullptr, store, &chain_para,
  9299. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9300. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9301. nullptr, &chain_context);
  9302. if (!chain_result || !chain_context) {
  9303. out_error = GetLastError();
  9304. return false;
  9305. }
  9306. auto chain_guard =
  9307. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9308. // Verify SSL policy
  9309. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9310. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9311. #ifdef AUTHTYPE_SERVER
  9312. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9313. #endif
  9314. std::wstring whost;
  9315. if (verify_hostname) {
  9316. whost = u8string_to_wstring(hostname.c_str());
  9317. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9318. }
  9319. CERT_CHAIN_POLICY_PARA policy_para = {};
  9320. policy_para.cbSize = sizeof(policy_para);
  9321. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9322. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9323. #else
  9324. policy_para.dwFlags = 0;
  9325. #endif
  9326. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9327. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9328. policy_status.cbSize = sizeof(policy_status);
  9329. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9330. &policy_para, &policy_status)) {
  9331. out_error = GetLastError();
  9332. return false;
  9333. }
  9334. if (policy_status.dwError != 0) {
  9335. out_error = policy_status.dwError;
  9336. return false;
  9337. }
  9338. return true;
  9339. }
  9340. #endif // _WIN32
  9341. // Loads CA file/dir configuration and applies the system CA policy to a
  9342. // client TLS context. PEM data and native stores are applied to the context
  9343. // directly at set time; has_custom_store reflects them for the Auto policy
  9344. // decision.
  9345. inline bool load_client_ca_config(tls::ctx_t ctx,
  9346. const std::string &ca_cert_file_path,
  9347. const std::string &ca_cert_dir_path,
  9348. bool has_custom_store, SystemCAMode mode,
  9349. uint64_t &backend_error) {
  9350. auto ret = true;
  9351. if (!ca_cert_file_path.empty()) {
  9352. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9353. backend_error = tls::get_error();
  9354. ret = false;
  9355. }
  9356. } else if (!ca_cert_dir_path.empty()) {
  9357. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9358. backend_error = tls::get_error();
  9359. ret = false;
  9360. }
  9361. }
  9362. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9363. !ca_cert_dir_path.empty() || has_custom_store;
  9364. if (mode == SystemCAMode::Enabled ||
  9365. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9366. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9367. }
  9368. return ret;
  9369. }
  9370. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9371. std::vector<tls::cert_t> certs;
  9372. tls::get_ca_certs(ctx, certs);
  9373. std::string pem;
  9374. for (auto cert : certs) {
  9375. std::vector<unsigned char> der;
  9376. if (tls::get_cert_der(cert, der)) {
  9377. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9378. pem += "-----BEGIN CERTIFICATE-----\n";
  9379. for (size_t i = 0; i < b64.size(); i += 64) {
  9380. pem += b64.substr(i, 64) + "\n";
  9381. }
  9382. pem += "-----END CERTIFICATE-----\n";
  9383. }
  9384. tls::free_cert(cert);
  9385. }
  9386. return pem;
  9387. }
  9388. // The parts of session setup that only SSLClient needs, plus the handful
  9389. // WebSocketClient also exposes; everything else takes the defaults, which is
  9390. // what keeps the two clients on one implementation.
  9391. struct ClientTlsSessionOptions {
  9392. // Both SSLClient and WebSocketClient expose this independently of
  9393. // certificate verification.
  9394. bool server_hostname_verification = true;
  9395. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9396. // When non-null, guards session creation against concurrent use of the
  9397. // context. A WebSocketClient is not safe to use from several threads to
  9398. // begin with, so it passes nothing.
  9399. std::mutex *ctx_mutex = nullptr;
  9400. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9401. // The caller decides whether Schannel has anything to say about this
  9402. // connection; see SSLClient::initialize_ssl().
  9403. bool windows_cert_verification = false;
  9404. // A server certificate verifier works on the backend's chain verification,
  9405. // so the backend keeps deciding and Schannel only adds its own check.
  9406. bool server_certificate_verifier_set = false;
  9407. #endif
  9408. };
  9409. // Filled in on failure for callers that report error details.
  9410. struct ClientTlsSessionError {
  9411. Error error = Error::Success;
  9412. int ssl_error = 0;
  9413. uint64_t backend_error = 0;
  9414. };
  9415. // Establishes a client TLS session on an already connected socket. On failure
  9416. // the session is left for the caller to free: SSLClient frees it right away,
  9417. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9418. inline bool setup_client_tls_session(
  9419. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9420. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9421. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9422. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9423. using namespace tls;
  9424. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9425. if (out_error) {
  9426. out_error->error = error;
  9427. out_error->ssl_error = ssl_error;
  9428. out_error->backend_error = backend_error;
  9429. }
  9430. return false;
  9431. };
  9432. if (!ctx) {
  9433. session = nullptr;
  9434. return fail(Error::SSLConnection, 0, 0);
  9435. }
  9436. // With Windows verification on and no server certificate verifier set,
  9437. // Schannel is the only chain verifier. The backend's trust store is a
  9438. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9439. // demand, so the backend's verdict is not used.
  9440. auto windows_verifies_chain = false;
  9441. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9442. windows_verifies_chain = options.windows_cert_verification &&
  9443. !options.server_certificate_verifier_set;
  9444. #endif
  9445. {
  9446. std::unique_lock<std::mutex> guard;
  9447. if (options.ctx_mutex) {
  9448. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9449. }
  9450. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9451. // Mbed TLS and wolfSSL need the verification mode set explicitly, on the
  9452. // context, so under the same lock; OpenSSL uses SSL_VERIFY_NONE and does
  9453. // all verification post-handshake. Unless Schannel verifies the chain
  9454. // instead, chain verification happens during the handshake even for IP
  9455. // hosts; the certificate identity is verified post-handshake via
  9456. // verify_hostname().
  9457. set_verify_client(ctx, server_certificate_verification &&
  9458. !windows_verifies_chain);
  9459. #endif
  9460. session = create_session(ctx, sock);
  9461. }
  9462. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9463. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9464. // their identity is checked post-handshake below instead. On Mbed TLS and
  9465. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9466. // options.server_hostname_verification is threaded through here.
  9467. if (!is_ip_address(host)) {
  9468. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9469. return fail(Error::SSLConnection, 0, get_error());
  9470. }
  9471. }
  9472. TlsError tls_err;
  9473. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9474. &tls_err)) {
  9475. auto error = Error::SSLConnection;
  9476. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9477. error = Error::SSLServerVerification;
  9478. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9479. error = Error::SSLServerHostnameVerification;
  9480. }
  9481. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9482. }
  9483. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9484. if (options.session_verifier) {
  9485. verification_status = options.session_verifier(session);
  9486. }
  9487. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9488. return fail(Error::SSLServerVerification, 0, get_error());
  9489. }
  9490. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9491. server_certificate_verification) {
  9492. if (!windows_verifies_chain) {
  9493. auto verify_result = get_verify_result(session);
  9494. if (verify_result != 0) {
  9495. return fail(Error::SSLServerVerification, 0,
  9496. static_cast<uint64_t>(verify_result));
  9497. }
  9498. }
  9499. auto server_cert = get_peer_cert(session);
  9500. if (!server_cert) {
  9501. return fail(Error::SSLServerVerification, 0, get_error());
  9502. }
  9503. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9504. // Identity check against the peer certificate, post-handshake for all
  9505. // backends. For IP hosts this is the only identity verification, since no
  9506. // hostname is bound during the handshake.
  9507. if (options.server_hostname_verification) {
  9508. if (!verify_hostname(server_cert, host.c_str())) {
  9509. return fail(Error::SSLServerHostnameVerification, 0,
  9510. hostname_mismatch_code());
  9511. }
  9512. }
  9513. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9514. // Windows Schannel verification, which lets Windows fetch missing roots
  9515. // and intermediates on demand. It must not be skipped: unless a server
  9516. // certificate verifier is set, it is the only chain check.
  9517. if (options.windows_cert_verification) {
  9518. std::vector<unsigned char> der;
  9519. uint64_t wincrypt_error = 0;
  9520. if (!get_cert_der(server_cert, der) ||
  9521. !verify_cert_with_windows_schannel(
  9522. der, host, options.server_hostname_verification, wincrypt_error,
  9523. session)) {
  9524. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9525. }
  9526. }
  9527. #endif
  9528. }
  9529. return true;
  9530. }
  9531. } // namespace detail
  9532. #endif // CPPHTTPLIB_SSL_ENABLED
  9533. /*
  9534. * Group 3: httplib namespace - Non-SSL public API implementations
  9535. */
  9536. inline void default_socket_options(socket_t sock) {
  9537. set_socket_opt(sock, SOL_SOCKET,
  9538. #ifdef SO_REUSEPORT
  9539. SO_REUSEPORT,
  9540. #else
  9541. SO_REUSEADDR,
  9542. #endif
  9543. 1);
  9544. }
  9545. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9546. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9547. sizeof(optval));
  9548. }
  9549. inline std::string get_bearer_token_auth(const Request &req) {
  9550. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9551. // than the prefix carries no token.
  9552. constexpr const char bearer_prefix[] = "Bearer ";
  9553. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9554. auto value = req.get_header_value("Authorization");
  9555. if (value.size() >= bearer_prefix_len &&
  9556. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9557. bearer_prefix)) {
  9558. return value.substr(bearer_prefix_len);
  9559. }
  9560. return "";
  9561. }
  9562. inline const char *status_message(int status) {
  9563. switch (status) {
  9564. case StatusCode::Continue_100: return "Continue";
  9565. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9566. case StatusCode::Processing_102: return "Processing";
  9567. case StatusCode::EarlyHints_103: return "Early Hints";
  9568. case StatusCode::OK_200: return "OK";
  9569. case StatusCode::Created_201: return "Created";
  9570. case StatusCode::Accepted_202: return "Accepted";
  9571. case StatusCode::NonAuthoritativeInformation_203:
  9572. return "Non-Authoritative Information";
  9573. case StatusCode::NoContent_204: return "No Content";
  9574. case StatusCode::ResetContent_205: return "Reset Content";
  9575. case StatusCode::PartialContent_206: return "Partial Content";
  9576. case StatusCode::MultiStatus_207: return "Multi-Status";
  9577. case StatusCode::AlreadyReported_208: return "Already Reported";
  9578. case StatusCode::IMUsed_226: return "IM Used";
  9579. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9580. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9581. case StatusCode::Found_302: return "Found";
  9582. case StatusCode::SeeOther_303: return "See Other";
  9583. case StatusCode::NotModified_304: return "Not Modified";
  9584. case StatusCode::UseProxy_305: return "Use Proxy";
  9585. case StatusCode::unused_306: return "unused";
  9586. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9587. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9588. case StatusCode::BadRequest_400: return "Bad Request";
  9589. case StatusCode::Unauthorized_401: return "Unauthorized";
  9590. case StatusCode::PaymentRequired_402: return "Payment Required";
  9591. case StatusCode::Forbidden_403: return "Forbidden";
  9592. case StatusCode::NotFound_404: return "Not Found";
  9593. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9594. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9595. case StatusCode::ProxyAuthenticationRequired_407:
  9596. return "Proxy Authentication Required";
  9597. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9598. case StatusCode::Conflict_409: return "Conflict";
  9599. case StatusCode::Gone_410: return "Gone";
  9600. case StatusCode::LengthRequired_411: return "Length Required";
  9601. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9602. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9603. case StatusCode::UriTooLong_414: return "URI Too Long";
  9604. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9605. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9606. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9607. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9608. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9609. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9610. case StatusCode::Locked_423: return "Locked";
  9611. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9612. case StatusCode::TooEarly_425: return "Too Early";
  9613. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9614. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9615. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9616. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9617. return "Request Header Fields Too Large";
  9618. case StatusCode::UnavailableForLegalReasons_451:
  9619. return "Unavailable For Legal Reasons";
  9620. case StatusCode::NotImplemented_501: return "Not Implemented";
  9621. case StatusCode::BadGateway_502: return "Bad Gateway";
  9622. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9623. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9624. case StatusCode::HttpVersionNotSupported_505:
  9625. return "HTTP Version Not Supported";
  9626. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9627. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9628. case StatusCode::LoopDetected_508: return "Loop Detected";
  9629. case StatusCode::NotExtended_510: return "Not Extended";
  9630. case StatusCode::NetworkAuthenticationRequired_511:
  9631. return "Network Authentication Required";
  9632. default:
  9633. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9634. }
  9635. }
  9636. inline std::string to_string(const Error error) {
  9637. switch (error) {
  9638. case Error::Success: return "Success (no error)";
  9639. case Error::Unknown: return "Unknown";
  9640. case Error::Connection: return "Could not establish connection";
  9641. case Error::BindIPAddress: return "Failed to bind IP address";
  9642. case Error::Read: return "Failed to read connection";
  9643. case Error::Write: return "Failed to write connection";
  9644. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9645. case Error::Canceled: return "Connection handling canceled";
  9646. case Error::SSLConnection: return "SSL connection failed";
  9647. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9648. case Error::SSLServerVerification: return "SSL server verification failed";
  9649. case Error::SSLServerHostnameVerification:
  9650. return "SSL server hostname verification failed";
  9651. case Error::UnsupportedMultipartBoundaryChars:
  9652. return "Unsupported HTTP multipart boundary characters";
  9653. case Error::Compression: return "Compression failed";
  9654. case Error::ConnectionTimeout: return "Connection timed out";
  9655. case Error::ProxyConnection: return "Proxy connection failed";
  9656. case Error::ConnectionClosed: return "Connection closed by server";
  9657. case Error::Timeout: return "Read timeout";
  9658. case Error::ResourceExhaustion: return "Resource exhaustion";
  9659. case Error::TooManyFormDataFiles: return "Too many form data files";
  9660. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9661. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9662. case Error::ExceedMaxSocketDescriptorCount:
  9663. return "Exceeded maximum socket descriptor count";
  9664. case Error::InvalidRequestLine: return "Invalid request line";
  9665. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9666. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9667. case Error::InvalidHeaders: return "Invalid headers";
  9668. case Error::MultipartParsing: return "Multipart parsing failed";
  9669. case Error::OpenFile: return "Failed to open file";
  9670. case Error::Listen: return "Failed to listen on socket";
  9671. case Error::GetSockName: return "Failed to get socket name";
  9672. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9673. case Error::HTTPParsing: return "HTTP parsing failed";
  9674. case Error::InvalidRangeHeader: return "Invalid Range header";
  9675. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9676. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9677. case Error::UserCallbackException: return "User callback threw an exception";
  9678. default: break;
  9679. }
  9680. return "Invalid";
  9681. }
  9682. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9683. os << to_string(obj);
  9684. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9685. return os;
  9686. }
  9687. inline std::string hosted_at(const std::string &hostname) {
  9688. std::vector<std::string> addrs;
  9689. hosted_at(hostname, addrs);
  9690. if (addrs.empty()) { return std::string(); }
  9691. return addrs[0];
  9692. }
  9693. inline void hosted_at(const std::string &hostname,
  9694. std::vector<std::string> &addrs) {
  9695. struct addrinfo hints;
  9696. struct addrinfo *result;
  9697. memset(&hints, 0, sizeof(struct addrinfo));
  9698. hints.ai_family = AF_UNSPEC;
  9699. hints.ai_socktype = SOCK_STREAM;
  9700. hints.ai_protocol = 0;
  9701. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9702. &result, 0)) {
  9703. #if defined __linux__ && !defined __ANDROID__
  9704. res_init();
  9705. #endif
  9706. return;
  9707. }
  9708. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9709. for (auto rp = result; rp; rp = rp->ai_next) {
  9710. const auto &addr =
  9711. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9712. std::string ip;
  9713. auto dummy = -1;
  9714. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9715. dummy)) {
  9716. addrs.emplace_back(std::move(ip));
  9717. }
  9718. }
  9719. }
  9720. inline std::string encode_uri_component(const std::string &value) {
  9721. std::ostringstream escaped;
  9722. escaped.fill('0');
  9723. escaped << std::hex;
  9724. for (auto c : value) {
  9725. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9726. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9727. escaped << c;
  9728. } else {
  9729. escaped << std::uppercase;
  9730. escaped << '%' << std::setw(2)
  9731. << static_cast<int>(static_cast<unsigned char>(c));
  9732. escaped << std::nouppercase;
  9733. }
  9734. }
  9735. return escaped.str();
  9736. }
  9737. inline std::string encode_uri(const std::string &value) {
  9738. std::ostringstream escaped;
  9739. escaped.fill('0');
  9740. escaped << std::hex;
  9741. for (auto c : value) {
  9742. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9743. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9744. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9745. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9746. escaped << c;
  9747. } else {
  9748. escaped << std::uppercase;
  9749. escaped << '%' << std::setw(2)
  9750. << static_cast<int>(static_cast<unsigned char>(c));
  9751. escaped << std::nouppercase;
  9752. }
  9753. }
  9754. return escaped.str();
  9755. }
  9756. inline std::string decode_uri_component(const std::string &value) {
  9757. std::string result;
  9758. for (size_t i = 0; i < value.size(); i++) {
  9759. if (value[i] == '%' && i + 2 < value.size()) {
  9760. auto val = 0;
  9761. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9762. result += static_cast<char>(val);
  9763. i += 2;
  9764. } else {
  9765. result += value[i];
  9766. }
  9767. } else {
  9768. result += value[i];
  9769. }
  9770. }
  9771. return result;
  9772. }
  9773. inline std::string decode_uri(const std::string &value) {
  9774. std::string result;
  9775. for (size_t i = 0; i < value.size(); i++) {
  9776. if (value[i] == '%' && i + 2 < value.size()) {
  9777. auto val = 0;
  9778. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9779. auto c = static_cast<char>(val);
  9780. // Keep escapes of the reserved characters that encode_uri leaves
  9781. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9782. // delimiter is not promoted into a real one (as with JS decodeURI).
  9783. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9784. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9785. c == '#') {
  9786. result += value[i];
  9787. result += value[i + 1];
  9788. result += value[i + 2];
  9789. } else {
  9790. result += c;
  9791. }
  9792. i += 2;
  9793. } else {
  9794. result += value[i];
  9795. }
  9796. } else {
  9797. result += value[i];
  9798. }
  9799. }
  9800. return result;
  9801. }
  9802. inline std::string encode_path_component(const std::string &component) {
  9803. std::string result;
  9804. result.reserve(component.size() * 3);
  9805. for (size_t i = 0; i < component.size(); i++) {
  9806. auto c = static_cast<unsigned char>(component[i]);
  9807. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9808. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9809. c == '_' || c == '~') {
  9810. result += static_cast<char>(c);
  9811. }
  9812. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9813. // "," / ";" / "="
  9814. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9815. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9816. c == '=') {
  9817. result += static_cast<char>(c);
  9818. }
  9819. // Colon is allowed in path segments except first segment
  9820. else if (c == ':') {
  9821. result += static_cast<char>(c);
  9822. }
  9823. // @ is allowed in path
  9824. else if (c == '@') {
  9825. result += static_cast<char>(c);
  9826. } else {
  9827. result += '%';
  9828. char hex[3];
  9829. snprintf(hex, sizeof(hex), "%02X", c);
  9830. result.append(hex, 2);
  9831. }
  9832. }
  9833. return result;
  9834. }
  9835. inline std::string decode_path_component(const std::string &component) {
  9836. std::string result;
  9837. result.reserve(component.size());
  9838. for (size_t i = 0; i < component.size(); i++) {
  9839. if (component[i] == '%' && i + 1 < component.size()) {
  9840. if (component[i + 1] == 'u') {
  9841. // Unicode %uXXXX encoding
  9842. auto val = 0;
  9843. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9844. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9845. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9846. char buff[4];
  9847. size_t len = detail::to_utf8(val, buff);
  9848. if (len > 0) {
  9849. result.append(buff, len);
  9850. i += 5; // 'u0000'
  9851. } else {
  9852. // A surrogate is no character. Dropping it would join what is on
  9853. // either side of it, so the escape is kept as it is.
  9854. result += component[i];
  9855. }
  9856. } else {
  9857. result += component[i];
  9858. }
  9859. } else {
  9860. // Standard %XX encoding
  9861. auto val = 0;
  9862. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9863. // 2 digits hex codes
  9864. result += static_cast<char>(val);
  9865. i += 2; // 'XX'
  9866. } else {
  9867. result += component[i];
  9868. }
  9869. }
  9870. } else {
  9871. result += component[i];
  9872. }
  9873. }
  9874. return result;
  9875. }
  9876. inline std::string encode_query_component(const std::string &component,
  9877. bool space_as_plus) {
  9878. std::string result;
  9879. result.reserve(component.size() * 3);
  9880. for (size_t i = 0; i < component.size(); i++) {
  9881. auto c = static_cast<unsigned char>(component[i]);
  9882. // Unreserved characters per RFC 3986
  9883. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9884. c == '_' || c == '~') {
  9885. result += static_cast<char>(c);
  9886. }
  9887. // Space handling
  9888. else if (c == ' ') {
  9889. if (space_as_plus) {
  9890. result += '+';
  9891. } else {
  9892. result += "%20";
  9893. }
  9894. }
  9895. // Plus sign handling
  9896. else if (c == '+') {
  9897. if (space_as_plus) {
  9898. result += "%2B";
  9899. } else {
  9900. result += static_cast<char>(c);
  9901. }
  9902. }
  9903. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9904. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9905. c == '*' || c == ',' || c == ';') {
  9906. result += static_cast<char>(c);
  9907. }
  9908. // Colon and @ are allowed in query
  9909. else if (c == ':' || c == '@') {
  9910. result += static_cast<char>(c);
  9911. }
  9912. // Forward slash is allowed in query values
  9913. else if (c == '/') {
  9914. result += static_cast<char>(c);
  9915. }
  9916. // Question mark is allowed in query values (after first ?)
  9917. else if (c == '?') {
  9918. result += static_cast<char>(c);
  9919. } else {
  9920. result += '%';
  9921. char hex[3];
  9922. snprintf(hex, sizeof(hex), "%02X", c);
  9923. result.append(hex, 2);
  9924. }
  9925. }
  9926. return result;
  9927. }
  9928. inline std::string decode_query_component(const std::string &component,
  9929. bool plus_as_space) {
  9930. std::string result;
  9931. result.reserve(component.size());
  9932. for (size_t i = 0; i < component.size(); i++) {
  9933. if (component[i] == '%' && i + 2 < component.size()) {
  9934. auto val = 0;
  9935. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9936. result += static_cast<char>(val);
  9937. i += 2;
  9938. } else {
  9939. result += component[i];
  9940. }
  9941. } else if (component[i] == '+' && plus_as_space) {
  9942. result += ' '; // + becomes space in form-urlencoded
  9943. } else {
  9944. result += component[i];
  9945. }
  9946. }
  9947. return result;
  9948. }
  9949. inline std::string sanitize_filename(const std::string &filename) {
  9950. // Extract basename: find the last path separator (/ or \)
  9951. auto pos = filename.find_last_of("/\\");
  9952. auto result =
  9953. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9954. // Strip null bytes
  9955. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9956. // Trim whitespace
  9957. {
  9958. auto start = result.find_first_not_of(" \t");
  9959. auto end = result.find_last_not_of(" \t");
  9960. result = (start == std::string::npos)
  9961. ? ""
  9962. : result.substr(start, end - start + 1);
  9963. }
  9964. // Reject . and ..
  9965. if (result == "." || result == "..") { return ""; }
  9966. return result;
  9967. }
  9968. inline std::string append_query_params(const std::string &path,
  9969. const Params &params) {
  9970. std::string path_with_query = path;
  9971. path_with_query += path.find('?') == std::string::npos ? '?' : '&';
  9972. path_with_query += detail::params_to_query_str(params);
  9973. return path_with_query;
  9974. }
  9975. // Header utilities
  9976. inline std::pair<std::string, std::string>
  9977. make_range_header(const Ranges &ranges) {
  9978. std::string field = "bytes=";
  9979. auto i = 0;
  9980. for (const auto &r : ranges) {
  9981. if (i != 0) { field += ", "; }
  9982. if (r.first != -1) { field += std::to_string(r.first); }
  9983. field += '-';
  9984. if (r.second != -1) { field += std::to_string(r.second); }
  9985. i++;
  9986. }
  9987. return std::make_pair("Range", std::move(field));
  9988. }
  9989. inline std::pair<std::string, std::string>
  9990. make_basic_authentication_header(const std::string &username,
  9991. const std::string &password, bool is_proxy) {
  9992. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9993. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9994. return std::make_pair(key, std::move(field));
  9995. }
  9996. inline std::pair<std::string, std::string>
  9997. make_bearer_token_authentication_header(const std::string &token,
  9998. bool is_proxy = false) {
  9999. auto field = "Bearer " + token;
  10000. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10001. return std::make_pair(key, std::move(field));
  10002. }
  10003. // Request implementation
  10004. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10005. size_t id) const {
  10006. return detail::get_header_value_u64(headers, key, def, id);
  10007. }
  10008. inline bool Request::has_header(const std::string &key) const {
  10009. return detail::has_header(headers, key);
  10010. }
  10011. inline std::string Request::get_header_value(const std::string &key,
  10012. const char *def, size_t id) const {
  10013. return detail::get_header_value(headers, key, def, id);
  10014. }
  10015. inline size_t Request::get_header_value_count(const std::string &key) const {
  10016. return detail::get_header_value_count(headers, key);
  10017. }
  10018. inline void Request::set_header(const std::string &key,
  10019. const std::string &val) {
  10020. detail::set_header(headers, key, val);
  10021. }
  10022. inline bool Request::has_trailer(const std::string &key) const {
  10023. return trailers.find(key) != trailers.end();
  10024. }
  10025. inline std::string Request::get_trailer_value(const std::string &key,
  10026. size_t id) const {
  10027. return detail::get_multimap_value(trailers, key, id);
  10028. }
  10029. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10030. return trailers.count(key);
  10031. }
  10032. inline bool Request::has_param(const std::string &key) const {
  10033. return params.find(key) != params.end();
  10034. }
  10035. inline std::string Request::get_param_value(const std::string &key,
  10036. size_t id) const {
  10037. return detail::get_multimap_value(params, key, id);
  10038. }
  10039. inline std::vector<std::string>
  10040. Request::get_param_values(const std::string &key) const {
  10041. auto rng = params.equal_range(key);
  10042. std::vector<std::string> values;
  10043. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10044. for (auto it = rng.first; it != rng.second; ++it) {
  10045. values.push_back(it->second);
  10046. }
  10047. return values;
  10048. }
  10049. inline size_t Request::get_param_value_count(const std::string &key) const {
  10050. return params.count(key);
  10051. }
  10052. inline bool Request::is_multipart_form_data() const {
  10053. const auto &content_type = get_header_value("Content-Type");
  10054. return detail::extract_media_type(content_type) == "multipart/form-data";
  10055. }
  10056. // Multipart FormData implementation
  10057. inline std::string MultipartFormData::get_field(const std::string &key,
  10058. size_t id) const {
  10059. auto rng = fields.equal_range(key);
  10060. auto it = detail::bounded_next(rng.first, id, rng.second);
  10061. if (it != rng.second) { return it->second.content; }
  10062. return std::string();
  10063. }
  10064. inline std::vector<std::string>
  10065. MultipartFormData::get_fields(const std::string &key) const {
  10066. std::vector<std::string> values;
  10067. auto rng = fields.equal_range(key);
  10068. for (auto it = rng.first; it != rng.second; it++) {
  10069. values.push_back(it->second.content);
  10070. }
  10071. return values;
  10072. }
  10073. inline bool MultipartFormData::has_field(const std::string &key) const {
  10074. return fields.find(key) != fields.end();
  10075. }
  10076. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10077. return fields.count(key);
  10078. }
  10079. inline FormData MultipartFormData::get_file(const std::string &key,
  10080. size_t id) const {
  10081. return detail::get_multimap_value(files, key, id);
  10082. }
  10083. inline std::vector<FormData>
  10084. MultipartFormData::get_files(const std::string &key) const {
  10085. std::vector<FormData> values;
  10086. auto rng = files.equal_range(key);
  10087. for (auto it = rng.first; it != rng.second; it++) {
  10088. values.push_back(it->second);
  10089. }
  10090. return values;
  10091. }
  10092. inline bool MultipartFormData::has_file(const std::string &key) const {
  10093. return files.find(key) != files.end();
  10094. }
  10095. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10096. return files.count(key);
  10097. }
  10098. // Multipart FormData writer implementation
  10099. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10100. return detail::is_multipart_boundary_chars_valid(boundary);
  10101. }
  10102. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10103. : boundary_(detail::make_multipart_data_boundary()) {}
  10104. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10105. : boundary_(std::move(boundary)) {}
  10106. inline const std::string &MultipartFormDataWriter::boundary() const {
  10107. return boundary_;
  10108. }
  10109. inline std::string MultipartFormDataWriter::content_type() const {
  10110. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10111. }
  10112. inline std::string
  10113. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10114. return detail::serialize_multipart_formdata(items, boundary_);
  10115. }
  10116. inline size_t MultipartFormDataWriter::content_length(
  10117. const UploadFormDataItems &items) const {
  10118. return detail::get_multipart_content_length(items, boundary_);
  10119. }
  10120. inline std::string
  10121. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10122. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10123. }
  10124. inline std::string MultipartFormDataWriter::item_end() {
  10125. return detail::serialize_multipart_formdata_item_end();
  10126. }
  10127. inline std::string MultipartFormDataWriter::finish() const {
  10128. return detail::serialize_multipart_formdata_finish(boundary_);
  10129. }
  10130. // Response implementation
  10131. namespace detail {
  10132. // A response has one content source: `body`, a content provider, or a file.
  10133. // Each content setter calls this so that the one called last wins.
  10134. inline void clear_content_provider(Response &res) {
  10135. auto releaser = std::move(res.content_provider_resource_releaser_);
  10136. auto success = res.content_provider_success_;
  10137. res.content_length_ = 0;
  10138. res.content_provider_ = nullptr;
  10139. res.content_provider_resource_releaser_ = nullptr;
  10140. res.is_chunked_content_provider_ = false;
  10141. res.is_file_content_provider_ = false;
  10142. res.content_provider_success_ = false;
  10143. res.content_coding_ = EncodingType::None;
  10144. res.file_content_path_.clear();
  10145. res.file_content_content_type_.clear();
  10146. if (releaser) { releaser(success); }
  10147. }
  10148. inline void clear_content(Response &res) {
  10149. res.body.clear();
  10150. clear_content_provider(res);
  10151. }
  10152. // `body` is public, so it can be assigned directly after a provider or a file
  10153. // was set. It came last, so it wins.
  10154. inline void prefer_assigned_body(Response &res) {
  10155. if (!res.body.empty() &&
  10156. (res.content_provider_ || !res.file_content_path_.empty())) {
  10157. clear_content_provider(res);
  10158. }
  10159. }
  10160. } // namespace detail
  10161. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10162. size_t id) const {
  10163. return detail::get_header_value_u64(headers, key, def, id);
  10164. }
  10165. inline bool Response::has_header(const std::string &key) const {
  10166. return headers.find(key) != headers.end();
  10167. }
  10168. inline std::string Response::get_header_value(const std::string &key,
  10169. const char *def,
  10170. size_t id) const {
  10171. return detail::get_header_value(headers, key, def, id);
  10172. }
  10173. inline size_t Response::get_header_value_count(const std::string &key) const {
  10174. return detail::get_header_value_count(headers, key);
  10175. }
  10176. inline void Response::set_header(const std::string &key,
  10177. const std::string &val) {
  10178. detail::set_header(headers, key, val);
  10179. }
  10180. inline bool Response::has_trailer(const std::string &key) const {
  10181. return trailers.find(key) != trailers.end();
  10182. }
  10183. inline std::string Response::get_trailer_value(const std::string &key,
  10184. size_t id) const {
  10185. return detail::get_multimap_value(trailers, key, id);
  10186. }
  10187. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10188. return trailers.count(key);
  10189. }
  10190. inline void Response::set_redirect(const std::string &url, int stat) {
  10191. if (detail::fields::is_field_value(url)) {
  10192. set_header("Location", url);
  10193. if (300 <= stat && stat < 400) {
  10194. this->status = stat;
  10195. } else {
  10196. this->status = StatusCode::Found_302;
  10197. }
  10198. }
  10199. }
  10200. inline void Response::set_content(const char *s, size_t n,
  10201. const std::string &content_type) {
  10202. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10203. detail::clear_content_provider(*this);
  10204. auto rng = headers.equal_range("Content-Type");
  10205. headers.erase(rng.first, rng.second);
  10206. set_header("Content-Type", content_type);
  10207. }
  10208. inline void Response::set_content(const std::string &s,
  10209. const std::string &content_type) {
  10210. set_content(s.data(), s.size(), content_type);
  10211. }
  10212. inline void Response::set_content(std::string &&s,
  10213. const std::string &content_type) {
  10214. body = std::move(s);
  10215. detail::clear_content_provider(*this);
  10216. auto rng = headers.equal_range("Content-Type");
  10217. headers.erase(rng.first, rng.second);
  10218. set_header("Content-Type", content_type);
  10219. }
  10220. inline void Response::set_content_provider(
  10221. size_t in_length, const std::string &content_type, ContentProvider provider,
  10222. ContentProviderResourceReleaser resource_releaser) {
  10223. detail::clear_content(*this);
  10224. set_header("Content-Type", content_type);
  10225. content_length_ = in_length;
  10226. if (in_length > 0) { content_provider_ = std::move(provider); }
  10227. content_provider_resource_releaser_ = std::move(resource_releaser);
  10228. }
  10229. inline void Response::set_content_provider(
  10230. const std::string &content_type, ContentProviderWithoutLength provider,
  10231. ContentProviderResourceReleaser resource_releaser) {
  10232. detail::clear_content(*this);
  10233. set_header("Content-Type", content_type);
  10234. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10235. content_provider_resource_releaser_ = std::move(resource_releaser);
  10236. }
  10237. inline void Response::set_chunked_content_provider(
  10238. const std::string &content_type, ContentProviderWithoutLength provider,
  10239. ContentProviderResourceReleaser resource_releaser) {
  10240. set_content_provider(content_type, std::move(provider),
  10241. std::move(resource_releaser));
  10242. is_chunked_content_provider_ = true;
  10243. }
  10244. inline void Response::set_file_content(const std::string &path,
  10245. const std::string &content_type) {
  10246. detail::clear_content(*this);
  10247. file_content_path_ = path;
  10248. file_content_content_type_ = content_type;
  10249. }
  10250. inline void Response::set_file_content(const std::string &path) {
  10251. set_file_content(path, std::string());
  10252. }
  10253. // Result implementation
  10254. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10255. size_t def,
  10256. size_t id) const {
  10257. return detail::get_header_value_u64(request_headers_, key, def, id);
  10258. }
  10259. inline bool Result::has_request_header(const std::string &key) const {
  10260. return request_headers_.find(key) != request_headers_.end();
  10261. }
  10262. inline std::string Result::get_request_header_value(const std::string &key,
  10263. const char *def,
  10264. size_t id) const {
  10265. return detail::get_header_value(request_headers_, key, def, id);
  10266. }
  10267. inline size_t
  10268. Result::get_request_header_value_count(const std::string &key) const {
  10269. return request_headers_.count(key);
  10270. }
  10271. // Stream implementation
  10272. inline ssize_t Stream::write(const char *ptr) {
  10273. return write(ptr, strlen(ptr));
  10274. }
  10275. inline ssize_t Stream::write(const std::string &s) {
  10276. return write(s.data(), s.size());
  10277. }
  10278. // BodyReader implementation
  10279. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10280. if (!stream) {
  10281. last_error = Error::Connection;
  10282. return -1;
  10283. }
  10284. if (eof) { return 0; }
  10285. if (!chunked) {
  10286. // Content-Length based reading
  10287. if (has_content_length && bytes_read >= content_length) {
  10288. eof = true;
  10289. return 0;
  10290. }
  10291. auto to_read = len;
  10292. if (has_content_length) {
  10293. auto remaining = content_length - bytes_read;
  10294. to_read = (std::min)(len, remaining);
  10295. }
  10296. auto n = stream->read(buf, to_read);
  10297. if (n < 0) {
  10298. last_error = stream->get_error();
  10299. if (last_error == Error::Success) { last_error = Error::Read; }
  10300. eof = true;
  10301. return n;
  10302. }
  10303. if (n == 0) {
  10304. // Unexpected EOF before content_length
  10305. last_error = stream->get_error();
  10306. if (last_error == Error::Success) { last_error = Error::Read; }
  10307. eof = true;
  10308. return 0;
  10309. }
  10310. bytes_read += static_cast<size_t>(n);
  10311. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10312. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10313. last_error = Error::ExceedMaxPayloadSize;
  10314. eof = true;
  10315. return -1;
  10316. }
  10317. return n;
  10318. }
  10319. // Chunked transfer encoding: delegate to shared decoder instance.
  10320. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10321. size_t chunk_offset = 0;
  10322. size_t chunk_total = 0;
  10323. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10324. if (n < 0) {
  10325. last_error = stream->get_error();
  10326. if (last_error == Error::Success) { last_error = Error::Read; }
  10327. eof = true;
  10328. return n;
  10329. }
  10330. if (n == 0) {
  10331. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10332. eof = true;
  10333. return 0;
  10334. }
  10335. bytes_read += static_cast<size_t>(n);
  10336. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10337. last_error = Error::ExceedMaxPayloadSize;
  10338. eof = true;
  10339. return -1;
  10340. }
  10341. return n;
  10342. }
  10343. // ThreadPool implementation
  10344. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10345. time_t idle_timeout_sec)
  10346. : base_thread_count_(n), max_queued_requests_(mqr),
  10347. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10348. shutdown_(false) {
  10349. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10350. if (max_n != 0 && max_n < n) {
  10351. std::string msg = "max_threads must be >= base_threads";
  10352. throw std::invalid_argument(msg);
  10353. }
  10354. #endif
  10355. max_thread_count_ = max_n == 0 ? n : max_n;
  10356. threads_.reserve(base_thread_count_);
  10357. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10358. try {
  10359. #endif
  10360. for (size_t i = 0; i < base_thread_count_; i++) {
  10361. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10362. }
  10363. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10364. } catch (...) {
  10365. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10366. // signal the workers we already spawned to exit and join them so the
  10367. // vector destructor does not see joinable threads (which would call
  10368. // std::terminate). Then rethrow so the caller learns of the failure.
  10369. {
  10370. std::unique_lock<std::mutex> lock(mutex_);
  10371. shutdown_ = true;
  10372. }
  10373. cond_.notify_all();
  10374. for (auto &t : threads_) {
  10375. if (t.joinable()) { t.join(); }
  10376. }
  10377. throw;
  10378. }
  10379. #endif
  10380. }
  10381. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10382. {
  10383. std::unique_lock<std::mutex> lock(mutex_);
  10384. if (shutdown_) { return false; }
  10385. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10386. return false;
  10387. }
  10388. jobs_.push_back(std::move(fn));
  10389. // Spawn a dynamic thread if no idle threads and under max
  10390. if (idle_thread_count_ == 0 &&
  10391. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10392. cleanup_finished_threads();
  10393. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10394. }
  10395. }
  10396. cond_.notify_one();
  10397. return true;
  10398. }
  10399. inline void ThreadPool::shutdown() {
  10400. {
  10401. std::unique_lock<std::mutex> lock(mutex_);
  10402. shutdown_ = true;
  10403. }
  10404. cond_.notify_all();
  10405. for (auto &t : threads_) {
  10406. if (t.joinable()) { t.join(); }
  10407. }
  10408. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10409. // with worker threads that call move_to_finished() concurrently.
  10410. std::list<std::thread> remaining_dynamic;
  10411. {
  10412. std::unique_lock<std::mutex> lock(mutex_);
  10413. remaining_dynamic = std::move(dynamic_threads_);
  10414. }
  10415. for (auto &t : remaining_dynamic) {
  10416. if (t.joinable()) { t.join(); }
  10417. }
  10418. std::unique_lock<std::mutex> lock(mutex_);
  10419. cleanup_finished_threads();
  10420. }
  10421. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10422. // Must be called with mutex_ held
  10423. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10424. if (it->get_id() == id) {
  10425. finished_threads_.push_back(std::move(*it));
  10426. dynamic_threads_.erase(it);
  10427. return;
  10428. }
  10429. }
  10430. }
  10431. inline void ThreadPool::cleanup_finished_threads() {
  10432. // Must be called with mutex_ held
  10433. for (auto &t : finished_threads_) {
  10434. if (t.joinable()) { t.join(); }
  10435. }
  10436. finished_threads_.clear();
  10437. }
  10438. inline void ThreadPool::worker(bool is_dynamic) {
  10439. for (;;) {
  10440. std::function<void()> fn;
  10441. {
  10442. std::unique_lock<std::mutex> lock(mutex_);
  10443. idle_thread_count_++;
  10444. if (is_dynamic) {
  10445. auto has_work =
  10446. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10447. [&] { return !jobs_.empty() || shutdown_; });
  10448. if (!has_work) {
  10449. // Timed out with no work - exit this dynamic thread
  10450. idle_thread_count_--;
  10451. move_to_finished(std::this_thread::get_id());
  10452. break;
  10453. }
  10454. } else {
  10455. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10456. }
  10457. idle_thread_count_--;
  10458. if (shutdown_ && jobs_.empty()) { break; }
  10459. fn = std::move(jobs_.front());
  10460. jobs_.pop_front();
  10461. }
  10462. assert(true == static_cast<bool>(fn));
  10463. fn();
  10464. }
  10465. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10466. !defined(LIBRESSL_VERSION_NUMBER)
  10467. OPENSSL_thread_stop();
  10468. #endif
  10469. }
  10470. /*
  10471. * Group 1 (continued): detail namespace - Stream implementations
  10472. */
  10473. namespace detail {
  10474. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10475. time_t timeout_sec, time_t timeout_usec,
  10476. time_t &actual_timeout_sec,
  10477. time_t &actual_timeout_usec) {
  10478. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10479. auto actual_timeout_msec =
  10480. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10481. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10482. actual_timeout_sec = actual_timeout_msec / 1000;
  10483. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10484. }
  10485. // Socket stream implementation
  10486. inline SocketStream::SocketStream(
  10487. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10488. time_t write_timeout_sec, time_t write_timeout_usec,
  10489. time_t max_timeout_msec,
  10490. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10491. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10492. read_timeout_usec_(read_timeout_usec),
  10493. write_timeout_sec_(write_timeout_sec),
  10494. write_timeout_usec_(write_timeout_usec),
  10495. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10496. read_buff_(read_buff_size_, 0) {}
  10497. inline SocketStream::~SocketStream() = default;
  10498. inline bool SocketStream::is_readable() const {
  10499. return read_buff_off_ < read_buff_content_size_;
  10500. }
  10501. inline bool SocketStream::wait_readable() const {
  10502. if (max_timeout_msec_ <= 0) {
  10503. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10504. }
  10505. time_t read_timeout_sec;
  10506. time_t read_timeout_usec;
  10507. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10508. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10509. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10510. }
  10511. inline bool SocketStream::wait_writable() const {
  10512. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10513. }
  10514. inline bool SocketStream::ensure_readable() {
  10515. if (readable_hint_) {
  10516. readable_hint_ = false;
  10517. return true;
  10518. }
  10519. return wait_readable();
  10520. }
  10521. inline const char *SocketStream::buffered_data(size_t &size) const {
  10522. size = read_buff_content_size_ - read_buff_off_;
  10523. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10524. }
  10525. inline void SocketStream::consume_buffered(size_t size) {
  10526. assert(size <= read_buff_content_size_ - read_buff_off_);
  10527. read_buff_off_ += size;
  10528. }
  10529. inline bool SocketStream::is_peer_alive() const {
  10530. return detail::is_socket_alive(sock_);
  10531. }
  10532. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10533. #ifdef _WIN32
  10534. size =
  10535. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10536. #else
  10537. size = (std::min)(size,
  10538. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10539. #endif
  10540. if (read_buff_off_ < read_buff_content_size_) {
  10541. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10542. if (size <= remaining_size) {
  10543. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10544. read_buff_off_ += size;
  10545. return static_cast<ssize_t>(size);
  10546. } else {
  10547. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10548. read_buff_off_ += remaining_size;
  10549. return static_cast<ssize_t>(remaining_size);
  10550. }
  10551. }
  10552. if (!ensure_readable()) {
  10553. error_ = Error::Timeout;
  10554. return -1;
  10555. }
  10556. read_buff_off_ = 0;
  10557. read_buff_content_size_ = 0;
  10558. if (size < read_buff_size_) {
  10559. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10560. CPPHTTPLIB_RECV_FLAGS);
  10561. if (n <= 0) {
  10562. if (n == 0) {
  10563. error_ = Error::ConnectionClosed;
  10564. } else {
  10565. error_ = Error::Read;
  10566. }
  10567. return n;
  10568. } else if (n <= static_cast<ssize_t>(size)) {
  10569. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10570. return n;
  10571. } else {
  10572. memcpy(ptr, read_buff_.data(), size);
  10573. read_buff_off_ = size;
  10574. read_buff_content_size_ = static_cast<size_t>(n);
  10575. return static_cast<ssize_t>(size);
  10576. }
  10577. } else {
  10578. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10579. if (n <= 0) {
  10580. if (n == 0) {
  10581. error_ = Error::ConnectionClosed;
  10582. } else {
  10583. error_ = Error::Read;
  10584. }
  10585. }
  10586. return n;
  10587. }
  10588. }
  10589. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10590. if (!wait_writable()) { return -1; }
  10591. #if defined(_WIN32) && !defined(_WIN64)
  10592. size =
  10593. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10594. #endif
  10595. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10596. }
  10597. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10598. int &port) const {
  10599. return detail::get_remote_ip_and_port(sock_, ip, port);
  10600. }
  10601. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10602. int &port) const {
  10603. return detail::get_local_ip_and_port(sock_, ip, port);
  10604. }
  10605. inline socket_t SocketStream::socket() const { return sock_; }
  10606. inline time_t SocketStream::duration() const {
  10607. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10608. std::chrono::steady_clock::now() - start_time_)
  10609. .count();
  10610. }
  10611. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10612. read_timeout_sec_ = sec;
  10613. read_timeout_usec_ = usec;
  10614. }
  10615. // Buffer stream implementation
  10616. inline bool BufferStream::is_readable() const { return true; }
  10617. inline bool BufferStream::wait_readable() const { return true; }
  10618. inline bool BufferStream::wait_writable() const { return true; }
  10619. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10620. #if defined(_MSC_VER) && _MSC_VER < 1910
  10621. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10622. #else
  10623. auto len_read = buffer.copy(ptr, size, position);
  10624. #endif
  10625. position += static_cast<size_t>(len_read);
  10626. return static_cast<ssize_t>(len_read);
  10627. }
  10628. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10629. buffer.append(ptr, size);
  10630. return static_cast<ssize_t>(size);
  10631. }
  10632. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10633. int & /*port*/) const {}
  10634. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10635. int & /*port*/) const {}
  10636. inline socket_t BufferStream::socket() const { return 0; }
  10637. inline time_t BufferStream::duration() const { return 0; }
  10638. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10639. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10640. : MatcherBase(pattern) {
  10641. constexpr const char marker[] = "/:";
  10642. // One past the last ending position of a path param substring
  10643. std::size_t last_param_end = 0;
  10644. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10645. // Needed to ensure that parameter names are unique during matcher
  10646. // construction
  10647. // If exceptions are disabled, only last duplicate path
  10648. // parameter will be set
  10649. std::unordered_set<std::string> param_name_set;
  10650. #endif
  10651. while (true) {
  10652. const auto marker_pos = pattern.find(
  10653. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10654. if (marker_pos == std::string::npos) { break; }
  10655. static_fragments_.push_back(
  10656. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10657. const auto param_name_start = marker_pos + str_len(marker);
  10658. auto sep_pos = pattern.find(separator, param_name_start);
  10659. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10660. auto param_name =
  10661. pattern.substr(param_name_start, sep_pos - param_name_start);
  10662. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10663. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10664. std::string msg = "Encountered path parameter '" + param_name +
  10665. "' multiple times in route pattern '" + pattern + "'.";
  10666. throw std::invalid_argument(msg);
  10667. }
  10668. #endif
  10669. param_names_.push_back(std::move(param_name));
  10670. last_param_end = sep_pos + 1;
  10671. }
  10672. if (last_param_end < pattern.length()) {
  10673. static_fragments_.push_back(pattern.substr(last_param_end));
  10674. }
  10675. }
  10676. inline bool PathParamsMatcher::match(Request &request) const {
  10677. request.matches = std::smatch();
  10678. request.path_params.clear();
  10679. // A pattern without parameters is just a literal path to compare against
  10680. if (param_names_.empty()) { return request.path == pattern(); }
  10681. request.path_params.reserve(param_names_.size());
  10682. // One past the position at which the path matched the pattern last time
  10683. std::size_t starting_pos = 0;
  10684. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10685. const auto &fragment = static_fragments_[i];
  10686. if (starting_pos + fragment.length() > request.path.length()) {
  10687. return false;
  10688. }
  10689. // Avoid unnecessary allocation by using strncmp instead of substr +
  10690. // comparison
  10691. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10692. fragment.length()) != 0) {
  10693. return false;
  10694. }
  10695. starting_pos += fragment.length();
  10696. // Should only happen when we have a static fragment after a param
  10697. // Example: '/users/:id/subscriptions'
  10698. // The 'subscriptions' fragment here does not have a corresponding param
  10699. if (i >= param_names_.size()) { continue; }
  10700. auto sep_pos = request.path.find(separator, starting_pos);
  10701. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10702. const auto &param_name = param_names_[i];
  10703. request.path_params.emplace(
  10704. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10705. // Mark everything up to '/' as matched
  10706. starting_pos = sep_pos + 1;
  10707. }
  10708. // Returns false if the path is longer than the pattern
  10709. return starting_pos >= request.path.length();
  10710. }
  10711. inline bool RegexMatcher::match(Request &request) const {
  10712. request.path_params.clear();
  10713. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10714. // a non-match rather than risking a stack overflow in std::regex_match.
  10715. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10716. return false;
  10717. }
  10718. return std::regex_match(request.path, request.matches, regex_);
  10719. }
  10720. // Enclose IPv6 address in brackets if needed
  10721. inline std::string prepare_host_string(const std::string &host) {
  10722. // Enclose IPv6 address in brackets (but not if already enclosed)
  10723. if (host.find(':') == std::string::npos ||
  10724. (!host.empty() && host[0] == '[')) {
  10725. // IPv4, hostname, or already bracketed IPv6
  10726. return host;
  10727. } else {
  10728. // IPv6 address without brackets
  10729. return "[" + host + "]";
  10730. }
  10731. }
  10732. inline std::string make_host_and_port_string(const std::string &host, int port,
  10733. bool is_ssl) {
  10734. auto result = prepare_host_string(host);
  10735. // Append port if not default
  10736. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10737. ; // do nothing
  10738. } else {
  10739. result += ":" + std::to_string(port);
  10740. }
  10741. return result;
  10742. }
  10743. // Create "host:port" string always including port number (for CONNECT method)
  10744. inline std::string
  10745. make_host_and_port_string_always_port(const std::string &host, int port) {
  10746. return prepare_host_string(host) + ":" + std::to_string(port);
  10747. }
  10748. // Value for the Host header a client sends when the caller supplied none.
  10749. // Only the value: callers decide where in their header list it goes.
  10750. inline std::string make_default_host_header_value(const std::string &host,
  10751. int port, bool is_ssl,
  10752. int address_family) {
  10753. if (address_family == AF_UNIX) { return "localhost"; }
  10754. return make_host_and_port_string(host, port, is_ssl);
  10755. }
  10756. inline void add_default_user_agent_header(Request &req) {
  10757. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10758. if (!req.has_header("User-Agent")) {
  10759. req.set_header("User-Agent",
  10760. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10761. }
  10762. #else
  10763. (void)req;
  10764. #endif
  10765. }
  10766. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10767. NormalizedTarget normalize_target(const std::string &host);
  10768. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10769. bool host_matches_no_proxy(const NormalizedTarget &target,
  10770. const std::vector<NoProxyEntry> &entries);
  10771. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10772. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10773. if (prefix_bits == 0) { return true; }
  10774. int full_bytes = prefix_bits / 8;
  10775. int rem_bits = prefix_bits % 8;
  10776. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10777. static_cast<size_t>(full_bytes)) != 0) {
  10778. return false;
  10779. }
  10780. if (rem_bits == 0) { return true; }
  10781. auto i = static_cast<size_t>(full_bytes);
  10782. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10783. return (ip[i] & mask) == (net[i] & mask);
  10784. }
  10785. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10786. if (token.empty()) { return false; }
  10787. if (token == "*") {
  10788. out.kind = NoProxyKind::Wildcard;
  10789. return true;
  10790. }
  10791. auto slash = token.find('/');
  10792. std::string addr_part =
  10793. (slash == std::string::npos) ? token : token.substr(0, slash);
  10794. std::string prefix_part =
  10795. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10796. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10797. // don't silently treat it as a /32 (or /128).
  10798. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10799. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10800. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10801. // when brackets are present.
  10802. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10803. addr_part.back() == ']';
  10804. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10805. if (!bracketed) {
  10806. struct in_addr v4;
  10807. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10808. int prefix = 32;
  10809. if (!prefix_part.empty() &&
  10810. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  10811. prefix)) {
  10812. return false;
  10813. }
  10814. out.kind = NoProxyKind::IPv4Cidr;
  10815. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10816. out.prefix_bits = prefix;
  10817. return true;
  10818. }
  10819. }
  10820. struct in6_addr v6;
  10821. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10822. int prefix = 128;
  10823. if (!prefix_part.empty() &&
  10824. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  10825. prefix)) {
  10826. return false;
  10827. }
  10828. out.kind = NoProxyKind::IPv6Cidr;
  10829. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10830. out.prefix_bits = prefix;
  10831. return true;
  10832. }
  10833. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10834. // the entry is malformed — don't fall through to the hostname branch.
  10835. if (bracketed) { return false; }
  10836. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10837. if (slash != std::string::npos) { return false; }
  10838. // Port-specific entries (host:port) are not supported.
  10839. if (token.find(':') != std::string::npos) { return false; }
  10840. std::string hostname = case_ignore::to_lower(token);
  10841. while (!hostname.empty() && hostname.front() == '.') {
  10842. hostname.erase(hostname.begin());
  10843. }
  10844. while (!hostname.empty() && hostname.back() == '.') {
  10845. hostname.pop_back();
  10846. }
  10847. if (hostname.empty()) { return false; }
  10848. out.kind = NoProxyKind::HostnameSuffix;
  10849. out.hostname_pattern = std::move(hostname);
  10850. return true;
  10851. }
  10852. inline NormalizedTarget normalize_target(const std::string &host) {
  10853. NormalizedTarget t;
  10854. std::string h = host;
  10855. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10856. h = h.substr(1, h.size() - 2);
  10857. }
  10858. // Strip a single trailing dot so "example.com." canonicalizes to
  10859. // "example.com".
  10860. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10861. t.hostname = case_ignore::to_lower(h);
  10862. if (!t.hostname.empty()) {
  10863. struct in_addr v4;
  10864. struct in6_addr v6;
  10865. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10866. t.is_ipv4 = true;
  10867. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10868. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10869. t.is_ipv6 = true;
  10870. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10871. }
  10872. }
  10873. return t;
  10874. }
  10875. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10876. const std::vector<NoProxyEntry> &entries) {
  10877. if (target.hostname.empty()) { return false; }
  10878. for (const auto &e : entries) {
  10879. switch (e.kind) {
  10880. case NoProxyKind::Wildcard: return true;
  10881. case NoProxyKind::IPv4Cidr:
  10882. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10883. return true;
  10884. }
  10885. break;
  10886. case NoProxyKind::IPv6Cidr:
  10887. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10888. return true;
  10889. }
  10890. break;
  10891. case NoProxyKind::HostnameSuffix:
  10892. if (target.is_ipv4 || target.is_ipv6) { break; }
  10893. if (target.hostname == e.hostname_pattern) { return true; }
  10894. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10895. // an entry of "example.com".
  10896. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10897. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10898. if (target.hostname[offset - 1] == '.' &&
  10899. target.hostname.compare(offset, e.hostname_pattern.size(),
  10900. e.hostname_pattern) == 0) {
  10901. return true;
  10902. }
  10903. }
  10904. break;
  10905. }
  10906. }
  10907. return false;
  10908. }
  10909. template <typename T>
  10910. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10911. T header_writer, Error &error) {
  10912. for (const auto &h : headers) {
  10913. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10914. error = Error::InvalidHeaders;
  10915. return false;
  10916. }
  10917. }
  10918. if (header_writer(strm, headers) <= 0) {
  10919. error = Error::Write;
  10920. return false;
  10921. }
  10922. return true;
  10923. }
  10924. } // namespace detail
  10925. /*
  10926. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10927. */
  10928. #ifdef CPPHTTPLIB_SSL_ENABLED
  10929. namespace detail {
  10930. // SSL socket stream implementation
  10931. inline SSLSocketStream::SSLSocketStream(
  10932. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10933. time_t read_timeout_usec, time_t write_timeout_sec,
  10934. time_t write_timeout_usec, time_t max_timeout_msec,
  10935. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10936. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10937. read_timeout_usec_(read_timeout_usec),
  10938. write_timeout_sec_(write_timeout_sec),
  10939. write_timeout_usec_(write_timeout_usec),
  10940. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10941. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10942. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10943. // Note: create_session() also clears this, but SSLClient currently
  10944. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10945. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10946. // SSL session was created.
  10947. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10948. #endif
  10949. }
  10950. inline SSLSocketStream::~SSLSocketStream() = default;
  10951. inline bool SSLSocketStream::is_readable() const {
  10952. return tls::pending(session_) > 0;
  10953. }
  10954. inline bool SSLSocketStream::wait_readable() const {
  10955. if (max_timeout_msec_ <= 0) {
  10956. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10957. }
  10958. time_t read_timeout_sec;
  10959. time_t read_timeout_usec;
  10960. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10961. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10962. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10963. }
  10964. inline bool SSLSocketStream::wait_writable() const {
  10965. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10966. !tls::is_peer_closed(session_, sock_);
  10967. }
  10968. inline bool SSLSocketStream::ensure_readable() {
  10969. if (readable_hint_) {
  10970. readable_hint_ = false;
  10971. return true;
  10972. }
  10973. return wait_readable();
  10974. }
  10975. inline bool SSLSocketStream::is_peer_alive() const {
  10976. return !tls::is_peer_closed(session_, sock_);
  10977. }
  10978. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10979. if (tls::pending(session_) > 0) {
  10980. tls::TlsError err;
  10981. auto ret = tls::read(session_, ptr, size, err);
  10982. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10983. error_ = Error::ConnectionClosed;
  10984. }
  10985. return ret;
  10986. } else if (ensure_readable()) {
  10987. tls::TlsError err;
  10988. auto ret = tls::read(session_, ptr, size, err);
  10989. if (ret < 0) {
  10990. auto n = 1000;
  10991. #ifdef _WIN32
  10992. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10993. (err.code == tls::ErrorCode::SyscallError &&
  10994. WSAGetLastError() == WSAETIMEDOUT))) {
  10995. #else
  10996. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10997. #endif
  10998. if (tls::pending(session_) > 0) {
  10999. return tls::read(session_, ptr, size, err);
  11000. } else if (wait_readable()) {
  11001. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11002. ret = tls::read(session_, ptr, size, err);
  11003. if (ret >= 0) { return ret; }
  11004. } else {
  11005. break;
  11006. }
  11007. }
  11008. assert(ret < 0);
  11009. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11010. error_ = Error::ConnectionClosed;
  11011. }
  11012. return ret;
  11013. } else {
  11014. error_ = Error::Timeout;
  11015. return -1;
  11016. }
  11017. }
  11018. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11019. if (wait_writable()) {
  11020. auto handle_size =
  11021. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11022. tls::TlsError err;
  11023. auto ret = tls::write(session_, ptr, handle_size, err);
  11024. if (ret < 0) {
  11025. auto n = 1000;
  11026. #ifdef _WIN32
  11027. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11028. (err.code == tls::ErrorCode::SyscallError &&
  11029. WSAGetLastError() == WSAETIMEDOUT))) {
  11030. #else
  11031. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11032. #endif
  11033. if (wait_writable()) {
  11034. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11035. ret = tls::write(session_, ptr, handle_size, err);
  11036. if (ret >= 0) { return ret; }
  11037. } else {
  11038. break;
  11039. }
  11040. }
  11041. assert(ret < 0);
  11042. }
  11043. return ret;
  11044. }
  11045. return -1;
  11046. }
  11047. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11048. int &port) const {
  11049. detail::get_remote_ip_and_port(sock_, ip, port);
  11050. }
  11051. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11052. int &port) const {
  11053. detail::get_local_ip_and_port(sock_, ip, port);
  11054. }
  11055. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11056. inline time_t SSLSocketStream::duration() const {
  11057. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11058. std::chrono::steady_clock::now() - start_time_)
  11059. .count();
  11060. }
  11061. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11062. read_timeout_sec_ = sec;
  11063. read_timeout_usec_ = usec;
  11064. }
  11065. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11066. tls::session_t session,
  11067. time_t read_timeout_sec,
  11068. time_t read_timeout_usec,
  11069. time_t write_timeout_sec,
  11070. time_t write_timeout_usec)
  11071. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11072. read_timeout_usec_(read_timeout_usec),
  11073. write_timeout_sec_(write_timeout_sec),
  11074. write_timeout_usec_(write_timeout_usec),
  11075. start_time_(std::chrono::steady_clock::now()) {
  11076. // The receive and send paths run on different threads, so each TLS call is
  11077. // driven in non-blocking mode and readiness is awaited with select()
  11078. // outside the session lock. Set the socket non-blocking once here; it is
  11079. // never flipped back, so no thread races on the flag.
  11080. detail::set_nonblocking(sock_, true);
  11081. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11082. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11083. #endif
  11084. }
  11085. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11086. inline bool WebSocketSSLStream::is_readable() const {
  11087. std::lock_guard<std::mutex> guard(session_mutex_);
  11088. return tls::pending(session_) > 0;
  11089. }
  11090. inline bool WebSocketSSLStream::wait_readable() const {
  11091. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11092. }
  11093. inline bool WebSocketSSLStream::wait_writable() const {
  11094. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11095. // that probe toggles the socket's blocking flag, which would race with the
  11096. // concurrent reader on a permanently non-blocking socket.
  11097. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11098. }
  11099. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11100. tls::TlsError err;
  11101. auto n = 1000;
  11102. while (--n >= 0) {
  11103. {
  11104. std::lock_guard<std::mutex> guard(session_mutex_);
  11105. auto ret = tls::read(session_, ptr, size, err);
  11106. if (ret > 0) { return ret; }
  11107. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11108. error_ = Error::ConnectionClosed;
  11109. return ret;
  11110. }
  11111. }
  11112. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11113. // direction: the send path shares this session, so output it left pending
  11114. // has to be flushed before more input can be decrypted. Anything else is
  11115. // a hard error.
  11116. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11117. #ifdef _WIN32
  11118. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11119. needs_readable =
  11120. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11121. WSAGetLastError() == WSAETIMEDOUT);
  11122. #endif
  11123. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11124. error_ = Error::Read;
  11125. return -1;
  11126. }
  11127. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11128. error_ = Error::Timeout;
  11129. return -1;
  11130. }
  11131. }
  11132. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11133. // to tell a timeout from a close would otherwise see whatever the previous
  11134. // failure left behind (error_ is never cleared on success).
  11135. error_ = Error::Read;
  11136. return -1;
  11137. }
  11138. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11139. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11140. tls::TlsError err;
  11141. auto n = 1000;
  11142. while (--n >= 0) {
  11143. {
  11144. std::lock_guard<std::mutex> guard(session_mutex_);
  11145. auto ret = tls::write(session_, ptr, handle_size, err);
  11146. if (ret >= 0) { return ret; }
  11147. }
  11148. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11149. // or a post-handshake message must be consumed before the record goes
  11150. // out. Anything else is a hard error.
  11151. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11152. #ifdef _WIN32
  11153. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11154. needs_writable =
  11155. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11156. WSAGetLastError() == WSAETIMEDOUT);
  11157. #endif
  11158. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11159. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11160. }
  11161. return -1;
  11162. }
  11163. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11164. int &port) const {
  11165. detail::get_remote_ip_and_port(sock_, ip, port);
  11166. }
  11167. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11168. int &port) const {
  11169. detail::get_local_ip_and_port(sock_, ip, port);
  11170. }
  11171. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11172. inline time_t WebSocketSSLStream::duration() const {
  11173. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11174. std::chrono::steady_clock::now() - start_time_)
  11175. .count();
  11176. }
  11177. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11178. read_timeout_sec_ = sec;
  11179. read_timeout_usec_ = usec;
  11180. }
  11181. } // namespace detail
  11182. #endif // CPPHTTPLIB_SSL_ENABLED
  11183. /*
  11184. * Group 4: Server implementation
  11185. */
  11186. // HTTP server implementation
  11187. inline Server::Server()
  11188. : new_task_queue([] {
  11189. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11190. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11191. }) {
  11192. #ifndef _WIN32
  11193. signal(SIGPIPE, SIG_IGN);
  11194. #endif
  11195. }
  11196. inline Server::~Server() = default;
  11197. inline std::unique_ptr<detail::MatcherBase>
  11198. Server::make_matcher(const std::string &pattern) {
  11199. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11200. // a path params pattern
  11201. if (pattern.find("/:") != std::string::npos) {
  11202. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11203. }
  11204. // A pattern with no regex metacharacter only has to be compared literally,
  11205. // which is what PathParamsMatcher already does when it captures no
  11206. // parameter, so std::regex is only worth building for the patterns that
  11207. // actually need it
  11208. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11209. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11210. }
  11211. return detail::make_unique<detail::RegexMatcher>(pattern);
  11212. }
  11213. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11214. return add_handler(get_handlers_, pattern, std::move(handler));
  11215. }
  11216. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11217. return add_handler(post_handlers_, pattern, std::move(handler));
  11218. }
  11219. inline Server &Server::Post(const std::string &pattern,
  11220. HandlerWithContentReader handler) {
  11221. return add_handler(post_handlers_for_content_reader_, pattern,
  11222. std::move(handler));
  11223. }
  11224. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11225. return add_handler(put_handlers_, pattern, std::move(handler));
  11226. }
  11227. inline Server &Server::Put(const std::string &pattern,
  11228. HandlerWithContentReader handler) {
  11229. return add_handler(put_handlers_for_content_reader_, pattern,
  11230. std::move(handler));
  11231. }
  11232. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11233. return add_handler(patch_handlers_, pattern, std::move(handler));
  11234. }
  11235. inline Server &Server::Patch(const std::string &pattern,
  11236. HandlerWithContentReader handler) {
  11237. return add_handler(patch_handlers_for_content_reader_, pattern,
  11238. std::move(handler));
  11239. }
  11240. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11241. return add_handler(delete_handlers_, pattern, std::move(handler));
  11242. }
  11243. inline Server &Server::Delete(const std::string &pattern,
  11244. HandlerWithContentReader handler) {
  11245. return add_handler(delete_handlers_for_content_reader_, pattern,
  11246. std::move(handler));
  11247. }
  11248. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11249. return add_handler(options_handlers_, pattern, std::move(handler));
  11250. }
  11251. inline const std::set<std::string> &Server::builtin_methods() {
  11252. thread_local const std::set<std::string> methods{
  11253. "GET", "HEAD", "POST", "PUT", "DELETE",
  11254. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11255. return methods;
  11256. }
  11257. inline Server::CustomHandlerEntry *
  11258. Server::custom_entry_for_registration(const std::string &method) {
  11259. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11260. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11261. // routing() before the custom tables are consulted, so a route registered
  11262. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11263. // there and would be reachable, but they carry protocol-level meaning
  11264. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11265. // library does not route.
  11266. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11267. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11268. has_invalid_registration_ = true;
  11269. return nullptr;
  11270. }
  11271. return &custom_handlers_[method];
  11272. }
  11273. inline Server &Server::CustomRoute(const std::string &method,
  11274. const std::string &pattern,
  11275. Handler handler) {
  11276. auto *entry = custom_entry_for_registration(method);
  11277. if (!entry) { return *this; }
  11278. return add_handler(entry->handlers, pattern, std::move(handler));
  11279. }
  11280. inline Server &Server::CustomRoute(const std::string &method,
  11281. const std::string &pattern,
  11282. HandlerWithContentReader handler) {
  11283. auto *entry = custom_entry_for_registration(method);
  11284. if (!entry) { return *this; }
  11285. return add_handler(entry->handlers_for_content_reader, pattern,
  11286. std::move(handler));
  11287. }
  11288. inline const Server::CustomHandlerEntry *
  11289. Server::find_custom_entry(const std::string &method) const {
  11290. // find() alone would be correct here. The empty() check is what keeps the
  11291. // per-request cost off servers that never call CustomRoute(), which is the
  11292. // overwhelmingly common case; keep it rather than walking into the tree.
  11293. if (custom_handlers_.empty()) { return nullptr; }
  11294. auto it = custom_handlers_.find(method);
  11295. return it == custom_handlers_.end() ? nullptr : &it->second;
  11296. }
  11297. inline Server &Server::WebSocket(const std::string &pattern,
  11298. WebSocketHandler handler) {
  11299. websocket_handlers_.push_back(
  11300. {make_matcher(pattern), std::move(handler), nullptr});
  11301. return *this;
  11302. }
  11303. inline Server &Server::WebSocket(const std::string &pattern,
  11304. WebSocketHandler handler,
  11305. SubProtocolSelector sub_protocol_selector) {
  11306. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11307. std::move(sub_protocol_selector)});
  11308. return *this;
  11309. }
  11310. inline bool Server::set_base_dir(const std::string &dir,
  11311. const std::string &mount_point) {
  11312. return set_mount_point(mount_point, dir);
  11313. }
  11314. inline bool Server::set_mount_point(const std::string &mount_point,
  11315. const std::string &dir, Headers headers) {
  11316. detail::FileStat stat(dir);
  11317. if (stat.is_dir()) {
  11318. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11319. if (!mnt.empty() && mnt[0] == '/') {
  11320. // Without the resolved directory, a file could not be checked to be
  11321. // inside it.
  11322. std::string resolved_base;
  11323. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11324. return false;
  11325. }
  11326. #if defined(_WIN32)
  11327. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11328. resolved_base += '\\';
  11329. }
  11330. #else
  11331. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11332. #endif
  11333. base_dirs_.push_back(
  11334. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11335. return true;
  11336. }
  11337. }
  11338. return false;
  11339. }
  11340. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11341. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11342. if (it->mount_point == mount_point) {
  11343. base_dirs_.erase(it);
  11344. return true;
  11345. }
  11346. }
  11347. return false;
  11348. }
  11349. inline Server &
  11350. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11351. const std::string &mime) {
  11352. file_extension_and_mimetype_map_[ext] = mime;
  11353. return *this;
  11354. }
  11355. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11356. default_file_mimetype_ = mime;
  11357. return *this;
  11358. }
  11359. inline Server &Server::set_file_request_handler(Handler handler) {
  11360. file_request_handler_ = std::move(handler);
  11361. return *this;
  11362. }
  11363. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11364. std::true_type) {
  11365. error_handler_ = std::move(handler);
  11366. return *this;
  11367. }
  11368. inline Server &Server::set_error_handler_core(Handler handler,
  11369. std::false_type) {
  11370. error_handler_ = [handler](const Request &req, Response &res) {
  11371. handler(req, res);
  11372. return HandlerResponse::Handled;
  11373. };
  11374. return *this;
  11375. }
  11376. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11377. exception_handler_ = std::move(handler);
  11378. return *this;
  11379. }
  11380. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11381. pre_routing_handler_ = std::move(handler);
  11382. return *this;
  11383. }
  11384. inline Server &Server::set_post_routing_handler(Handler handler) {
  11385. post_routing_handler_ = std::move(handler);
  11386. return *this;
  11387. }
  11388. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11389. pre_request_handler_ = std::move(handler);
  11390. return *this;
  11391. }
  11392. inline Server &Server::set_logger(Logger logger) {
  11393. logger_ = std::move(logger);
  11394. return *this;
  11395. }
  11396. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11397. error_logger_ = std::move(error_logger);
  11398. return *this;
  11399. }
  11400. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11401. pre_compression_logger_ = std::move(logger);
  11402. return *this;
  11403. }
  11404. inline Server &
  11405. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11406. expect_100_continue_handler_ = std::move(handler);
  11407. return *this;
  11408. }
  11409. inline Server &Server::set_start_handler(StartHandler handler) {
  11410. start_handler_ = std::move(handler);
  11411. return *this;
  11412. }
  11413. inline Server &Server::set_address_family(int family) {
  11414. address_family_ = family;
  11415. return *this;
  11416. }
  11417. inline Server &Server::set_tcp_nodelay(bool on) {
  11418. tcp_nodelay_ = on;
  11419. return *this;
  11420. }
  11421. inline Server &Server::set_ipv6_v6only(bool on) {
  11422. ipv6_v6only_ = on;
  11423. return *this;
  11424. }
  11425. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11426. socket_options_ = std::move(socket_options);
  11427. return *this;
  11428. }
  11429. inline Server &Server::set_default_headers(Headers headers) {
  11430. default_headers_ = std::move(headers);
  11431. return *this;
  11432. }
  11433. inline Server &Server::set_header_writer(
  11434. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11435. header_writer_ = writer;
  11436. return *this;
  11437. }
  11438. inline Server &
  11439. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11440. trusted_proxies_ = proxies;
  11441. return *this;
  11442. }
  11443. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11444. keep_alive_max_count_ = count;
  11445. return *this;
  11446. }
  11447. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11448. keep_alive_timeout_sec_ = sec;
  11449. return *this;
  11450. }
  11451. template <class Rep, class Period>
  11452. inline Server &Server::set_keep_alive_timeout(
  11453. const std::chrono::duration<Rep, Period> &duration) {
  11454. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11455. set_keep_alive_timeout(sec);
  11456. });
  11457. return *this;
  11458. }
  11459. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11460. read_timeout_sec_ = sec;
  11461. read_timeout_usec_ = usec;
  11462. return *this;
  11463. }
  11464. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11465. write_timeout_sec_ = sec;
  11466. write_timeout_usec_ = usec;
  11467. return *this;
  11468. }
  11469. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11470. idle_interval_sec_ = sec;
  11471. idle_interval_usec_ = usec;
  11472. return *this;
  11473. }
  11474. inline Server &Server::set_payload_max_length(size_t length) {
  11475. payload_max_length_ = length;
  11476. return *this;
  11477. }
  11478. inline Server &Server::set_static_file_compression(bool on) {
  11479. static_file_compression_ = on;
  11480. return *this;
  11481. }
  11482. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11483. static_file_compression_min_length_ = length;
  11484. return *this;
  11485. }
  11486. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11487. static_file_compression_max_length_ = length;
  11488. return *this;
  11489. }
  11490. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11491. websocket_max_missed_pongs_ = count;
  11492. return *this;
  11493. }
  11494. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11495. websocket_ping_interval_sec_ = sec;
  11496. return *this;
  11497. }
  11498. template <class Rep, class Period>
  11499. inline Server &Server::set_websocket_ping_interval(
  11500. const std::chrono::duration<Rep, Period> &duration) {
  11501. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11502. set_websocket_ping_interval(sec);
  11503. });
  11504. return *this;
  11505. }
  11506. inline bool Server::bind_to_port(const std::string &host, int port,
  11507. int socket_flags) {
  11508. auto ret = bind_internal(host, port, socket_flags);
  11509. if (ret == -1) { is_decommissioned = true; }
  11510. return ret >= 0;
  11511. }
  11512. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11513. auto ret = bind_internal(host, 0, socket_flags);
  11514. if (ret == -1) { is_decommissioned = true; }
  11515. return ret;
  11516. }
  11517. inline bool Server::listen_after_bind() { return listen_internal(); }
  11518. inline bool Server::listen(const std::string &host, int port,
  11519. int socket_flags) {
  11520. return bind_to_port(host, port, socket_flags) && listen_internal();
  11521. }
  11522. inline bool Server::is_running() const { return is_running_; }
  11523. inline void Server::wait_until_ready() const {
  11524. while (!is_running_ && !is_decommissioned) {
  11525. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11526. }
  11527. }
  11528. inline void Server::stop() noexcept {
  11529. // Release the listening socket whether or not the accept loop is running:
  11530. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11531. // exchange is what makes this safe to call concurrently with the accept loop.
  11532. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11533. if (sock != INVALID_SOCKET) {
  11534. detail::shutdown_socket(sock);
  11535. detail::close_socket(sock);
  11536. }
  11537. is_decommissioned = false;
  11538. }
  11539. inline void Server::decommission() { is_decommissioned = true; }
  11540. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11541. auto len = strlen(s);
  11542. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11543. len -= 2;
  11544. {
  11545. // RFC 9112 §3: exactly one SP between the method, the target and the
  11546. // version. Taking other whitespace as a separator too lets recipients
  11547. // that parse more strictly see a different request.
  11548. auto end = s + len;
  11549. auto sp1 = std::find(s, end, ' ');
  11550. auto sp2 = sp1 == end ? end : std::find(sp1 + 1, end, ' ');
  11551. if (sp2 == end || std::find(sp2 + 1, end, ' ') != end || sp1 == s ||
  11552. sp2 == sp1 + 1 || sp2 + 1 == end) {
  11553. return false;
  11554. }
  11555. req.method.assign(s, sp1);
  11556. req.target.assign(sp1 + 1, sp2);
  11557. req.version.assign(sp2 + 1, end);
  11558. }
  11559. // A method outside the built-in set is accepted only when a handler has been
  11560. // registered for it with CustomRoute().
  11561. const auto &methods = builtin_methods();
  11562. if (methods.find(req.method) == methods.end() &&
  11563. !find_custom_entry(req.method)) {
  11564. output_error_log(Error::InvalidHTTPMethod, &req);
  11565. return false;
  11566. }
  11567. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11568. output_error_log(Error::InvalidHTTPVersion, &req);
  11569. return false;
  11570. }
  11571. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11572. // would leave this server routing a different path than a cache or a
  11573. // filter in front of it sees.
  11574. if (!detail::fields::is_request_target(req.target) ||
  11575. req.target.find('#') != std::string::npos) {
  11576. return false;
  11577. }
  11578. {
  11579. detail::divide(req.target, '?',
  11580. [&](const char *lhs_data, std::size_t lhs_size,
  11581. const char *rhs_data, std::size_t rhs_size) {
  11582. req.path =
  11583. decode_path_component(std::string(lhs_data, lhs_size));
  11584. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11585. });
  11586. }
  11587. return true;
  11588. }
  11589. inline bool Server::write_response(Stream &strm, bool close_connection,
  11590. Request &req, Response &res) {
  11591. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11592. // incorrectly to the error content.
  11593. req.ranges.clear();
  11594. return write_response_core(strm, close_connection, req, res, false);
  11595. }
  11596. inline bool Server::write_response_with_content(Stream &strm,
  11597. bool close_connection,
  11598. const Request &req,
  11599. Response &res) {
  11600. return write_response_core(strm, close_connection, req, res, true);
  11601. }
  11602. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11603. const Request &req, Response &res,
  11604. bool need_apply_ranges) {
  11605. assert(res.status != -1);
  11606. if (400 <= res.status && error_handler_ &&
  11607. error_handler_(req, res) == HandlerResponse::Handled) {
  11608. need_apply_ranges = true;
  11609. }
  11610. detail::prefer_assigned_body(res);
  11611. std::string content_type;
  11612. std::string boundary;
  11613. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11614. // Prepare additional headers
  11615. if (close_connection ||
  11616. detail::has_header_token(req.headers, "Connection", "close") ||
  11617. 400 <= res.status || // Don't leave connections open after errors
  11618. // The client withholds the body until `100 Continue`, which was never
  11619. // sent, so whether and when the body follows is unknown.
  11620. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11621. // The body was left partway, e.g. by a content receiver that returned
  11622. // false, so the rest of it cannot be told from the next request.
  11623. (req.body_read_started_ && !req.body_consumed_)) {
  11624. res.set_header("Connection", "close");
  11625. } else {
  11626. std::string s = "timeout=";
  11627. s += std::to_string(keep_alive_timeout_sec_);
  11628. s += ", max=";
  11629. s += std::to_string(keep_alive_max_count_);
  11630. res.set_header("Keep-Alive", s);
  11631. }
  11632. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11633. !res.has_header("Content-Type")) {
  11634. res.set_header("Content-Type", "text/plain");
  11635. }
  11636. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11637. !res.has_header("Content-Length")) {
  11638. res.set_header("Content-Length", "0");
  11639. }
  11640. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11641. res.set_header("Accept-Ranges", "bytes");
  11642. }
  11643. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11644. // Response line and headers
  11645. detail::BufferStream bstrm;
  11646. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11647. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11648. // Combine a small body with the headers so the whole response leaves in a
  11649. // single write. A large body is written on its own instead: a copy of it
  11650. // costs more than the extra write saves.
  11651. auto send_body = req.method != "HEAD";
  11652. auto body_is_separate = false;
  11653. auto provider_done = false;
  11654. if (send_body && !res.body.empty() && !res.content_provider_) {
  11655. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11656. bstrm.write(res.body.data(), res.body.size());
  11657. } else {
  11658. body_is_separate = true;
  11659. }
  11660. } else if (send_body && res.content_provider_ &&
  11661. res.is_file_content_provider_ &&
  11662. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11663. // A small file is read into the same buffer. Other providers may produce
  11664. // their data over time, so they are never held back.
  11665. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11666. return false;
  11667. }
  11668. provider_done = true;
  11669. }
  11670. // Log before writing to avoid race condition with client-side code that
  11671. // accesses logger-captured data immediately after receiving the response.
  11672. output_log(req, res);
  11673. // Flush buffer
  11674. auto &data = bstrm.get_buffer();
  11675. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11676. if (body_is_separate) {
  11677. return detail::write_data(strm, res.body.data(), res.body.size());
  11678. }
  11679. // Streaming body
  11680. if (send_body && res.content_provider_) {
  11681. if (!provider_done &&
  11682. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11683. return false;
  11684. }
  11685. res.content_provider_success_ = true;
  11686. }
  11687. return true;
  11688. }
  11689. inline bool
  11690. Server::write_content_with_provider(Stream &strm, const Request &req,
  11691. Response &res, const std::string &boundary,
  11692. const std::string &content_type) {
  11693. auto is_shutting_down = [this]() {
  11694. return this->svr_sock_ == INVALID_SOCKET;
  11695. };
  11696. if (res.content_length_ > 0) {
  11697. // Only a 206 response is served as a partial representation, matching the
  11698. // condition `apply_ranges()` used to decide the Content-Length and the
  11699. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11700. // only for a 2xx status, slicing under any other status would write a body
  11701. // that disagrees with the header already sent, from an unchecked offset.
  11702. auto is_partial =
  11703. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11704. if (!is_partial) {
  11705. return detail::write_content(strm, res.content_provider_, 0,
  11706. res.content_length_, is_shutting_down);
  11707. } else if (req.ranges.size() == 1) {
  11708. auto offset_and_length = detail::get_range_offset_and_length(
  11709. req.ranges[0], res.content_length_);
  11710. return detail::write_content(strm, res.content_provider_,
  11711. offset_and_length.first,
  11712. offset_and_length.second, is_shutting_down);
  11713. } else {
  11714. return detail::write_multipart_ranges_data(
  11715. strm, req, res, boundary, content_type, res.content_length_,
  11716. is_shutting_down);
  11717. }
  11718. } else {
  11719. if (res.is_chunked_content_provider_) {
  11720. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11721. // re-negotiating here would disagree with them, e.g. once a handler's
  11722. // own Content-Encoding header suppresses the negotiation.
  11723. auto compressor = detail::make_compressor(res.content_coding_);
  11724. if (!compressor) {
  11725. compressor = detail::make_unique<detail::nocompressor>();
  11726. }
  11727. return detail::write_content_chunked(strm, res.content_provider_,
  11728. is_shutting_down, *compressor);
  11729. } else {
  11730. return detail::write_content_without_length(strm, res.content_provider_,
  11731. is_shutting_down);
  11732. }
  11733. }
  11734. }
  11735. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11736. FormFields::iterator cur_field;
  11737. FormFiles::iterator cur_file;
  11738. auto is_text_field = false;
  11739. size_t count = 0;
  11740. if (read_content_core(
  11741. strm, req, res,
  11742. // Regular
  11743. [&](const char *buf, size_t n) {
  11744. // Prevent arithmetic overflow when checking sizes.
  11745. // Avoid computing (req.body.size() + n) directly because
  11746. // adding two unsigned `size_t` values can wrap around and
  11747. // produce a small result instead of indicating overflow.
  11748. // Instead, check using subtraction: ensure `n` does not
  11749. // exceed the remaining capacity `max_size() - size()`.
  11750. if (req.body.size() >= req.body.max_size() ||
  11751. n > req.body.max_size() - req.body.size()) {
  11752. return false;
  11753. }
  11754. // Limit decompressed body size to payload_max_length_ to protect
  11755. // against "zip bomb" attacks where a small compressed payload
  11756. // decompresses to a massive size.
  11757. if (payload_max_length_ > 0 &&
  11758. (req.body.size() >= payload_max_length_ ||
  11759. n > payload_max_length_ - req.body.size())) {
  11760. return false;
  11761. }
  11762. req.body.append(buf, n);
  11763. return true;
  11764. },
  11765. // Multipart FormData
  11766. [&](const FormData &file) {
  11767. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11768. output_error_log(Error::TooManyFormDataFiles, &req);
  11769. return false;
  11770. }
  11771. if (file.filename.empty()) {
  11772. cur_field = req.form.fields.emplace(
  11773. file.name, FormField{file.name, file.content, file.headers});
  11774. is_text_field = true;
  11775. } else {
  11776. cur_file = req.form.files.emplace(file.name, file);
  11777. is_text_field = false;
  11778. }
  11779. return true;
  11780. },
  11781. [&](const char *buf, size_t n) {
  11782. if (is_text_field) {
  11783. auto &content = cur_field->second.content;
  11784. if (content.size() + n > content.max_size()) { return false; }
  11785. content.append(buf, n);
  11786. } else {
  11787. auto &content = cur_file->second.content;
  11788. if (content.size() + n > content.max_size()) { return false; }
  11789. content.append(buf, n);
  11790. }
  11791. return true;
  11792. })) {
  11793. const auto &content_type = req.get_header_value("Content-Type");
  11794. if (detail::extract_media_type(content_type) ==
  11795. "application/x-www-form-urlencoded") {
  11796. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11797. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11798. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11799. return false;
  11800. }
  11801. detail::parse_query_text(req.body, req.params);
  11802. }
  11803. return true;
  11804. }
  11805. return false;
  11806. }
  11807. inline bool Server::read_content_with_content_receiver(
  11808. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11809. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11810. return read_content_core(strm, req, res, std::move(receiver),
  11811. std::move(multipart_header),
  11812. std::move(multipart_receiver));
  11813. }
  11814. inline bool Server::read_content_core(
  11815. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11816. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11817. detail::FormDataParser multipart_form_data_parser;
  11818. ContentReceiverWithProgress out;
  11819. if (req.is_multipart_form_data()) {
  11820. const auto &content_type = req.get_header_value("Content-Type");
  11821. std::string boundary;
  11822. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11823. res.status = StatusCode::BadRequest_400;
  11824. output_error_log(Error::MultipartParsing, &req);
  11825. return false;
  11826. }
  11827. multipart_form_data_parser.set_boundary(std::move(boundary));
  11828. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11829. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11830. multipart_receiver);
  11831. };
  11832. } else {
  11833. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11834. size_t /*len*/) { return receiver(buf, n); };
  11835. }
  11836. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11837. // For non-SSL builds we still scan non-persistent connections for stray
  11838. // body bytes so the payload limit is enforced (413). On keep-alive,
  11839. // pending bytes may be the next request (issue #2450), so skip.
  11840. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11841. if (!req.has_header("Content-Length") &&
  11842. !detail::is_chunked_transfer_encoding(req.headers)) {
  11843. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11844. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11845. auto has_data = strm.is_readable();
  11846. if (!has_data) {
  11847. auto s = strm.socket();
  11848. if (s != INVALID_SOCKET) {
  11849. has_data = detail::select_read(s, 0, 0) > 0;
  11850. }
  11851. }
  11852. if (has_data) {
  11853. // Route through the same decompressing reader used by the
  11854. // length-framed and chunked paths below, so payload_max_length_ is
  11855. // enforced on the decompressed size here too instead of only on the
  11856. // compressed wire bytes.
  11857. return detail::read_content(strm, req, payload_max_length_, res.status,
  11858. nullptr, out, true);
  11859. }
  11860. }
  11861. return true;
  11862. }
  11863. #else
  11864. if (!req.has_header("Content-Length") &&
  11865. !detail::is_chunked_transfer_encoding(req.headers)) {
  11866. return true;
  11867. }
  11868. #endif
  11869. // A second read would start where the first one stopped, or in the next
  11870. // request.
  11871. if (req.body_read_started_) { return false; }
  11872. // The client is waiting for this before it sends the body.
  11873. if (req.expect_100_continue_pending_) {
  11874. req.expect_100_continue_pending_ = false;
  11875. detail::write_response_line(strm, StatusCode::Continue_100);
  11876. strm.write("\r\n");
  11877. }
  11878. // Set before reading, since a receiver may also stop by throwing.
  11879. req.body_read_started_ = true;
  11880. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11881. out, true)) {
  11882. return false;
  11883. }
  11884. req.body_consumed_ = true;
  11885. if (req.is_multipart_form_data()) {
  11886. if (!multipart_form_data_parser.is_valid()) {
  11887. res.status = StatusCode::BadRequest_400;
  11888. output_error_log(Error::MultipartParsing, &req);
  11889. return false;
  11890. }
  11891. }
  11892. return true;
  11893. }
  11894. inline bool Server::handle_file_request(Request &req, Response &res) {
  11895. for (const auto &entry : base_dirs_) {
  11896. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11897. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11898. // One that already ends in '/' (the root mount among them) carries its own
  11899. // boundary; set_mount_point() guarantees the mount point is not empty.
  11900. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11901. (entry.mount_point.back() == '/' ||
  11902. req.path.size() == entry.mount_point.size() ||
  11903. req.path[entry.mount_point.size()] == '/')) {
  11904. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11905. if (detail::is_valid_path(sub_path)) {
  11906. auto path = entry.base_dir + sub_path;
  11907. if (path.back() == '/') { path += "index.html"; }
  11908. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11909. // but symlinks/junctions can still escape the base directory. A path
  11910. // that cannot be resolved, which includes one that does not exist, is
  11911. // not served from here.
  11912. std::string resolved_path;
  11913. if (!detail::canonicalize_path(path.c_str(), resolved_path)) {
  11914. continue;
  11915. }
  11916. if (!detail::is_path_within_base(resolved_path,
  11917. entry.resolved_base_dir)) {
  11918. res.status = StatusCode::Forbidden_403;
  11919. return true;
  11920. }
  11921. detail::FileStat stat(path);
  11922. if (stat.is_dir()) {
  11923. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  11924. // in the name from reading as a scheme.
  11925. auto name = req.path.substr(req.path.rfind('/') + 1);
  11926. res.set_redirect("./" + encode_path_component(name) + "/",
  11927. StatusCode::MovedPermanently_301);
  11928. return true;
  11929. }
  11930. if (stat.is_file()) {
  11931. for (const auto &kv : entry.headers) {
  11932. res.set_header(kv.first, kv.second);
  11933. }
  11934. auto content_type = detail::find_content_type(
  11935. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11936. auto encoding = detail::EncodingType::None;
  11937. if (static_file_compression_) {
  11938. encoding =
  11939. static_file_encoding(req, res, content_type, stat.size());
  11940. }
  11941. // The ETag names the representation actually sent, so a client that
  11942. // cached the compressed form revalidates against the compressed ETag
  11943. // and still gets a 304, while one that took identity keeps the plain
  11944. // ETag.
  11945. auto etag = detail::compute_etag(
  11946. stat, encoding == detail::EncodingType::None
  11947. ? std::string()
  11948. : std::string("-") + detail::encoding_name(encoding));
  11949. if (!etag.empty()) { res.set_header("ETag", etag); }
  11950. auto mtime = stat.mtime();
  11951. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11952. if (!last_modified.empty()) {
  11953. res.set_header("Last-Modified", last_modified);
  11954. }
  11955. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11956. check_if_range(req, etag, mtime);
  11957. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11958. if (!mm->is_open()) {
  11959. output_error_log(Error::OpenFile, &req);
  11960. return false;
  11961. }
  11962. detail::set_file_content_provider(res, mm, content_type, encoding);
  11963. if (req.method != "HEAD" && file_request_handler_) {
  11964. file_request_handler_(req, res);
  11965. }
  11966. return true;
  11967. } else {
  11968. output_error_log(Error::OpenFile, &req);
  11969. }
  11970. }
  11971. }
  11972. }
  11973. return false;
  11974. }
  11975. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11976. const std::string &etag,
  11977. time_t mtime) const {
  11978. // Handle conditional GET:
  11979. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11980. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11981. if (req.has_header("If-None-Match")) {
  11982. if (!etag.empty()) {
  11983. auto val =
  11984. detail::get_combined_header_value(req.headers, "If-None-Match");
  11985. // NOTE: We use exact string matching here. This works correctly
  11986. // because our server always generates weak ETags (W/"..."), and
  11987. // clients typically send back the same ETag they received.
  11988. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11989. // If-None-Match, where W/"x" and "x" would match, but this
  11990. // simplified implementation requires exact matches.
  11991. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11992. [&](const char *b, const char *e) {
  11993. auto seg_len = static_cast<size_t>(e - b);
  11994. return (seg_len == 1 && *b == '*') ||
  11995. (seg_len == etag.size() &&
  11996. std::equal(b, e, etag.begin()));
  11997. });
  11998. if (ret) {
  11999. res.status = StatusCode::NotModified_304;
  12000. return true;
  12001. }
  12002. }
  12003. } else if (req.has_header("If-Modified-Since")) {
  12004. auto val = req.get_header_value("If-Modified-Since");
  12005. auto t = detail::parse_http_date(val);
  12006. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12007. res.status = StatusCode::NotModified_304;
  12008. return true;
  12009. }
  12010. }
  12011. return false;
  12012. }
  12013. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12014. time_t mtime) const {
  12015. // Handle If-Range for partial content requests (RFC 9110
  12016. // Section 13.1.5). If-Range is only evaluated when Range header is
  12017. // present. If the validator matches, serve partial content; otherwise
  12018. // serve full content.
  12019. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12020. auto val = req.get_header_value("If-Range");
  12021. auto is_valid_range = [&]() {
  12022. if (detail::is_strong_etag(val)) {
  12023. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12024. // comparison.
  12025. return (!etag.empty() && val == etag);
  12026. } else if (detail::is_weak_etag(val)) {
  12027. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12028. return false;
  12029. } else {
  12030. // HTTP-date comparison
  12031. auto t = detail::parse_http_date(val);
  12032. return (t != static_cast<time_t>(-1) && mtime <= t);
  12033. }
  12034. };
  12035. if (!is_valid_range()) {
  12036. // Validator doesn't match: ignore Range and serve full content
  12037. req.ranges.clear();
  12038. return false;
  12039. }
  12040. }
  12041. return true;
  12042. }
  12043. inline socket_t
  12044. Server::create_server_socket(const std::string &host, int port,
  12045. int socket_flags,
  12046. SocketOptions socket_options) const {
  12047. return detail::create_socket(
  12048. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12049. ipv6_v6only_, std::move(socket_options),
  12050. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12051. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12052. output_error_log(Error::BindIPAddress, nullptr);
  12053. return false;
  12054. }
  12055. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12056. output_error_log(Error::Listen, nullptr);
  12057. return false;
  12058. }
  12059. return true;
  12060. });
  12061. }
  12062. inline int Server::bind_internal(const std::string &host, int port,
  12063. int socket_flags) {
  12064. if (is_decommissioned) { return -1; }
  12065. if (!is_valid()) { return -1; }
  12066. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12067. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12068. if (port == 0) {
  12069. struct sockaddr_storage addr;
  12070. socklen_t addr_len = sizeof(addr);
  12071. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12072. &addr_len) == -1) {
  12073. output_error_log(Error::GetSockName, nullptr);
  12074. return -1;
  12075. }
  12076. if (addr.ss_family == AF_INET) {
  12077. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12078. } else if (addr.ss_family == AF_INET6) {
  12079. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12080. } else {
  12081. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12082. return -1;
  12083. }
  12084. } else {
  12085. return port;
  12086. }
  12087. }
  12088. inline bool Server::listen_internal() {
  12089. // A stop() between bind and listen leaves nothing to accept on. Report
  12090. // failure instead of returning success without ever serving, and mark the
  12091. // server decommissioned the way any failed listen does so that a concurrent
  12092. // wait_until_ready() wakes up instead of spinning forever.
  12093. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12094. is_decommissioned = true;
  12095. return false;
  12096. }
  12097. auto ret = true;
  12098. is_running_ = true;
  12099. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12100. if (start_handler_) { start_handler_(); }
  12101. {
  12102. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12103. while (svr_sock_ != INVALID_SOCKET) {
  12104. #ifndef _WIN32
  12105. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12106. #endif
  12107. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12108. idle_interval_usec_);
  12109. if (val == 0) { // Timeout
  12110. task_queue->on_idle();
  12111. continue;
  12112. }
  12113. #ifndef _WIN32
  12114. }
  12115. #endif
  12116. #if defined _WIN32
  12117. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12118. // OVERLAPPED
  12119. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12120. #elif defined SOCK_CLOEXEC
  12121. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12122. #else
  12123. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12124. #endif
  12125. if (sock == INVALID_SOCKET) {
  12126. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12127. // touches the CRT errno, so the two have to be asked platform by
  12128. // platform rather than by testing errno here.
  12129. if (detail::is_accept_resource_error()) {
  12130. // The per-process descriptor limit or the network stack's buffer
  12131. // space has been reached. Try to accept new connections after a
  12132. // short sleep.
  12133. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12134. continue;
  12135. } else if (detail::is_accept_transient_error()) {
  12136. continue;
  12137. }
  12138. // Take the descriptor out of svr_sock_ before closing it: a later
  12139. // stop() would otherwise shutdown()/close() a value the OS may have
  12140. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12141. // gone. The exchange also settles the race with a concurrent stop(),
  12142. // since whichever side takes the descriptor closes it exactly once.
  12143. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12144. if (listen_sock != INVALID_SOCKET) {
  12145. detail::close_socket(listen_sock);
  12146. ret = false;
  12147. output_error_log(Error::Connection, nullptr);
  12148. } else {
  12149. ; // The server socket was closed by user.
  12150. }
  12151. break;
  12152. }
  12153. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12154. read_timeout_sec_, read_timeout_usec_);
  12155. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12156. write_timeout_sec_, write_timeout_usec_);
  12157. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12158. if (!task_queue->enqueue(
  12159. [this, sock]() { process_and_close_socket(sock); })) {
  12160. output_error_log(Error::ResourceExhaustion, nullptr);
  12161. detail::shutdown_socket(sock);
  12162. detail::close_socket(sock);
  12163. }
  12164. }
  12165. task_queue->shutdown();
  12166. }
  12167. is_decommissioned = !ret;
  12168. return ret;
  12169. }
  12170. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  12171. if (pre_routing_handler_ &&
  12172. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12173. return true;
  12174. }
  12175. // File handler
  12176. if ((req.method == "GET" || req.method == "HEAD") &&
  12177. handle_file_request(req, res)) {
  12178. return true;
  12179. }
  12180. const auto *custom = find_custom_entry(req.method);
  12181. // The second clause mirrors what expect_content() does unconditionally for
  12182. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12183. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12184. // `allprop`) would skip its handler and fall through to 404.
  12185. if (detail::expect_content(req) ||
  12186. (custom && !custom->handlers_for_content_reader.empty())) {
  12187. // Content reader handler
  12188. {
  12189. // Track whether the ContentReader was aborted due to the decompressed
  12190. // payload exceeding `payload_max_length_`.
  12191. // The user handler runs after the lambda returns, so we must restore the
  12192. // 413 status if the handler overwrites it.
  12193. bool content_reader_payload_too_large = false;
  12194. ContentReader reader(
  12195. [&](ContentReceiver receiver) {
  12196. auto result = read_content_with_content_receiver(
  12197. strm, req, res, std::move(receiver), nullptr, nullptr);
  12198. if (!result) {
  12199. output_error_log(Error::Read, &req);
  12200. if (res.status == StatusCode::PayloadTooLarge_413) {
  12201. content_reader_payload_too_large = true;
  12202. }
  12203. }
  12204. return result;
  12205. },
  12206. [&](FormDataHeader header, ContentReceiver receiver) {
  12207. auto result = read_content_with_content_receiver(
  12208. strm, req, res, nullptr, std::move(header),
  12209. std::move(receiver));
  12210. if (!result) {
  12211. output_error_log(Error::Read, &req);
  12212. if (res.status == StatusCode::PayloadTooLarge_413) {
  12213. content_reader_payload_too_large = true;
  12214. }
  12215. }
  12216. return result;
  12217. });
  12218. bool dispatched = false;
  12219. if (req.method == "POST") {
  12220. dispatched = dispatch_request_for_content_reader(
  12221. req, res, std::move(reader), post_handlers_for_content_reader_);
  12222. } else if (req.method == "PUT") {
  12223. dispatched = dispatch_request_for_content_reader(
  12224. req, res, std::move(reader), put_handlers_for_content_reader_);
  12225. } else if (req.method == "PATCH") {
  12226. dispatched = dispatch_request_for_content_reader(
  12227. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12228. } else if (req.method == "DELETE") {
  12229. dispatched = dispatch_request_for_content_reader(
  12230. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12231. } else if (custom) {
  12232. dispatched = dispatch_request_for_content_reader(
  12233. req, res, std::move(reader), custom->handlers_for_content_reader);
  12234. }
  12235. if (dispatched) {
  12236. if (content_reader_payload_too_large) {
  12237. // Enforce the limit: override any status the handler may have set
  12238. // and return false so the error path sends a plain 413 response.
  12239. res.status = StatusCode::PayloadTooLarge_413;
  12240. detail::clear_content(res);
  12241. return false;
  12242. }
  12243. return true;
  12244. }
  12245. }
  12246. // NOTE: `req.body` is not read here. For a regular handler the body is
  12247. // read inside dispatch_request(), after the route has matched and the
  12248. // pre-request handler has approved the request, so that a rejected
  12249. // request (e.g. failed authentication) never forces us to buffer a
  12250. // potentially large body.
  12251. }
  12252. // Regular handler
  12253. if (req.method == "GET" || req.method == "HEAD") {
  12254. return dispatch_request(req, res, get_handlers_, strm);
  12255. } else if (req.method == "POST") {
  12256. return dispatch_request(req, res, post_handlers_, strm);
  12257. } else if (req.method == "PUT") {
  12258. return dispatch_request(req, res, put_handlers_, strm);
  12259. } else if (req.method == "DELETE") {
  12260. return dispatch_request(req, res, delete_handlers_, strm);
  12261. } else if (req.method == "OPTIONS") {
  12262. return dispatch_request(req, res, options_handlers_, strm);
  12263. } else if (req.method == "PATCH") {
  12264. return dispatch_request(req, res, patch_handlers_, strm);
  12265. } else if (custom) {
  12266. return dispatch_request(req, res, custom->handlers, strm);
  12267. }
  12268. res.status = StatusCode::BadRequest_400;
  12269. return false;
  12270. }
  12271. inline bool Server::dispatch_request(Request &req, Response &res,
  12272. const Handlers &handlers, Stream &strm) {
  12273. for (const auto &x : handlers) {
  12274. const auto &matcher = x.first;
  12275. const auto &handler = x.second;
  12276. if (matcher->match(req)) {
  12277. req.matched_route = matcher->pattern();
  12278. // Run the pre-request handler before reading the body so a rejected
  12279. // request (e.g. failed authentication) never forces us to buffer a
  12280. // potentially large body. `req.matched_route` is available here.
  12281. if (pre_request_handler_ &&
  12282. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12283. return true;
  12284. }
  12285. // The route matched and the request was approved; read the body now.
  12286. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12287. output_error_log(Error::Read, &req);
  12288. return false;
  12289. }
  12290. handler(req, res);
  12291. return true;
  12292. }
  12293. }
  12294. return false;
  12295. }
  12296. // Decides the content coding for a response served straight from a file. Both
  12297. // the ETag, which has to name the representation actually sent, and
  12298. // `apply_static_file_compression()` go through this, so the two cannot drift
  12299. // apart.
  12300. inline detail::EncodingType
  12301. Server::static_file_encoding(const Request &req, const Response &res,
  12302. const std::string &content_type,
  12303. size_t length) const {
  12304. if (!static_file_compression_) { return detail::EncodingType::None; }
  12305. // Nothing to compress, and an empty file already answers with
  12306. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12307. // turn an empty body into a 20-byte gzip stream.
  12308. if (length == 0) { return detail::EncodingType::None; }
  12309. // A file that already fits in a single packet gains nothing from being made
  12310. // smaller, since it still travels in that one segment, and a file of a few
  12311. // bytes comes out larger than it went in.
  12312. if (length < static_file_compression_min_length_) {
  12313. return detail::EncodingType::None;
  12314. }
  12315. // RFC 9110 applies Range to the representation after content coding, so a
  12316. // compressed 206 would mean compressing the whole file and then slicing it.
  12317. // Serve ranges from the identity representation instead.
  12318. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12319. if (static_file_compression_max_length_ > 0 &&
  12320. length > static_file_compression_max_length_) {
  12321. return detail::EncodingType::None;
  12322. }
  12323. return detail::encoding_type(req, res, content_type);
  12324. }
  12325. // Compresses a file-backed content provider into `res.body` and takes over the
  12326. // framing headers. Returns false when the response is left untouched.
  12327. inline bool Server::apply_static_file_compression(const Request &req,
  12328. Response &res) const {
  12329. auto type = res.content_coding_;
  12330. if (type == detail::EncodingType::None || !res.content_provider_) {
  12331. return false;
  12332. }
  12333. auto compressor = detail::make_compressor(type);
  12334. if (!compressor) { return false; }
  12335. output_pre_compression_log(req, res);
  12336. std::string compressed;
  12337. if (!detail::compress_content_provider(res.content_provider_,
  12338. res.content_length_, *compressor,
  12339. compressed)) {
  12340. return false;
  12341. }
  12342. res.body.swap(compressed);
  12343. // The provider was consumed in full, so its releaser hears about a success.
  12344. res.content_provider_success_ = true;
  12345. detail::clear_content_provider(res);
  12346. res.set_header("Content-Encoding", detail::encoding_name(type));
  12347. res.set_header("Vary", "Accept-Encoding");
  12348. res.set_header("Content-Length", std::to_string(res.body.size()));
  12349. return true;
  12350. }
  12351. inline void Server::apply_ranges(const Request &req, Response &res,
  12352. std::string &content_type,
  12353. std::string &boundary) const {
  12354. // A known-length content provider leaves `res.body` empty, so the compressor
  12355. // at the end of this function never runs for one (issue #2545). A file-backed
  12356. // provider is fully readable right here, so compress it and answer with an
  12357. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12358. // takes the same path as `set_content()` from here on. Range requests never
  12359. // get a content coding, so `Content-Range` still names identity bytes and
  12360. // none of the framing below applies.
  12361. if (apply_static_file_compression(req, res)) { return; }
  12362. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12363. auto it = res.headers.find("Content-Type");
  12364. if (it != res.headers.end()) {
  12365. content_type = it->second;
  12366. res.headers.erase(it);
  12367. }
  12368. boundary = detail::make_multipart_data_boundary();
  12369. res.set_header("Content-Type",
  12370. "multipart/byteranges; boundary=" + boundary);
  12371. }
  12372. auto type = detail::encoding_type(req, res);
  12373. if (res.body.empty()) {
  12374. if (res.content_length_ > 0) {
  12375. size_t length = 0;
  12376. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12377. length = res.content_length_;
  12378. } else if (req.ranges.size() == 1) {
  12379. auto offset_and_length = detail::get_range_offset_and_length(
  12380. req.ranges[0], res.content_length_);
  12381. length = offset_and_length.second;
  12382. auto content_range = detail::make_content_range_header_field(
  12383. offset_and_length, res.content_length_);
  12384. res.set_header("Content-Range", content_range);
  12385. } else {
  12386. length = detail::get_multipart_ranges_data_length(
  12387. req, boundary, content_type, res.content_length_);
  12388. }
  12389. res.set_header("Content-Length", std::to_string(length));
  12390. } else {
  12391. if (res.content_provider_) {
  12392. if (res.is_chunked_content_provider_) {
  12393. res.set_header("Transfer-Encoding", "chunked");
  12394. res.content_coding_ = type;
  12395. if (type != detail::EncodingType::None) {
  12396. res.set_header("Content-Encoding", detail::encoding_name(type));
  12397. res.set_header("Vary", "Accept-Encoding");
  12398. }
  12399. }
  12400. }
  12401. }
  12402. } else {
  12403. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12404. ;
  12405. } else if (req.ranges.size() == 1) {
  12406. auto offset_and_length =
  12407. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12408. auto offset = offset_and_length.first;
  12409. auto length = offset_and_length.second;
  12410. auto content_range = detail::make_content_range_header_field(
  12411. offset_and_length, res.body.size());
  12412. res.set_header("Content-Range", content_range);
  12413. assert(offset + length <= res.body.size());
  12414. res.body = res.body.substr(offset, length);
  12415. } else {
  12416. std::string data;
  12417. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12418. res.body.size(), data);
  12419. res.body.swap(data);
  12420. }
  12421. if (type != detail::EncodingType::None) {
  12422. output_pre_compression_log(req, res);
  12423. if (auto compressor = detail::make_compressor(type)) {
  12424. std::string compressed;
  12425. if (compressor->compress(res.body.data(), res.body.size(), true,
  12426. [&](const char *data, size_t data_len) {
  12427. compressed.append(data, data_len);
  12428. return true;
  12429. })) {
  12430. res.body.swap(compressed);
  12431. res.set_header("Content-Encoding", detail::encoding_name(type));
  12432. res.set_header("Vary", "Accept-Encoding");
  12433. }
  12434. }
  12435. }
  12436. res.content_length_ = res.body.size();
  12437. res.set_header("Content-Length", std::to_string(res.content_length_));
  12438. }
  12439. }
  12440. inline bool Server::dispatch_request_for_content_reader(
  12441. Request &req, Response &res, ContentReader content_reader,
  12442. const HandlersForContentReader &handlers) const {
  12443. for (const auto &x : handlers) {
  12444. const auto &matcher = x.first;
  12445. const auto &handler = x.second;
  12446. if (matcher->match(req)) {
  12447. req.matched_route = matcher->pattern();
  12448. if (!pre_request_handler_ ||
  12449. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12450. handler(req, res, content_reader);
  12451. }
  12452. return true;
  12453. }
  12454. }
  12455. return false;
  12456. }
  12457. inline std::string
  12458. get_client_ip(const std::string &x_forwarded_for,
  12459. const std::vector<std::string> &trusted_proxies) {
  12460. // X-Forwarded-For is a comma-separated list per RFC 7239
  12461. std::vector<std::string> ip_list;
  12462. detail::split(x_forwarded_for.data(),
  12463. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12464. [&](const char *b, const char *e) {
  12465. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12466. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12467. });
  12468. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12469. // no segments. Signal "no client IP derived" with an empty string so the
  12470. // caller can fall back to the connection-level remote address.
  12471. if (ip_list.empty()) { return std::string(); }
  12472. // Each hop appends the address it received the request from, so the rightmost
  12473. // entries are the ones written by our own infrastructure while the leftmost
  12474. // are whatever the original client chose to send. Walk from the right and
  12475. // skip trusted proxies; the first address that is not a trusted proxy is the
  12476. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12477. // from the left instead lets a client forge an arbitrary address by following
  12478. // it with a trusted proxy's address, which the left-to-right scan then
  12479. // returned as the client.
  12480. for (size_t i = ip_list.size(); i-- > 0;) {
  12481. const auto &ip = ip_list[i];
  12482. auto is_trusted_proxy =
  12483. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12484. [&](const std::string &proxy) { return ip == proxy; });
  12485. if (!is_trusted_proxy) { return ip; }
  12486. }
  12487. // Every hop was a trusted proxy; fall back to the first entry.
  12488. return ip_list.front();
  12489. }
  12490. inline bool
  12491. Server::process_request(Stream &strm, const std::string &remote_addr,
  12492. int remote_port, const std::string &local_addr,
  12493. int local_port, bool close_connection,
  12494. bool &connection_closed,
  12495. const std::function<void(Request &)> &setup_request,
  12496. bool *websocket_upgraded) {
  12497. std::array<char, 2048> buf{};
  12498. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12499. // Connection has been closed on client
  12500. if (!line_reader.getline()) { return false; }
  12501. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12502. // clients send an extra CRLF after a request body, which would otherwise be
  12503. // parsed as the next request on a persistent connection.
  12504. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12505. return false;
  12506. }
  12507. Request req;
  12508. req.start_time_ = std::chrono::steady_clock::now();
  12509. req.remote_addr = remote_addr;
  12510. req.remote_port = remote_port;
  12511. req.local_addr = local_addr;
  12512. req.local_port = local_port;
  12513. Response res;
  12514. res.version = "HTTP/1.1";
  12515. res.headers = default_headers_;
  12516. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12517. // close the connection after that response, whichever path wrote it (an
  12518. // error status, a handler, or a rejected request). Reading on would also
  12519. // parse whatever the client sent next on a connection it considers done.
  12520. auto honor_connection_close = detail::scope_exit([&] {
  12521. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12522. connection_closed = true;
  12523. }
  12524. });
  12525. // Request line and headers. A rejected message leaves the rest of it (and
  12526. // any body) unread, so the connection cannot be reused: the leftover bytes
  12527. // would be parsed as the next request.
  12528. if (!parse_request_line(line_reader.ptr(), req)) {
  12529. connection_closed = true;
  12530. res.status = StatusCode::BadRequest_400;
  12531. output_error_log(Error::InvalidRequestLine, &req);
  12532. return write_response(strm, close_connection, req, res);
  12533. }
  12534. // Request headers
  12535. if (!detail::read_headers(strm, req.headers)) {
  12536. connection_closed = true;
  12537. res.status = StatusCode::BadRequest_400;
  12538. output_error_log(Error::InvalidHeaders, &req);
  12539. return write_response(strm, close_connection, req, res);
  12540. }
  12541. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12542. // which would otherwise let an intermediary and this parser disagree on
  12543. // where the body ends and enable request smuggling. Three cases: a
  12544. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12545. // or empty), which would otherwise be read as "no body"; a non-zero
  12546. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12547. // tolerated for compatibility with existing clients); and a
  12548. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12549. // length undeterminable. None of them may fall through to the "no body"
  12550. // path, or the body bytes are parsed as the next request on a persistent
  12551. // connection.
  12552. auto is_invalid_content_length = false;
  12553. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12554. is_invalid_content_length);
  12555. if (is_invalid_content_length ||
  12556. detail::has_conflicting_content_length(req.headers) ||
  12557. (req.has_header("Transfer-Encoding") &&
  12558. !detail::is_chunked_transfer_encoding(req.headers))) {
  12559. connection_closed = true;
  12560. res.status = StatusCode::BadRequest_400;
  12561. return write_response(strm, close_connection, req, res);
  12562. }
  12563. // RFC 9112 §6.1: answer a request that also has a Content-Length, or an
  12564. // HTTP/1.0 one, by its Transfer-Encoding, but close the connection after.
  12565. if (req.has_header("Transfer-Encoding") &&
  12566. (req.has_header("Content-Length") || req.version == "HTTP/1.0")) {
  12567. connection_closed = true;
  12568. }
  12569. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12570. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12571. // the same authority.
  12572. if (req.get_header_value_count("Host") > 1 ||
  12573. !detail::fields::is_host(req.get_header_value("Host")) ||
  12574. (req.version == "HTTP/1.1" && !req.has_header("Host"))) {
  12575. connection_closed = true;
  12576. res.status = StatusCode::BadRequest_400;
  12577. output_error_log(Error::InvalidHeaders, &req);
  12578. return write_response(strm, close_connection, req, res);
  12579. }
  12580. // Check if the request URI doesn't exceed the limit
  12581. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12582. connection_closed = true;
  12583. res.status = StatusCode::UriTooLong_414;
  12584. output_error_log(Error::ExceedUriMaxLength, &req);
  12585. return write_response(strm, close_connection, req, res);
  12586. }
  12587. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12588. connection_closed = true;
  12589. }
  12590. if (req.version == "HTTP/1.0" &&
  12591. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12592. connection_closed = true;
  12593. }
  12594. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12595. // itself a trusted proxy. Otherwise any direct client could spoof
  12596. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12597. auto is_trusted_peer = std::any_of(
  12598. trusted_proxies_.begin(), trusted_proxies_.end(),
  12599. [&](const std::string &proxy) { return proxy == remote_addr; });
  12600. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12601. // Some proxies append the address they observed as a separate
  12602. // X-Forwarded-For field line instead of extending the one the client sent
  12603. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12604. // be scanned. Reading only the first occurrence would hand back the
  12605. // client-supplied, and therefore forgeable, value.
  12606. auto x_forwarded_for =
  12607. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12608. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12609. req.remote_addr = derived.empty() ? remote_addr : derived;
  12610. } else {
  12611. req.remote_addr = remote_addr;
  12612. }
  12613. req.remote_port = remote_port;
  12614. req.local_addr = local_addr;
  12615. req.local_port = local_port;
  12616. if (req.has_header("Accept")) {
  12617. auto accept_header =
  12618. detail::get_combined_header_value(req.headers, "Accept");
  12619. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12620. connection_closed = true;
  12621. res.status = StatusCode::BadRequest_400;
  12622. output_error_log(Error::HTTPParsing, &req);
  12623. return write_response(strm, close_connection, req, res);
  12624. }
  12625. }
  12626. if (req.has_header("Range")) {
  12627. const auto &range_header_value = req.get_header_value("Range");
  12628. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12629. connection_closed = true;
  12630. res.status = StatusCode::RangeNotSatisfiable_416;
  12631. output_error_log(Error::InvalidRangeHeader, &req);
  12632. return write_response(strm, close_connection, req, res);
  12633. }
  12634. }
  12635. if (setup_request) { setup_request(req); }
  12636. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12637. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12638. // must be ignored. An expectation we do not recognize is left alone; the
  12639. // 417 the section allows for one is a MAY, not a requirement.
  12640. //
  12641. // `100 Continue` itself is deferred until the body is actually read (see
  12642. // read_content_core), so a request rejected by a later handler never
  12643. // invites the client to send a body nobody will read.
  12644. if (req.version != "HTTP/1.0" &&
  12645. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12646. int status = StatusCode::Continue_100;
  12647. if (expect_100_continue_handler_) {
  12648. status = expect_100_continue_handler_(req, res);
  12649. }
  12650. if (status == StatusCode::Continue_100) {
  12651. req.expect_100_continue_pending_ = true;
  12652. } else {
  12653. if (res.status == -1) { res.status = status; }
  12654. connection_closed = true;
  12655. return write_response(strm, true, req, res);
  12656. }
  12657. }
  12658. // Setup `is_connection_closed` method
  12659. auto sock = strm.socket();
  12660. req.is_connection_closed = [sock]() {
  12661. return !detail::is_socket_alive(sock);
  12662. };
  12663. // WebSocket upgrade
  12664. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12665. // that authentication and other middleware can reject the request with an
  12666. // HTTP response (e.g., 401) before the protocol switches.
  12667. if (detail::is_websocket_upgrade(req)) {
  12668. if (pre_routing_handler_ &&
  12669. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12670. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12671. return write_response_with_content(strm, close_connection, req, res);
  12672. }
  12673. // Find matching WebSocket handler
  12674. for (const auto &entry : websocket_handlers_) {
  12675. if (entry.matcher->match(req)) {
  12676. req.matched_route = entry.matcher->pattern();
  12677. if (pre_request_handler_ &&
  12678. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12679. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12680. return write_response_with_content(strm, close_connection, req, res);
  12681. }
  12682. // Compute accept key
  12683. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12684. auto accept_key = detail::websocket_accept_key(client_key);
  12685. // Negotiate subprotocol
  12686. std::string selected_subprotocol;
  12687. if (entry.sub_protocol_selector) {
  12688. auto protocol_header = detail::get_combined_header_value(
  12689. req.headers, "Sec-WebSocket-Protocol");
  12690. if (!protocol_header.empty()) {
  12691. std::vector<std::string> protocols;
  12692. detail::split(protocol_header.data(),
  12693. protocol_header.data() + protocol_header.size(), ',',
  12694. [&](const char *b, const char *e) {
  12695. protocols.emplace_back(b, e);
  12696. });
  12697. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12698. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12699. if (std::find(protocols.begin(), protocols.end(),
  12700. selected_subprotocol) == protocols.end()) {
  12701. selected_subprotocol.clear();
  12702. }
  12703. }
  12704. }
  12705. // Send 101 Switching Protocols
  12706. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12707. "Upgrade: websocket\r\n"
  12708. "Connection: Upgrade\r\n"
  12709. "Sec-WebSocket-Accept: " +
  12710. accept_key + "\r\n";
  12711. if (!selected_subprotocol.empty()) {
  12712. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12713. return false;
  12714. }
  12715. handshake_response +=
  12716. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12717. }
  12718. handshake_response += "\r\n";
  12719. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12720. 0) {
  12721. return false;
  12722. }
  12723. connection_closed = true;
  12724. if (websocket_upgraded) { *websocket_upgraded = true; }
  12725. {
  12726. #ifdef CPPHTTPLIB_SSL_ENABLED
  12727. if (req.ssl) {
  12728. // wss: the heartbeat ping thread and the read path enter the same
  12729. // TLS session from different threads. Hand the WebSocket a stream
  12730. // that serializes every TLS call, so the shared SSLSocketStream on
  12731. // the plain HTTP/HTTPS paths stays untouched.
  12732. auto ws_strm =
  12733. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12734. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12735. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12736. write_timeout_sec_, write_timeout_usec_));
  12737. ws::WebSocket ws(std::move(ws_strm), req, true,
  12738. websocket_ping_interval_sec_,
  12739. websocket_max_missed_pongs_);
  12740. entry.handler(req, ws);
  12741. return true;
  12742. }
  12743. #endif
  12744. // Use WebSocket-specific read timeout instead of HTTP timeout
  12745. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12746. 0);
  12747. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12748. websocket_max_missed_pongs_);
  12749. entry.handler(req, ws);
  12750. }
  12751. return true;
  12752. }
  12753. }
  12754. // No matching handler - fall through to 404
  12755. }
  12756. // Routing
  12757. auto routed = false;
  12758. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12759. routed = routing(req, res, strm);
  12760. #else
  12761. try {
  12762. routed = routing(req, res, strm);
  12763. } catch (std::exception &) {
  12764. if (exception_handler_) {
  12765. auto ep = std::current_exception();
  12766. exception_handler_(req, res, ep);
  12767. routed = true;
  12768. } else {
  12769. res.status = StatusCode::InternalServerError_500;
  12770. }
  12771. } catch (...) {
  12772. if (exception_handler_) {
  12773. auto ep = std::current_exception();
  12774. exception_handler_(req, res, ep);
  12775. routed = true;
  12776. } else {
  12777. res.status = StatusCode::InternalServerError_500;
  12778. }
  12779. }
  12780. #endif
  12781. // The response says so when this connection closes after it.
  12782. auto close = close_connection || connection_closed;
  12783. auto ret = false;
  12784. if (routed) {
  12785. if (res.status == -1) {
  12786. res.status = req.ranges.empty() ? StatusCode::OK_200
  12787. : StatusCode::PartialContent_206;
  12788. }
  12789. // Before the Range checks below, so they see the body's own length.
  12790. detail::prefer_assigned_body(res);
  12791. // Serve file content by using a content provider
  12792. auto file_open_error = false;
  12793. if (!res.file_content_path_.empty()) {
  12794. const auto &path = res.file_content_path_;
  12795. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12796. if (!mm->is_open()) {
  12797. res.status = StatusCode::NotFound_404;
  12798. output_error_log(Error::OpenFile, &req);
  12799. file_open_error = true;
  12800. } else {
  12801. auto content_type = res.file_content_content_type_;
  12802. if (content_type.empty()) {
  12803. content_type = detail::find_content_type(
  12804. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12805. }
  12806. detail::set_file_content_provider(
  12807. res, mm, content_type,
  12808. static_file_encoding(req, res, content_type, mm->size()));
  12809. }
  12810. }
  12811. if (file_open_error) {
  12812. ret = write_response(strm, close, req, res);
  12813. } else if (detail::range_error(req, res)) {
  12814. detail::clear_content(res);
  12815. res.status = StatusCode::RangeNotSatisfiable_416;
  12816. ret = write_response(strm, close, req, res);
  12817. } else {
  12818. ret = write_response_with_content(strm, close, req, res);
  12819. }
  12820. } else {
  12821. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12822. ret = write_response(strm, close, req, res);
  12823. }
  12824. // Drain any unconsumed framed body to prevent request smuggling on
  12825. // keep-alive. Without framing there is no body to drain — reading would
  12826. // consume the next request (issue #2450). If the response has committed the
  12827. // connection to close, there is no next request to protect. A body read in
  12828. // part cannot be drained from where it stopped, so the connection closes.
  12829. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12830. !detail::has_header_token(res.headers, "Connection", "close")) {
  12831. int dummy_status;
  12832. if (req.body_read_started_ ||
  12833. !detail::read_content(
  12834. strm, req, payload_max_length_, dummy_status, nullptr,
  12835. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12836. connection_closed = true;
  12837. }
  12838. }
  12839. return ret;
  12840. }
  12841. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12842. inline bool Server::process_and_close_socket(socket_t sock) {
  12843. std::string remote_addr;
  12844. int remote_port = 0;
  12845. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12846. std::string local_addr;
  12847. int local_port = 0;
  12848. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12849. bool websocket_upgraded = false;
  12850. auto ret = serve_guarded([&]() {
  12851. return detail::process_server_socket(
  12852. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12853. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12854. write_timeout_usec_,
  12855. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12856. return process_request(strm, remote_addr, remote_port, local_addr,
  12857. local_port, close_connection,
  12858. connection_closed, nullptr,
  12859. &websocket_upgraded);
  12860. });
  12861. });
  12862. detail::drain_and_close_socket(sock);
  12863. return ret;
  12864. }
  12865. inline void Server::output_log(const Request &req, const Response &res) const {
  12866. if (logger_) {
  12867. std::lock_guard<std::mutex> guard(logger_mutex_);
  12868. logger_(req, res);
  12869. }
  12870. }
  12871. inline void Server::output_pre_compression_log(const Request &req,
  12872. const Response &res) const {
  12873. if (pre_compression_logger_) {
  12874. std::lock_guard<std::mutex> guard(logger_mutex_);
  12875. pre_compression_logger_(req, res);
  12876. }
  12877. }
  12878. inline void Server::output_error_log(const Error &err,
  12879. const Request *req) const {
  12880. if (error_logger_) {
  12881. std::lock_guard<std::mutex> guard(logger_mutex_);
  12882. error_logger_(err, req);
  12883. }
  12884. }
  12885. /*
  12886. * Group 5: ClientImpl and Client (Universal) implementation
  12887. */
  12888. // HTTP client implementation
  12889. inline ClientImpl::ClientImpl(const std::string &host)
  12890. : ClientImpl(host, 80, std::string(), std::string()) {}
  12891. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12892. : ClientImpl(host, port, std::string(), std::string()) {}
  12893. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12894. const std::string &client_cert_path,
  12895. const std::string &client_key_path)
  12896. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12897. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12898. inline ClientImpl::~ClientImpl() {
  12899. // Wait until all the requests in flight are handled.
  12900. size_t retry_count = 10;
  12901. while (retry_count-- > 0) {
  12902. {
  12903. std::lock_guard<std::mutex> guard(socket_mutex_);
  12904. if (socket_requests_in_flight_ == 0) { break; }
  12905. }
  12906. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12907. }
  12908. std::lock_guard<std::mutex> guard(socket_mutex_);
  12909. shutdown_socket(socket_);
  12910. close_socket(socket_);
  12911. }
  12912. inline bool ClientImpl::is_valid() const { return true; }
  12913. inline bool
  12914. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12915. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12916. if (no_proxy_entries_.empty()) { return true; }
  12917. // host_ is const so its normalized form is invariant; cache it. The
  12918. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12919. if (host == host_) {
  12920. if (!host_normalized_valid_) {
  12921. host_normalized_ = detail::normalize_target(host_);
  12922. host_normalized_valid_ = true;
  12923. }
  12924. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12925. }
  12926. auto target = detail::normalize_target(host);
  12927. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12928. }
  12929. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12930. if (is_proxy_enabled_for_host(host_)) {
  12931. return detail::create_client_socket(
  12932. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12933. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12934. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12935. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12936. }
  12937. // Check is custom IP or hostname specified for host_
  12938. std::string connect_host;
  12939. std::string ip;
  12940. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12941. return detail::create_client_socket(
  12942. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12943. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12944. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12945. write_timeout_usec_, interface_, error);
  12946. }
  12947. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12948. Error &error) {
  12949. auto sock = create_client_socket(error);
  12950. if (sock == INVALID_SOCKET) { return false; }
  12951. socket.sock = sock;
  12952. return true;
  12953. }
  12954. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12955. return create_and_connect_socket(socket, error);
  12956. }
  12957. inline bool ClientImpl::setup_proxy_connection(
  12958. Socket & /*socket*/,
  12959. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12960. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12961. return true;
  12962. }
  12963. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12964. bool /*shutdown_gracefully*/) {
  12965. // If there are any requests in flight from threads other than us, then it's
  12966. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12967. assert(socket_requests_in_flight_ == 0 ||
  12968. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12969. }
  12970. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12971. if (socket.sock == INVALID_SOCKET) { return; }
  12972. detail::shutdown_socket(socket.sock);
  12973. }
  12974. inline void ClientImpl::close_socket(Socket &socket) {
  12975. // If there are requests in flight in another thread, usually closing
  12976. // the socket will be fine and they will simply receive an error when
  12977. // using the closed socket, but it is still a bug since rarely the OS
  12978. // may reassign the socket id to be used for a new socket, and then
  12979. // suddenly they will be operating on a live socket that is different
  12980. // than the one they intended!
  12981. assert(socket_requests_in_flight_ == 0 ||
  12982. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12983. // It is also a bug if this happens while SSL is still active
  12984. #ifdef CPPHTTPLIB_SSL_ENABLED
  12985. assert(socket.ssl == nullptr);
  12986. #endif
  12987. if (socket.sock == INVALID_SOCKET) { return; }
  12988. detail::close_socket(socket.sock);
  12989. socket.sock = INVALID_SOCKET;
  12990. }
  12991. inline void ClientImpl::disconnect(bool gracefully) {
  12992. shutdown_ssl(socket_, gracefully);
  12993. shutdown_socket(socket_);
  12994. close_socket(socket_);
  12995. }
  12996. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12997. Response &res,
  12998. bool skip_100_continue) const {
  12999. std::array<char, 2048> buf{};
  13000. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13001. if (!line_reader.getline()) { return false; }
  13002. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13003. res.reason)) {
  13004. return req.method == "CONNECT";
  13005. }
  13006. // Skip interim responses, such as 100 Continue (unless Expect:
  13007. // 100-continue is handled by the caller) and 103 Early Hints, along with
  13008. // their header fields. 101 ends HTTP on the connection, so it is final.
  13009. while (skip_100_continue && 100 <= res.status && res.status < 200 &&
  13010. res.status != StatusCode::SwitchingProtocol_101) {
  13011. Headers interim_headers;
  13012. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13013. if (!line_reader.getline()) { return false; } // next response line
  13014. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13015. res.reason)) {
  13016. return false;
  13017. }
  13018. }
  13019. return true;
  13020. }
  13021. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13022. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13023. auto ret = send_(req, res, error);
  13024. if (error == Error::SSLPeerCouldBeClosed_) {
  13025. assert(!ret);
  13026. ret = send_(req, res, error);
  13027. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13028. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13029. }
  13030. return ret;
  13031. }
  13032. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13033. {
  13034. std::lock_guard<std::mutex> guard(socket_mutex_);
  13035. // Set this to false immediately - if it ever gets set to true by the end
  13036. // of the request, we know another thread instructed us to close the
  13037. // socket.
  13038. socket_should_be_closed_when_request_is_done_ = false;
  13039. auto is_alive = false;
  13040. if (socket_.is_open()) {
  13041. is_alive = detail::is_socket_alive(socket_.sock);
  13042. #ifdef CPPHTTPLIB_SSL_ENABLED
  13043. if (is_alive && is_ssl()) {
  13044. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13045. is_alive = false;
  13046. }
  13047. }
  13048. #endif
  13049. if (!is_alive) {
  13050. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13051. disconnect(/*gracefully=*/false);
  13052. }
  13053. }
  13054. if (!is_alive) {
  13055. if (!ensure_socket_connection(socket_, error)) {
  13056. output_error_log(error, &req);
  13057. return false;
  13058. }
  13059. {
  13060. auto success = true;
  13061. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13062. error)) {
  13063. if (!success) { output_error_log(error, &req); }
  13064. return success;
  13065. }
  13066. }
  13067. }
  13068. // Mark the current socket as being in use so that it cannot be closed by
  13069. // anyone else while this request is ongoing, even though we will be
  13070. // releasing the mutex.
  13071. if (socket_requests_in_flight_ > 1) {
  13072. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13073. }
  13074. socket_requests_in_flight_ += 1;
  13075. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13076. }
  13077. for (const auto &header : default_headers_) {
  13078. if (req.headers.find(header.first) == req.headers.end()) {
  13079. req.headers.insert(header);
  13080. }
  13081. }
  13082. auto ret = false;
  13083. auto close_connection = !keep_alive_;
  13084. auto se = detail::scope_exit([&]() {
  13085. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13086. std::lock_guard<std::mutex> guard(socket_mutex_);
  13087. socket_requests_in_flight_ -= 1;
  13088. if (socket_requests_in_flight_ <= 0) {
  13089. assert(socket_requests_in_flight_ == 0);
  13090. socket_requests_are_from_thread_ = std::thread::id();
  13091. }
  13092. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13093. !ret) {
  13094. disconnect(/*gracefully=*/true);
  13095. }
  13096. });
  13097. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13098. return handle_request(strm, req, res, close_connection, error);
  13099. });
  13100. if (!ret) {
  13101. if (error == Error::Success) {
  13102. error = Error::Unknown;
  13103. output_error_log(error, &req);
  13104. }
  13105. }
  13106. return ret;
  13107. }
  13108. inline Result ClientImpl::send(const Request &req) {
  13109. auto req2 = req;
  13110. return send_(std::move(req2));
  13111. }
  13112. inline Result ClientImpl::send_(Request &&req) {
  13113. auto res = detail::make_unique<Response>();
  13114. auto error = Error::Success;
  13115. auto ret = send(req, *res, error);
  13116. #ifdef CPPHTTPLIB_SSL_ENABLED
  13117. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13118. last_ssl_error_, last_backend_error_};
  13119. #else
  13120. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13121. #endif
  13122. }
  13123. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13124. const std::string &ct) {
  13125. (void)for_stream;
  13126. // Default headers are meant for the origin and may carry its credentials, so
  13127. // keep them off the CONNECT request the proxy reads.
  13128. if (r.method != "CONNECT") {
  13129. for (const auto &header : default_headers_) {
  13130. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13131. }
  13132. }
  13133. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13134. // prepend it rather than appending it after the caller's own fields.
  13135. if (!r.has_header("Host")) {
  13136. r.headers.emplace_front(
  13137. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13138. address_family_));
  13139. }
  13140. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13141. if (!r.content_receiver) {
  13142. if (!r.has_header("Accept-Encoding")) {
  13143. std::string accept_encoding;
  13144. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13145. accept_encoding = "br";
  13146. #endif
  13147. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13148. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13149. accept_encoding += "gzip, deflate";
  13150. #endif
  13151. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13152. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13153. accept_encoding += "zstd";
  13154. #endif
  13155. r.set_header("Accept-Encoding", accept_encoding);
  13156. }
  13157. detail::add_default_user_agent_header(r);
  13158. }
  13159. if (!r.body.empty()) {
  13160. if (!ct.empty() && !r.has_header("Content-Type")) {
  13161. r.headers.emplace("Content-Type", ct);
  13162. }
  13163. if (!r.has_header("Content-Length")) {
  13164. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13165. }
  13166. }
  13167. }
  13168. inline ClientImpl::StreamHandle
  13169. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13170. const Params &params, const Headers &headers,
  13171. const std::string &body,
  13172. const std::string &content_type) {
  13173. StreamHandle handle;
  13174. handle.response = detail::make_unique<Response>();
  13175. handle.error = Error::Success;
  13176. // Encode the target exactly like the buffered send path does, so that the
  13177. // same `path` produces the same request line through either API.
  13178. auto raw_query_path =
  13179. params.empty() ? path : append_query_params(path, params);
  13180. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13181. handle.connection_ = detail::make_unique<ClientConnection>();
  13182. {
  13183. std::lock_guard<std::mutex> guard(socket_mutex_);
  13184. auto is_alive = false;
  13185. if (socket_.is_open()) {
  13186. is_alive = detail::is_socket_alive(socket_.sock);
  13187. #ifdef CPPHTTPLIB_SSL_ENABLED
  13188. if (is_alive && is_ssl()) {
  13189. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13190. is_alive = false;
  13191. }
  13192. }
  13193. #endif
  13194. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13195. }
  13196. if (!is_alive) {
  13197. if (!ensure_socket_connection(socket_, handle.error)) {
  13198. handle.response.reset();
  13199. return handle;
  13200. }
  13201. {
  13202. auto success = true;
  13203. auto start_time = std::chrono::steady_clock::now();
  13204. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13205. success, handle.error)) {
  13206. if (!success) { handle.response.reset(); }
  13207. return handle;
  13208. }
  13209. }
  13210. }
  13211. transfer_socket_ownership_to_handle(handle);
  13212. }
  13213. #ifdef CPPHTTPLIB_SSL_ENABLED
  13214. if (is_ssl() && handle.connection_->session) {
  13215. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13216. handle.connection_->sock, handle.connection_->session,
  13217. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13218. write_timeout_usec_);
  13219. } else {
  13220. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13221. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13222. write_timeout_sec_, write_timeout_usec_);
  13223. }
  13224. #else
  13225. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13226. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13227. write_timeout_sec_, write_timeout_usec_);
  13228. #endif
  13229. handle.stream_ = handle.socket_stream_.get();
  13230. Request req;
  13231. req.method = method;
  13232. req.path = query_path;
  13233. req.headers = headers;
  13234. req.body = body;
  13235. prepare_default_headers(req, true, content_type);
  13236. auto &strm = *handle.stream_;
  13237. // Build the request line and headers in memory first, like write_request()
  13238. // does, so that a rejected header leaves nothing on the wire.
  13239. {
  13240. detail::BufferStream bstrm;
  13241. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13242. handle.error = Error::Write;
  13243. handle.response.reset();
  13244. return handle;
  13245. }
  13246. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13247. handle.error)) {
  13248. handle.response.reset();
  13249. return handle;
  13250. }
  13251. const auto &data = bstrm.get_buffer();
  13252. if (!detail::write_data(strm, data.data(), data.size())) {
  13253. handle.error = Error::Write;
  13254. handle.response.reset();
  13255. return handle;
  13256. }
  13257. }
  13258. if (!body.empty()) {
  13259. if (strm.write(body.data(), body.size()) < 0) {
  13260. handle.error = Error::Write;
  13261. handle.response.reset();
  13262. return handle;
  13263. }
  13264. }
  13265. if (!read_response_line(strm, req, *handle.response) ||
  13266. !detail::read_headers(strm, handle.response->headers)) {
  13267. handle.error = Error::Read;
  13268. handle.response.reset();
  13269. return handle;
  13270. }
  13271. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13272. // (204/304) response legitimately carries framing headers with no body.
  13273. if (method != "HEAD" &&
  13274. handle.response->status != StatusCode::NoContent_204 &&
  13275. handle.response->status != StatusCode::NotModified_304 &&
  13276. detail::has_conflicting_content_length(handle.response->headers)) {
  13277. handle.error = Error::Read;
  13278. handle.response.reset();
  13279. return handle;
  13280. }
  13281. handle.body_reader_.stream = handle.stream_;
  13282. handle.body_reader_.payload_max_length = payload_max_length_;
  13283. if (handle.response->has_header("Content-Length")) {
  13284. bool is_invalid = false;
  13285. auto content_length = detail::get_header_value_u64(
  13286. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13287. if (is_invalid) {
  13288. handle.error = Error::Read;
  13289. handle.response.reset();
  13290. return handle;
  13291. }
  13292. handle.body_reader_.has_content_length = true;
  13293. handle.body_reader_.content_length = content_length;
  13294. }
  13295. handle.body_reader_.chunked =
  13296. detail::is_chunked_transfer_encoding(handle.response->headers);
  13297. auto content_encoding = detail::get_combined_header_value(
  13298. handle.response->headers, "Content-Encoding");
  13299. if (!content_encoding.empty()) {
  13300. // Same policy as prepare_content_receiver(): reject a coding we know about
  13301. // but were not built with, pass an unrecognized one through as-is.
  13302. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13303. if (!handle.decompressor_) {
  13304. if (detail::is_known_content_encoding(content_encoding)) {
  13305. handle.error = Error::UnsupportedContentEncoding;
  13306. handle.response.reset();
  13307. return handle;
  13308. }
  13309. } else if (!handle.decompressor_->is_valid()) {
  13310. handle.error = Error::Compression;
  13311. handle.response.reset();
  13312. return handle;
  13313. }
  13314. }
  13315. return handle;
  13316. }
  13317. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13318. if (!is_valid() || !response) { return -1; }
  13319. if (decompressor_) { return read_with_decompression(buf, len); }
  13320. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13321. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13322. trailers_parsed_ = true;
  13323. if (body_reader_.chunked_decoder) {
  13324. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13325. response->trailers, response->headers)) {
  13326. return n;
  13327. }
  13328. } else {
  13329. detail::ChunkedDecoder dec(*stream_);
  13330. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13331. return n;
  13332. }
  13333. }
  13334. }
  13335. return n;
  13336. }
  13337. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13338. size_t len) {
  13339. if (decompress_offset_ < decompress_buffer_.size()) {
  13340. auto available = decompress_buffer_.size() - decompress_offset_;
  13341. auto to_copy = (std::min)(len, available);
  13342. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13343. decompress_offset_ += to_copy;
  13344. decompressed_bytes_read_ += to_copy;
  13345. return static_cast<ssize_t>(to_copy);
  13346. }
  13347. decompress_buffer_.clear();
  13348. decompress_offset_ = 0;
  13349. constexpr size_t kDecompressionBufferSize = 8192;
  13350. char compressed_buf[kDecompressionBufferSize];
  13351. while (true) {
  13352. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13353. sizeof(compressed_buf));
  13354. if (n <= 0) { return n; }
  13355. bool decompress_ok = decompressor_->decompress(
  13356. compressed_buf, static_cast<size_t>(n),
  13357. [this](const char *data, size_t data_len) {
  13358. decompress_buffer_.append(data, data_len);
  13359. auto limit = body_reader_.payload_max_length;
  13360. return limit == 0 ||
  13361. decompressed_bytes_read_ + decompress_buffer_.size() <= limit;
  13362. });
  13363. if (!decompress_ok) {
  13364. body_reader_.last_error = Error::Read;
  13365. return -1;
  13366. }
  13367. if (!decompress_buffer_.empty()) { break; }
  13368. }
  13369. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13370. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13371. decompress_offset_ = to_copy;
  13372. decompressed_bytes_read_ += to_copy;
  13373. return static_cast<ssize_t>(to_copy);
  13374. }
  13375. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13376. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13377. return;
  13378. }
  13379. trailers_parsed_ = true;
  13380. const auto bufsiz = 128;
  13381. char line_buf[bufsiz];
  13382. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13383. if (!line_reader.getline()) { return; }
  13384. if (!detail::parse_trailers(line_reader, response->trailers,
  13385. response->headers)) {
  13386. return;
  13387. }
  13388. }
  13389. namespace detail {
  13390. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13391. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13392. size_t &out_chunk_offset,
  13393. size_t &out_chunk_total) {
  13394. if (finished) { return 0; }
  13395. if (chunk_remaining == 0) {
  13396. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13397. if (!lr.getline()) { return -1; }
  13398. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13399. // the line terminator is never mistaken for line content.
  13400. const char *eol = lr.ptr() + lr.size();
  13401. if (lr.end_with_crlf()) {
  13402. eol -= 2;
  13403. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13404. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13405. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13406. // has to come off here or the check below would reject the line.
  13407. eol -= 1;
  13408. }
  13409. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13410. const char *p = lr.ptr();
  13411. int v = 0;
  13412. if (p == eol || !is_hex(*p, v)) { return -1; }
  13413. size_t chunk_len = 0;
  13414. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13415. for (; p < eol && is_hex(*p, v); ++p) {
  13416. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13417. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13418. }
  13419. while (p < eol && is_space_or_tab(*p)) {
  13420. ++p;
  13421. }
  13422. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13423. // terminator, and it is built from tokens and quoted-strings, so it never
  13424. // holds a CR, LF or any other control character. getline() reads up to the
  13425. // CRLF, so a bare LF left in here would be swallowed as extension text
  13426. // while an intermediary that ends the line on it delimits the chunks
  13427. // differently, and the two disagree on where the body ends (request
  13428. // smuggling).
  13429. if (p < eol && *p != ';') { return -1; }
  13430. for (; p < eol; ++p) {
  13431. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13432. }
  13433. if (chunk_len == 0) {
  13434. chunk_remaining = 0;
  13435. finished = true;
  13436. out_chunk_offset = 0;
  13437. out_chunk_total = 0;
  13438. return 0;
  13439. }
  13440. chunk_remaining = chunk_len;
  13441. last_chunk_total = chunk_remaining;
  13442. last_chunk_offset = 0;
  13443. }
  13444. auto to_read = (std::min)(chunk_remaining, len);
  13445. auto n = strm.read(buf, to_read);
  13446. if (n <= 0) { return -1; }
  13447. auto offset_before = last_chunk_offset;
  13448. last_chunk_offset += static_cast<size_t>(n);
  13449. chunk_remaining -= static_cast<size_t>(n);
  13450. out_chunk_offset = offset_before;
  13451. out_chunk_total = last_chunk_total;
  13452. if (chunk_remaining == 0) {
  13453. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13454. if (!lr.getline()) { return -1; }
  13455. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13456. }
  13457. return n;
  13458. }
  13459. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13460. const Headers &src_headers) {
  13461. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13462. if (!lr.getline()) { return false; }
  13463. return parse_trailers(lr, dest, src_headers);
  13464. }
  13465. } // namespace detail
  13466. inline void
  13467. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13468. handle.connection_->sock = socket_.sock;
  13469. #ifdef CPPHTTPLIB_SSL_ENABLED
  13470. handle.connection_->session = socket_.ssl;
  13471. socket_.ssl = nullptr;
  13472. #endif
  13473. socket_.sock = INVALID_SOCKET;
  13474. }
  13475. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13476. Response &res, bool close_connection,
  13477. Error &error) {
  13478. if (req.path.empty()) {
  13479. error = Error::Connection;
  13480. output_error_log(error, &req);
  13481. return false;
  13482. }
  13483. auto req_save = req;
  13484. bool ret;
  13485. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13486. auto req2 = req;
  13487. req2.path = "http://" +
  13488. detail::make_host_and_port_string(host_, port_, false) +
  13489. req.path;
  13490. ret = process_request(strm, req2, res, close_connection, error);
  13491. req = std::move(req2);
  13492. req.path = req_save.path;
  13493. } else {
  13494. ret = process_request(strm, req, res, close_connection, error);
  13495. }
  13496. if (!ret) { return false; }
  13497. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13498. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13499. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13500. // for this to be safe.
  13501. // This is safe to call because handle_request is only called by send_
  13502. // which locks the request mutex during the process. It would be a bug
  13503. // to call it from a different thread since it's a thread-safety issue
  13504. // to do these things to the socket if another thread is using the socket.
  13505. std::lock_guard<std::mutex> guard(socket_mutex_);
  13506. disconnect(/*gracefully=*/true);
  13507. }
  13508. if (300 < res.status && res.status < 400 && follow_location_) {
  13509. req = std::move(req_save);
  13510. // The client that followed the redirect has answered any challenge it
  13511. // could. Retrying below would sign another host's challenge and send it
  13512. // here.
  13513. return redirect(req, res, error);
  13514. }
  13515. #ifdef CPPHTTPLIB_SSL_ENABLED
  13516. if ((res.status == StatusCode::Unauthorized_401 ||
  13517. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13518. req.authorization_count_ < 5) {
  13519. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13520. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13521. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13522. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13523. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13524. return ret;
  13525. }
  13526. const auto &username =
  13527. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13528. const auto &password =
  13529. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13530. if (!username.empty() && !password.empty()) {
  13531. std::map<std::string, std::string> auth;
  13532. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13533. Request new_req = req;
  13534. new_req.authorization_count_ += 1;
  13535. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13536. : "Authorization");
  13537. new_req.headers.insert(detail::make_digest_authentication_header(
  13538. req, auth, new_req.authorization_count_, detail::random_string(10),
  13539. username, password, is_proxy));
  13540. Response new_res;
  13541. ret = send(new_req, new_res, error);
  13542. if (ret) { res = std::move(new_res); }
  13543. }
  13544. }
  13545. }
  13546. #endif
  13547. return ret;
  13548. }
  13549. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13550. if (req.redirect_count_ == 0) {
  13551. error = Error::ExceedRedirectCount;
  13552. output_error_log(error, &req);
  13553. return false;
  13554. }
  13555. auto location = res.get_header_value("location");
  13556. if (location.empty()) { return false; }
  13557. detail::UrlComponents uc;
  13558. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13559. uc)) {
  13560. return false;
  13561. }
  13562. // Only follow http/https redirects
  13563. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13564. return false;
  13565. }
  13566. auto scheme = is_ssl() ? "https" : "http";
  13567. auto next_scheme = std::move(uc.scheme);
  13568. auto next_host = std::move(uc.host);
  13569. auto port_str = std::move(uc.port);
  13570. auto next_path = std::move(uc.path);
  13571. auto next_query = std::move(uc.query);
  13572. auto next_port = port_;
  13573. if (!port_str.empty()) {
  13574. if (!detail::parse_port(port_str, next_port)) { return false; }
  13575. } else if (!next_scheme.empty()) {
  13576. next_port = next_scheme == "https" ? 443 : 80;
  13577. }
  13578. if (next_scheme.empty()) { next_scheme = scheme; }
  13579. if (next_host.empty()) { next_host = host_; }
  13580. if (next_path.empty()) { next_path = "/"; }
  13581. auto path = std::move(next_path) + next_query;
  13582. // Same host redirect - use current client
  13583. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13584. return detail::redirect(*this, req, res, path, location, error);
  13585. }
  13586. // Cross-host/scheme redirect - create new client with robust setup
  13587. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13588. path, location, error);
  13589. }
  13590. // New method for robust redirect client creation
  13591. inline bool ClientImpl::create_redirect_client(
  13592. const std::string &scheme, const std::string &host, int port, Request &req,
  13593. Response &res, const std::string &path, const std::string &location,
  13594. Error &error) {
  13595. // Determine if we need SSL
  13596. auto need_ssl = (scheme == "https");
  13597. // Clean up request headers that are host/client specific
  13598. // Remove headers that should not be carried over to new host
  13599. auto headers_to_remove = std::vector<std::string>{
  13600. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13601. for (const auto &header_name : headers_to_remove) {
  13602. auto it = req.headers.find(header_name);
  13603. while (it != req.headers.end()) {
  13604. it = req.headers.erase(it);
  13605. it = req.headers.find(header_name);
  13606. }
  13607. }
  13608. // Create appropriate client type and handle redirect
  13609. if (need_ssl) {
  13610. #ifdef CPPHTTPLIB_SSL_ENABLED
  13611. // Create SSL client for HTTPS redirect
  13612. SSLClient redirect_client(host, port);
  13613. // Setup basic client configuration first
  13614. setup_redirect_client(redirect_client);
  13615. redirect_client.enable_server_certificate_verification(
  13616. server_certificate_verification_);
  13617. redirect_client.enable_server_hostname_verification(
  13618. server_hostname_verification_);
  13619. redirect_client.system_ca_mode_ = system_ca_mode_;
  13620. // Transfer CA certificate to redirect client
  13621. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13622. ca_cert_pem_.size());
  13623. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13624. if (is_ssl()) {
  13625. auto &self = static_cast<SSLClient &>(*this);
  13626. // A store given to set_ca_cert_store() lives only in this client's
  13627. // context, so pass on the CA certificates the context holds.
  13628. if (self.ca_cert_store_set_) {
  13629. auto pem = detail::ca_certs_to_pem(self.ctx_);
  13630. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13631. }
  13632. redirect_client.set_session_verifier(self.session_verifier_);
  13633. if (self.server_certificate_verifier_) {
  13634. redirect_client.set_server_certificate_verifier(
  13635. self.server_certificate_verifier_);
  13636. }
  13637. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13638. redirect_client.enable_windows_cert_verification_ =
  13639. self.enable_windows_cert_verification_;
  13640. #endif
  13641. }
  13642. // Client certificates are set through constructor for SSLClient
  13643. // NOTE: SSLClient constructor already takes client_cert_path and
  13644. // client_key_path so we need to create it properly if client certs are
  13645. // needed
  13646. // Execute the redirect
  13647. return detail::redirect(redirect_client, req, res, path, location, error);
  13648. #else
  13649. // SSL not supported - set appropriate error
  13650. error = Error::SSLConnection;
  13651. output_error_log(error, &req);
  13652. return false;
  13653. #endif
  13654. } else {
  13655. // HTTP redirect
  13656. ClientImpl redirect_client(host, port);
  13657. // Setup client with robust configuration
  13658. setup_redirect_client(redirect_client);
  13659. // Execute the redirect
  13660. return detail::redirect(redirect_client, req, res, path, location, error);
  13661. }
  13662. }
  13663. // New method for robust client setup (based on basic_manual_redirect.cpp
  13664. // logic)
  13665. template <typename ClientType>
  13666. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13667. // Copy basic settings first
  13668. client.set_connection_timeout(connection_timeout_sec_,
  13669. connection_timeout_usec_);
  13670. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13671. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13672. client.set_max_timeout(max_timeout_msec_);
  13673. if (has_payload_max_length_) {
  13674. client.set_payload_max_length(payload_max_length_);
  13675. }
  13676. client.set_keep_alive(keep_alive_);
  13677. client.set_follow_location(
  13678. true); // Enable redirects to handle multi-step redirects
  13679. client.set_path_encode(path_encode_);
  13680. client.set_compress(compress_);
  13681. client.set_decompress(decompress_);
  13682. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13683. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13684. // 15.4, credentials must not be forwarded when redirecting to a different
  13685. // host. This function is only called for cross-host redirects; same-host
  13686. // redirects are handled directly in ClientImpl::redirect().
  13687. // Copy the proxy configuration unconditionally; the per-target bypass is
  13688. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13689. // still use the proxy.
  13690. client.no_proxy_entries_ = no_proxy_entries_;
  13691. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13692. client.set_proxy(proxy_host_, proxy_port_);
  13693. if (!proxy_basic_auth_username_.empty() ||
  13694. !proxy_basic_auth_password_.empty()) {
  13695. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13696. proxy_basic_auth_password_);
  13697. }
  13698. if (!proxy_bearer_token_auth_token_.empty()) {
  13699. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13700. }
  13701. #ifdef CPPHTTPLIB_SSL_ENABLED
  13702. if (!proxy_digest_auth_username_.empty()) {
  13703. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13704. proxy_digest_auth_password_);
  13705. }
  13706. #endif
  13707. }
  13708. // Copy network and socket settings
  13709. client.addr_map_ = addr_map_;
  13710. client.set_address_family(address_family_);
  13711. client.set_tcp_nodelay(tcp_nodelay_);
  13712. client.set_ipv6_v6only(ipv6_v6only_);
  13713. if (socket_options_) { client.set_socket_options(socket_options_); }
  13714. if (!interface_.empty()) { client.set_interface(interface_); }
  13715. // Copy logging and headers
  13716. if (logger_) { client.set_logger(logger_); }
  13717. if (error_logger_) { client.set_error_logger(error_logger_); }
  13718. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13719. // Each new client should generate its own headers based on its target host
  13720. }
  13721. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13722. const Request &req,
  13723. Error &error) const {
  13724. auto is_shutting_down = []() { return false; };
  13725. if (req.is_chunked_content_provider_) {
  13726. auto compressor = compress_ ? detail::create_compressor().first
  13727. : std::unique_ptr<detail::compressor>();
  13728. if (!compressor) {
  13729. compressor = detail::make_unique<detail::nocompressor>();
  13730. }
  13731. return detail::write_content_chunked(strm, req.content_provider_,
  13732. is_shutting_down, *compressor, error);
  13733. } else {
  13734. return detail::write_content_with_progress(
  13735. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13736. req.upload_progress, error);
  13737. }
  13738. }
  13739. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13740. bool close_connection, Error &error,
  13741. bool skip_body, bool &rejected_locally) {
  13742. rejected_locally = false;
  13743. // Prepare additional headers
  13744. if (close_connection) {
  13745. if (!req.has_header("Connection")) {
  13746. req.set_header("Connection", "close");
  13747. }
  13748. }
  13749. std::string ct_for_defaults;
  13750. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13751. ct_for_defaults = "text/plain";
  13752. }
  13753. prepare_default_headers(req, false, ct_for_defaults);
  13754. if (req.body.empty()) {
  13755. if (req.content_provider_) {
  13756. if (!req.is_chunked_content_provider_) {
  13757. if (!req.has_header("Content-Length")) {
  13758. auto length = std::to_string(req.content_length_);
  13759. req.set_header("Content-Length", length);
  13760. }
  13761. }
  13762. } else {
  13763. if (req.method == "POST" || req.method == "PUT" ||
  13764. req.method == "PATCH") {
  13765. req.set_header("Content-Length", "0");
  13766. }
  13767. }
  13768. }
  13769. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13770. // it opens is read by the origin. Each credential goes only to its own hop.
  13771. auto is_connect = req.method == "CONNECT";
  13772. if (!is_connect && !req.has_header("Authorization")) {
  13773. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13774. req.headers.insert(make_basic_authentication_header(
  13775. basic_auth_username_, basic_auth_password_, false));
  13776. } else if (!bearer_token_auth_token_.empty()) {
  13777. req.headers.insert(make_bearer_token_authentication_header(
  13778. bearer_token_auth_token_, false));
  13779. }
  13780. }
  13781. // Proxy-Authorization is only sent when the proxy reads this message —
  13782. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13783. // would leak proxy credentials to the destination server.
  13784. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13785. if ((!proxy_basic_auth_username_.empty() ||
  13786. !proxy_basic_auth_password_.empty()) &&
  13787. !req.has_header("Proxy-Authorization")) {
  13788. req.headers.insert(make_basic_authentication_header(
  13789. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13790. }
  13791. if (!proxy_bearer_token_auth_token_.empty() &&
  13792. !req.has_header("Proxy-Authorization")) {
  13793. req.headers.insert(make_bearer_token_authentication_header(
  13794. proxy_bearer_token_auth_token_, true));
  13795. }
  13796. }
  13797. // Request line and headers
  13798. {
  13799. detail::BufferStream bstrm;
  13800. // Extract the query from req.path. The encoding itself is delegated to
  13801. // `encode_request_target`; the raw query is still needed here to decide
  13802. // between populating `req.params` from it and falling back to building a
  13803. // query out of caller-supplied `req.params`.
  13804. auto query_pos = req.path.find('?');
  13805. auto query_part = query_pos == std::string::npos
  13806. ? std::string()
  13807. : req.path.substr(query_pos + 1);
  13808. auto path_with_query =
  13809. detail::encode_request_target(req.path, path_encode_);
  13810. if (!query_part.empty()) {
  13811. // The query already came in through `req.path`; still populate
  13812. // `req.params` for handlers/users who read them.
  13813. detail::parse_query_text(query_part, req.params);
  13814. } else if (!req.params.empty()) {
  13815. // No query in `req.path`; build one from `req.params` so existing
  13816. // callers that pass `Params` separately continue to work.
  13817. path_with_query = append_query_params(path_with_query, req.params);
  13818. }
  13819. // Write request line and headers
  13820. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13821. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13822. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  13823. // fail the request cleanly instead of emitting a request-line-less,
  13824. // header-injecting request.
  13825. error = Error::Write;
  13826. rejected_locally = true;
  13827. output_error_log(error, &req);
  13828. return false;
  13829. }
  13830. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13831. error)) {
  13832. rejected_locally = true;
  13833. output_error_log(error, &req);
  13834. return false;
  13835. }
  13836. // Flush buffer
  13837. auto &data = bstrm.get_buffer();
  13838. if (!detail::write_data(strm, data.data(), data.size())) {
  13839. error = Error::Write;
  13840. output_error_log(error, &req);
  13841. return false;
  13842. }
  13843. }
  13844. // After sending request line and headers, wait briefly for an early server
  13845. // response (e.g. 4xx) and avoid sending a potentially large request body
  13846. // unnecessarily. This workaround is only enabled on Windows because Unix
  13847. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13848. // buffering can accept large writes even when the peer already responded.
  13849. // Check the stream first (which covers SSL via `is_readable()`), then
  13850. // fall back to select on the socket. Only perform the wait for very large
  13851. // request bodies to avoid interfering with normal small requests and
  13852. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13853. // response. Skip this check when using Expect: 100-continue, as the protocol
  13854. // handles early responses properly.
  13855. #if defined(_WIN32)
  13856. if (!skip_body &&
  13857. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13858. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13859. auto start = std::chrono::high_resolution_clock::now();
  13860. for (;;) {
  13861. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13862. // from SSL internals. If the underlying socket is readable, assume an
  13863. // early response may be present.
  13864. auto sock = strm.socket();
  13865. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13866. return false;
  13867. }
  13868. // Fallback to stream-level check for non-socket streams or when the
  13869. // socket isn't reporting readable. Avoid using `is_readable()` for
  13870. // SSL, since `SSL_pending()` may report buffered records that do not
  13871. // indicate a complete application-level response yet.
  13872. if (!is_ssl() && strm.is_readable()) { return false; }
  13873. auto now = std::chrono::high_resolution_clock::now();
  13874. auto elapsed =
  13875. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13876. .count();
  13877. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13878. break;
  13879. }
  13880. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13881. }
  13882. }
  13883. #endif
  13884. // Body
  13885. if (skip_body) { return true; }
  13886. return write_request_body(strm, req, error);
  13887. }
  13888. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13889. Error &error) {
  13890. if (req.body.empty()) {
  13891. return write_content_with_provider(strm, req, error);
  13892. }
  13893. if (req.upload_progress) {
  13894. auto body_size = req.body.size();
  13895. size_t written = 0;
  13896. auto data = req.body.data();
  13897. while (written < body_size) {
  13898. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13899. if (!detail::write_data(strm, data + written, to_write)) {
  13900. error = Error::Write;
  13901. output_error_log(error, &req);
  13902. return false;
  13903. }
  13904. written += to_write;
  13905. if (!req.upload_progress(written, body_size)) {
  13906. error = Error::Canceled;
  13907. output_error_log(error, &req);
  13908. return false;
  13909. }
  13910. }
  13911. } else {
  13912. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13913. error = Error::Write;
  13914. output_error_log(error, &req);
  13915. return false;
  13916. }
  13917. }
  13918. return true;
  13919. }
  13920. inline std::unique_ptr<Response>
  13921. ClientImpl::send_with_content_provider_and_receiver(
  13922. Request &req, const char *body, size_t content_length,
  13923. ContentProvider content_provider,
  13924. ContentProviderWithoutLength content_provider_without_length,
  13925. const std::string &content_type, ContentReceiver content_receiver,
  13926. Error &error) {
  13927. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13928. auto enc = compress_
  13929. ? detail::create_compressor()
  13930. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13931. nullptr, nullptr);
  13932. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13933. if (enc.first && !content_provider_without_length) {
  13934. auto &compressor = enc.first;
  13935. if (content_provider) {
  13936. auto ok = true;
  13937. auto finished = false;
  13938. size_t offset = 0;
  13939. DataSink data_sink;
  13940. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13941. if (ok) {
  13942. auto last = offset + data_len == content_length;
  13943. auto ret = compressor->compress(
  13944. data, data_len, last,
  13945. [&](const char *compressed_data, size_t compressed_data_len) {
  13946. req.body.append(compressed_data, compressed_data_len);
  13947. return true;
  13948. });
  13949. if (ret) {
  13950. offset += data_len;
  13951. } else {
  13952. ok = false;
  13953. }
  13954. }
  13955. return ok;
  13956. };
  13957. // As in detail::write_content_with_progress(): the body is framed by
  13958. // content_length, so a provider that finishes early has truncated it.
  13959. // Stop and report that instead of calling the provider forever.
  13960. data_sink.done = [&]() { finished = true; };
  13961. while (ok && !finished && offset < content_length) {
  13962. if (!content_provider(offset, content_length - offset, data_sink)) {
  13963. error = Error::Canceled;
  13964. output_error_log(error, &req);
  13965. return nullptr;
  13966. }
  13967. }
  13968. // A short body here means either the provider stopped early or the
  13969. // compressor gave up. The branch below reports a failing compressor as
  13970. // Error::Compression, so keep the two distinguishable.
  13971. if (offset < content_length) {
  13972. error = ok ? Error::Write : Error::Compression;
  13973. output_error_log(error, &req);
  13974. return nullptr;
  13975. }
  13976. } else {
  13977. if (!compressor->compress(body, content_length, true,
  13978. [&](const char *data, size_t data_len) {
  13979. req.body.append(data, data_len);
  13980. return true;
  13981. })) {
  13982. error = Error::Compression;
  13983. output_error_log(error, &req);
  13984. return nullptr;
  13985. }
  13986. }
  13987. } else {
  13988. if (content_provider) {
  13989. req.content_length_ = content_length;
  13990. req.content_provider_ = std::move(content_provider);
  13991. req.is_chunked_content_provider_ = false;
  13992. } else if (content_provider_without_length) {
  13993. req.content_length_ = 0;
  13994. req.content_provider_ = detail::ContentProviderAdapter(
  13995. std::move(content_provider_without_length));
  13996. req.is_chunked_content_provider_ = true;
  13997. req.set_header("Transfer-Encoding", "chunked");
  13998. } else {
  13999. req.body.assign(body, content_length);
  14000. }
  14001. }
  14002. if (content_receiver) {
  14003. req.content_receiver =
  14004. [content_receiver](const char *data, size_t data_length,
  14005. size_t /*offset*/, size_t /*total_length*/) {
  14006. return content_receiver(data, data_length);
  14007. };
  14008. }
  14009. auto res = detail::make_unique<Response>();
  14010. return send(req, *res, error) ? std::move(res) : nullptr;
  14011. }
  14012. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14013. const std::string &method, const std::string &path, const Headers &headers,
  14014. const char *body, size_t content_length, ContentProvider content_provider,
  14015. ContentProviderWithoutLength content_provider_without_length,
  14016. const std::string &content_type, ContentReceiver content_receiver,
  14017. UploadProgress progress) {
  14018. Request req;
  14019. req.method = method;
  14020. req.headers = headers;
  14021. req.path = path;
  14022. req.upload_progress = std::move(progress);
  14023. if (max_timeout_msec_ > 0) {
  14024. req.start_time_ = std::chrono::steady_clock::now();
  14025. }
  14026. auto error = Error::Success;
  14027. auto res = send_with_content_provider_and_receiver(
  14028. req, body, content_length, std::move(content_provider),
  14029. std::move(content_provider_without_length), content_type,
  14030. std::move(content_receiver), error);
  14031. #ifdef CPPHTTPLIB_SSL_ENABLED
  14032. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14033. last_backend_error_};
  14034. #else
  14035. return Result{std::move(res), error, std::move(req.headers)};
  14036. #endif
  14037. }
  14038. inline void ClientImpl::output_log(const Request &req,
  14039. const Response &res) const {
  14040. if (logger_) {
  14041. std::lock_guard<std::mutex> guard(logger_mutex_);
  14042. logger_(req, res);
  14043. }
  14044. }
  14045. inline void ClientImpl::output_error_log(const Error &err,
  14046. const Request *req) const {
  14047. if (error_logger_) {
  14048. std::lock_guard<std::mutex> guard(logger_mutex_);
  14049. error_logger_(err, req);
  14050. }
  14051. }
  14052. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14053. Response &res, bool close_connection,
  14054. Error &error) {
  14055. // Auto-add Expect: 100-continue for large bodies
  14056. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14057. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14058. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14059. req.set_header("Expect", "100-continue");
  14060. }
  14061. }
  14062. // Check for Expect: 100-continue
  14063. auto expect_100_continue =
  14064. detail::has_header_token(req.headers, "Expect", "100-continue");
  14065. // Send request (skip body if using Expect: 100-continue)
  14066. auto rejected_locally = false;
  14067. auto write_request_success =
  14068. write_request(strm, req, close_connection, error, expect_100_continue,
  14069. rejected_locally);
  14070. // A failed write normally still reads the response below, since the server
  14071. // may have answered early (e.g. 413/414) and closed while the body was being
  14072. // sent. A request rejected before any byte reached the socket gets no such
  14073. // response, and waiting for one would block until the read timeout.
  14074. if (rejected_locally) { return false; }
  14075. #ifdef CPPHTTPLIB_SSL_ENABLED
  14076. if (is_ssl() && !expect_100_continue) {
  14077. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14078. if (!is_proxy_enabled) {
  14079. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14080. error = Error::SSLPeerCouldBeClosed_;
  14081. output_error_log(error, &req);
  14082. return false;
  14083. }
  14084. }
  14085. }
  14086. #endif
  14087. // Handle Expect: 100-continue.
  14088. //
  14089. // Wait for an interim/early response by attempting to read the status line
  14090. // under a short timeout, instead of trusting raw socket readability. Over
  14091. // TLS, post-handshake records (e.g. session tickets) make the socket
  14092. // readable without any HTTP response being available; relying on
  14093. // `select_read` there caused the body to be withheld forever and the
  14094. // request to fail with `Read` (#2458). If no status line arrives within the
  14095. // timeout, send the body anyway (matching curl's behavior).
  14096. auto status_line_read = false;
  14097. if (expect_100_continue && write_request_success) {
  14098. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14099. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14100. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14101. strm.set_read_timeout(sec, usec);
  14102. status_line_read = read_response_line(strm, req, res, false);
  14103. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14104. }
  14105. if (!status_line_read) {
  14106. // No interim response within the timeout: send the body and handle the
  14107. // response as usual.
  14108. if (!write_request_body(strm, req, error)) { return false; }
  14109. expect_100_continue = false; // Switch to normal response handling
  14110. }
  14111. }
  14112. // Receive response and headers
  14113. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14114. if ((!status_line_read &&
  14115. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14116. !detail::read_headers(strm, res.headers)) {
  14117. if (write_request_success) { error = Error::Read; }
  14118. output_error_log(error, &req);
  14119. return false;
  14120. }
  14121. if (!write_request_success) { return false; }
  14122. // Handle Expect: 100-continue response
  14123. if (expect_100_continue) {
  14124. if (res.status == StatusCode::Continue_100) {
  14125. // Server accepted, send the body
  14126. if (!write_request_body(strm, req, error)) { return false; }
  14127. // Read the actual response
  14128. res.headers.clear();
  14129. res.body.clear();
  14130. if (!read_response_line(strm, req, res) ||
  14131. !detail::read_headers(strm, res.headers)) {
  14132. error = Error::Read;
  14133. output_error_log(error, &req);
  14134. return false;
  14135. }
  14136. } else {
  14137. // A final response came first, so the body this request declared was
  14138. // never sent, and the server may still be waiting for it. The
  14139. // connection cannot carry another request.
  14140. std::lock_guard<std::mutex> guard(socket_mutex_);
  14141. socket_should_be_closed_when_request_is_done_ = true;
  14142. }
  14143. }
  14144. // Body
  14145. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14146. req.method != "CONNECT") {
  14147. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14148. // whose final transfer coding is not chunked is not ambiguous: its body
  14149. // runs until the server closes the connection, so it is not rejected.
  14150. // HEAD/204 are excluded above and a 304 carries no body.
  14151. if (res.status != StatusCode::NotModified_304 &&
  14152. detail::has_conflicting_content_length(res.headers)) {
  14153. error = Error::Read;
  14154. output_error_log(error, &req);
  14155. return false;
  14156. }
  14157. auto redirect = 300 < res.status && res.status < 400 &&
  14158. res.status != StatusCode::NotModified_304 &&
  14159. follow_location_;
  14160. if (req.response_handler && !redirect) {
  14161. if (!req.response_handler(res)) {
  14162. error = Error::Canceled;
  14163. output_error_log(error, &req);
  14164. return false;
  14165. }
  14166. }
  14167. auto out =
  14168. req.content_receiver
  14169. ? static_cast<ContentReceiverWithProgress>(
  14170. [&](const char *buf, size_t n, size_t off, size_t len) {
  14171. if (redirect) { return true; }
  14172. auto ret = req.content_receiver(buf, n, off, len);
  14173. if (!ret) {
  14174. error = Error::Canceled;
  14175. output_error_log(error, &req);
  14176. }
  14177. return ret;
  14178. })
  14179. : static_cast<ContentReceiverWithProgress>(
  14180. [&](const char *buf, size_t n, size_t /*off*/,
  14181. size_t /*len*/) {
  14182. assert(res.body.size() + n <= res.body.max_size());
  14183. if (payload_max_length_ > 0 &&
  14184. (res.body.size() >= payload_max_length_ ||
  14185. n > payload_max_length_ - res.body.size())) {
  14186. return false;
  14187. }
  14188. res.body.append(buf, n);
  14189. return true;
  14190. });
  14191. auto progress = [&](size_t current, size_t total) {
  14192. if (!req.download_progress || redirect) { return true; }
  14193. auto ret = req.download_progress(current, total);
  14194. if (!ret) {
  14195. error = Error::Canceled;
  14196. output_error_log(error, &req);
  14197. }
  14198. return ret;
  14199. };
  14200. if (res.has_header("Content-Length")) {
  14201. if (!req.content_receiver) {
  14202. auto len = res.get_header_value_u64("Content-Length");
  14203. if (len > res.body.max_size()) {
  14204. error = Error::Read;
  14205. output_error_log(error, &req);
  14206. return false;
  14207. }
  14208. // Content-Length is only the server's claim, so reserve no more than
  14209. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14210. // body has arrived. A longer body grows as it is read.
  14211. auto reserve_len =
  14212. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14213. if (payload_max_length_ > 0) {
  14214. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14215. }
  14216. res.body.reserve(reserve_len);
  14217. }
  14218. }
  14219. if (res.status != StatusCode::NotModified_304) {
  14220. auto content_status = 0;
  14221. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14222. ? (std::numeric_limits<size_t>::max)()
  14223. : payload_max_length_;
  14224. if (!detail::read_content(strm, res, max_length, content_status,
  14225. std::move(progress), std::move(out),
  14226. decompress_)) {
  14227. if (error != Error::Canceled) {
  14228. // Tell the caller apart from a plain read failure when the body could
  14229. // not be decoded because of its Content-Encoding.
  14230. switch (content_status) {
  14231. case StatusCode::UnsupportedMediaType_415:
  14232. error = Error::UnsupportedContentEncoding;
  14233. break;
  14234. case StatusCode::InternalServerError_500:
  14235. error = Error::Compression;
  14236. break;
  14237. default: error = Error::Read; break;
  14238. }
  14239. }
  14240. output_error_log(error, &req);
  14241. return false;
  14242. }
  14243. }
  14244. }
  14245. // Log
  14246. output_log(req, res);
  14247. return true;
  14248. }
  14249. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14250. const std::string &boundary, const UploadFormDataItems &items,
  14251. const FormDataProviderItems &provider_items) const {
  14252. size_t cur_item = 0;
  14253. size_t cur_start = 0;
  14254. // cur_item and cur_start are copied to within the std::function and
  14255. // maintain state between successive calls
  14256. return [&, cur_item, cur_start](size_t offset,
  14257. DataSink &sink) mutable -> bool {
  14258. if (!offset && !items.empty()) {
  14259. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14260. return true;
  14261. } else if (cur_item < provider_items.size()) {
  14262. if (!cur_start) {
  14263. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14264. provider_items[cur_item], boundary);
  14265. offset += begin.size();
  14266. cur_start = offset;
  14267. sink.os << begin;
  14268. }
  14269. DataSink cur_sink;
  14270. auto has_data = true;
  14271. cur_sink.write = sink.write;
  14272. // Forward is_writable so a provider item asking whether it may keep
  14273. // going gets the outer sink's answer rather than the default `true`.
  14274. cur_sink.is_writable = sink.is_writable;
  14275. cur_sink.done = [&]() { has_data = false; };
  14276. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14277. return false;
  14278. }
  14279. if (!has_data) {
  14280. sink.os << detail::serialize_multipart_formdata_item_end();
  14281. cur_item++;
  14282. cur_start = 0;
  14283. }
  14284. return true;
  14285. } else {
  14286. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14287. sink.done();
  14288. return true;
  14289. }
  14290. };
  14291. }
  14292. inline bool ClientImpl::process_socket(
  14293. const Socket &socket,
  14294. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14295. std::function<bool(Stream &strm)> callback) {
  14296. return detail::process_client_socket(
  14297. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14298. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14299. }
  14300. inline bool ClientImpl::is_ssl() const { return false; }
  14301. inline Result ClientImpl::Get(const std::string &path,
  14302. DownloadProgress progress) {
  14303. return Get(path, Headers(), std::move(progress));
  14304. }
  14305. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14306. DownloadProgress progress) {
  14307. return Get(path, params, Headers(), std::move(progress));
  14308. }
  14309. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14310. const Headers &headers,
  14311. DownloadProgress progress) {
  14312. if (params.empty()) { return Get(path, headers); }
  14313. std::string path_with_query = append_query_params(path, params);
  14314. return Get(path_with_query, headers, std::move(progress));
  14315. }
  14316. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14317. DownloadProgress progress) {
  14318. Request req;
  14319. req.method = "GET";
  14320. req.path = path;
  14321. req.headers = headers;
  14322. req.download_progress = std::move(progress);
  14323. if (max_timeout_msec_ > 0) {
  14324. req.start_time_ = std::chrono::steady_clock::now();
  14325. }
  14326. return send_(std::move(req));
  14327. }
  14328. inline Result ClientImpl::Get(const std::string &path,
  14329. ContentReceiver content_receiver,
  14330. DownloadProgress progress) {
  14331. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14332. std::move(progress));
  14333. }
  14334. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14335. ContentReceiver content_receiver,
  14336. DownloadProgress progress) {
  14337. return Get(path, headers, nullptr, std::move(content_receiver),
  14338. std::move(progress));
  14339. }
  14340. inline Result ClientImpl::Get(const std::string &path,
  14341. ResponseHandler response_handler,
  14342. ContentReceiver content_receiver,
  14343. DownloadProgress progress) {
  14344. return Get(path, Headers(), std::move(response_handler),
  14345. std::move(content_receiver), std::move(progress));
  14346. }
  14347. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14348. ResponseHandler response_handler,
  14349. ContentReceiver content_receiver,
  14350. DownloadProgress progress) {
  14351. Request req;
  14352. req.method = "GET";
  14353. req.path = path;
  14354. req.headers = headers;
  14355. req.response_handler = std::move(response_handler);
  14356. req.content_receiver =
  14357. [content_receiver](const char *data, size_t data_length,
  14358. size_t /*offset*/, size_t /*total_length*/) {
  14359. return content_receiver(data, data_length);
  14360. };
  14361. req.download_progress = std::move(progress);
  14362. if (max_timeout_msec_ > 0) {
  14363. req.start_time_ = std::chrono::steady_clock::now();
  14364. }
  14365. return send_(std::move(req));
  14366. }
  14367. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14368. const Headers &headers,
  14369. ContentReceiver content_receiver,
  14370. DownloadProgress progress) {
  14371. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14372. std::move(progress));
  14373. }
  14374. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14375. const Headers &headers,
  14376. ResponseHandler response_handler,
  14377. ContentReceiver content_receiver,
  14378. DownloadProgress progress) {
  14379. if (params.empty()) {
  14380. return Get(path, headers, std::move(response_handler),
  14381. std::move(content_receiver), std::move(progress));
  14382. }
  14383. std::string path_with_query = append_query_params(path, params);
  14384. return Get(path_with_query, headers, std::move(response_handler),
  14385. std::move(content_receiver), std::move(progress));
  14386. }
  14387. inline Result ClientImpl::Head(const std::string &path) {
  14388. return Head(path, Headers());
  14389. }
  14390. inline Result ClientImpl::Head(const std::string &path,
  14391. const Headers &headers) {
  14392. Request req;
  14393. req.method = "HEAD";
  14394. req.headers = headers;
  14395. req.path = path;
  14396. if (max_timeout_msec_ > 0) {
  14397. req.start_time_ = std::chrono::steady_clock::now();
  14398. }
  14399. return send_(std::move(req));
  14400. }
  14401. inline Result ClientImpl::Post(const std::string &path) {
  14402. return Post(path, std::string(), std::string());
  14403. }
  14404. inline Result ClientImpl::Post(const std::string &path,
  14405. const Headers &headers) {
  14406. return Post(path, headers, nullptr, 0, std::string());
  14407. }
  14408. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14409. size_t content_length,
  14410. const std::string &content_type,
  14411. UploadProgress progress) {
  14412. return Post(path, Headers(), body, content_length, content_type, progress);
  14413. }
  14414. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14415. const std::string &content_type,
  14416. UploadProgress progress) {
  14417. return Post(path, Headers(), body, content_type, progress);
  14418. }
  14419. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14420. return Post(path, Headers(), params);
  14421. }
  14422. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14423. ContentProvider content_provider,
  14424. const std::string &content_type,
  14425. UploadProgress progress) {
  14426. return Post(path, Headers(), content_length, std::move(content_provider),
  14427. content_type, progress);
  14428. }
  14429. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14430. ContentProvider content_provider,
  14431. const std::string &content_type,
  14432. ContentReceiver content_receiver,
  14433. UploadProgress progress) {
  14434. return Post(path, Headers(), content_length, std::move(content_provider),
  14435. content_type, std::move(content_receiver), progress);
  14436. }
  14437. inline Result ClientImpl::Post(const std::string &path,
  14438. ContentProviderWithoutLength content_provider,
  14439. const std::string &content_type,
  14440. UploadProgress progress) {
  14441. return Post(path, Headers(), std::move(content_provider), content_type,
  14442. progress);
  14443. }
  14444. inline Result ClientImpl::Post(const std::string &path,
  14445. ContentProviderWithoutLength content_provider,
  14446. const std::string &content_type,
  14447. ContentReceiver content_receiver,
  14448. UploadProgress progress) {
  14449. return Post(path, Headers(), std::move(content_provider), content_type,
  14450. std::move(content_receiver), progress);
  14451. }
  14452. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14453. const Params &params) {
  14454. auto query = detail::params_to_query_str(params);
  14455. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14456. }
  14457. inline Result ClientImpl::Post(const std::string &path,
  14458. const UploadFormDataItems &items,
  14459. UploadProgress progress) {
  14460. return Post(path, Headers(), items, progress);
  14461. }
  14462. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14463. const UploadFormDataItems &items,
  14464. UploadProgress progress) {
  14465. const auto &boundary = detail::make_multipart_data_boundary();
  14466. const auto &content_type =
  14467. detail::serialize_multipart_formdata_get_content_type(boundary);
  14468. auto content_length = detail::get_multipart_content_length(items, boundary);
  14469. return Post(path, headers, content_length,
  14470. detail::make_multipart_content_provider(items, boundary),
  14471. content_type, progress);
  14472. }
  14473. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14474. const UploadFormDataItems &items,
  14475. const std::string &boundary,
  14476. UploadProgress progress) {
  14477. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14478. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14479. }
  14480. const auto &content_type =
  14481. detail::serialize_multipart_formdata_get_content_type(boundary);
  14482. auto content_length = detail::get_multipart_content_length(items, boundary);
  14483. return Post(path, headers, content_length,
  14484. detail::make_multipart_content_provider(items, boundary),
  14485. content_type, progress);
  14486. }
  14487. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14488. const char *body, size_t content_length,
  14489. const std::string &content_type,
  14490. UploadProgress progress) {
  14491. return send_with_content_provider_and_receiver(
  14492. "POST", path, headers, body, content_length, nullptr, nullptr,
  14493. content_type, nullptr, progress);
  14494. }
  14495. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14496. const std::string &body,
  14497. const std::string &content_type,
  14498. UploadProgress progress) {
  14499. return send_with_content_provider_and_receiver(
  14500. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14501. content_type, nullptr, progress);
  14502. }
  14503. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14504. size_t content_length,
  14505. ContentProvider content_provider,
  14506. const std::string &content_type,
  14507. UploadProgress progress) {
  14508. return send_with_content_provider_and_receiver(
  14509. "POST", path, headers, nullptr, content_length,
  14510. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14511. }
  14512. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14513. size_t content_length,
  14514. ContentProvider content_provider,
  14515. const std::string &content_type,
  14516. ContentReceiver content_receiver,
  14517. DownloadProgress progress) {
  14518. return send_with_content_provider_and_receiver(
  14519. "POST", path, headers, nullptr, content_length,
  14520. std::move(content_provider), nullptr, content_type,
  14521. std::move(content_receiver), std::move(progress));
  14522. }
  14523. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14524. ContentProviderWithoutLength content_provider,
  14525. const std::string &content_type,
  14526. UploadProgress progress) {
  14527. return send_with_content_provider_and_receiver(
  14528. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14529. content_type, nullptr, progress);
  14530. }
  14531. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14532. ContentProviderWithoutLength content_provider,
  14533. const std::string &content_type,
  14534. ContentReceiver content_receiver,
  14535. DownloadProgress progress) {
  14536. return send_with_content_provider_and_receiver(
  14537. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14538. content_type, std::move(content_receiver), std::move(progress));
  14539. }
  14540. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14541. const UploadFormDataItems &items,
  14542. const FormDataProviderItems &provider_items,
  14543. UploadProgress progress) {
  14544. const auto &boundary = detail::make_multipart_data_boundary();
  14545. const auto &content_type =
  14546. detail::serialize_multipart_formdata_get_content_type(boundary);
  14547. return send_with_content_provider_and_receiver(
  14548. "POST", path, headers, nullptr, 0, nullptr,
  14549. get_multipart_content_provider(boundary, items, provider_items),
  14550. content_type, nullptr, progress);
  14551. }
  14552. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14553. const std::string &body,
  14554. const std::string &content_type,
  14555. ContentReceiver content_receiver,
  14556. DownloadProgress progress) {
  14557. Request req;
  14558. req.method = "POST";
  14559. req.path = path;
  14560. req.headers = headers;
  14561. req.body = body;
  14562. req.content_receiver =
  14563. [content_receiver](const char *data, size_t data_length,
  14564. size_t /*offset*/, size_t /*total_length*/) {
  14565. return content_receiver(data, data_length);
  14566. };
  14567. req.download_progress = std::move(progress);
  14568. if (max_timeout_msec_ > 0) {
  14569. req.start_time_ = std::chrono::steady_clock::now();
  14570. }
  14571. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14572. return send_(std::move(req));
  14573. }
  14574. inline Result ClientImpl::Put(const std::string &path) {
  14575. return Put(path, std::string(), std::string());
  14576. }
  14577. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14578. return Put(path, headers, nullptr, 0, std::string());
  14579. }
  14580. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14581. size_t content_length,
  14582. const std::string &content_type,
  14583. UploadProgress progress) {
  14584. return Put(path, Headers(), body, content_length, content_type, progress);
  14585. }
  14586. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14587. const std::string &content_type,
  14588. UploadProgress progress) {
  14589. return Put(path, Headers(), body, content_type, progress);
  14590. }
  14591. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14592. return Put(path, Headers(), params);
  14593. }
  14594. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14595. ContentProvider content_provider,
  14596. const std::string &content_type,
  14597. UploadProgress progress) {
  14598. return Put(path, Headers(), content_length, std::move(content_provider),
  14599. content_type, progress);
  14600. }
  14601. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14602. ContentProvider content_provider,
  14603. const std::string &content_type,
  14604. ContentReceiver content_receiver,
  14605. UploadProgress progress) {
  14606. return Put(path, Headers(), content_length, std::move(content_provider),
  14607. content_type, std::move(content_receiver), progress);
  14608. }
  14609. inline Result ClientImpl::Put(const std::string &path,
  14610. ContentProviderWithoutLength content_provider,
  14611. const std::string &content_type,
  14612. UploadProgress progress) {
  14613. return Put(path, Headers(), std::move(content_provider), content_type,
  14614. progress);
  14615. }
  14616. inline Result ClientImpl::Put(const std::string &path,
  14617. ContentProviderWithoutLength content_provider,
  14618. const std::string &content_type,
  14619. ContentReceiver content_receiver,
  14620. UploadProgress progress) {
  14621. return Put(path, Headers(), std::move(content_provider), content_type,
  14622. std::move(content_receiver), progress);
  14623. }
  14624. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14625. const Params &params) {
  14626. auto query = detail::params_to_query_str(params);
  14627. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14628. }
  14629. inline Result ClientImpl::Put(const std::string &path,
  14630. const UploadFormDataItems &items,
  14631. UploadProgress progress) {
  14632. return Put(path, Headers(), items, progress);
  14633. }
  14634. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14635. const UploadFormDataItems &items,
  14636. UploadProgress progress) {
  14637. const auto &boundary = detail::make_multipart_data_boundary();
  14638. const auto &content_type =
  14639. detail::serialize_multipart_formdata_get_content_type(boundary);
  14640. auto content_length = detail::get_multipart_content_length(items, boundary);
  14641. return Put(path, headers, content_length,
  14642. detail::make_multipart_content_provider(items, boundary),
  14643. content_type, progress);
  14644. }
  14645. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14646. const UploadFormDataItems &items,
  14647. const std::string &boundary,
  14648. UploadProgress progress) {
  14649. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14650. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14651. }
  14652. const auto &content_type =
  14653. detail::serialize_multipart_formdata_get_content_type(boundary);
  14654. auto content_length = detail::get_multipart_content_length(items, boundary);
  14655. return Put(path, headers, content_length,
  14656. detail::make_multipart_content_provider(items, boundary),
  14657. content_type, progress);
  14658. }
  14659. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14660. const char *body, size_t content_length,
  14661. const std::string &content_type,
  14662. UploadProgress progress) {
  14663. return send_with_content_provider_and_receiver(
  14664. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14665. content_type, nullptr, progress);
  14666. }
  14667. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14668. const std::string &body,
  14669. const std::string &content_type,
  14670. UploadProgress progress) {
  14671. return send_with_content_provider_and_receiver(
  14672. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14673. content_type, nullptr, progress);
  14674. }
  14675. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14676. size_t content_length,
  14677. ContentProvider content_provider,
  14678. const std::string &content_type,
  14679. UploadProgress progress) {
  14680. return send_with_content_provider_and_receiver(
  14681. "PUT", path, headers, nullptr, content_length,
  14682. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14683. }
  14684. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14685. size_t content_length,
  14686. ContentProvider content_provider,
  14687. const std::string &content_type,
  14688. ContentReceiver content_receiver,
  14689. UploadProgress progress) {
  14690. return send_with_content_provider_and_receiver(
  14691. "PUT", path, headers, nullptr, content_length,
  14692. std::move(content_provider), nullptr, content_type,
  14693. std::move(content_receiver), progress);
  14694. }
  14695. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14696. ContentProviderWithoutLength content_provider,
  14697. const std::string &content_type,
  14698. UploadProgress progress) {
  14699. return send_with_content_provider_and_receiver(
  14700. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14701. content_type, nullptr, progress);
  14702. }
  14703. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14704. ContentProviderWithoutLength content_provider,
  14705. const std::string &content_type,
  14706. ContentReceiver content_receiver,
  14707. UploadProgress progress) {
  14708. return send_with_content_provider_and_receiver(
  14709. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14710. content_type, std::move(content_receiver), progress);
  14711. }
  14712. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14713. const UploadFormDataItems &items,
  14714. const FormDataProviderItems &provider_items,
  14715. UploadProgress progress) {
  14716. const auto &boundary = detail::make_multipart_data_boundary();
  14717. const auto &content_type =
  14718. detail::serialize_multipart_formdata_get_content_type(boundary);
  14719. return send_with_content_provider_and_receiver(
  14720. "PUT", path, headers, nullptr, 0, nullptr,
  14721. get_multipart_content_provider(boundary, items, provider_items),
  14722. content_type, nullptr, progress);
  14723. }
  14724. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14725. const std::string &body,
  14726. const std::string &content_type,
  14727. ContentReceiver content_receiver,
  14728. DownloadProgress progress) {
  14729. Request req;
  14730. req.method = "PUT";
  14731. req.path = path;
  14732. req.headers = headers;
  14733. req.body = body;
  14734. req.content_receiver =
  14735. [content_receiver](const char *data, size_t data_length,
  14736. size_t /*offset*/, size_t /*total_length*/) {
  14737. return content_receiver(data, data_length);
  14738. };
  14739. req.download_progress = std::move(progress);
  14740. if (max_timeout_msec_ > 0) {
  14741. req.start_time_ = std::chrono::steady_clock::now();
  14742. }
  14743. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14744. return send_(std::move(req));
  14745. }
  14746. inline Result ClientImpl::Patch(const std::string &path) {
  14747. return Patch(path, std::string(), std::string());
  14748. }
  14749. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14750. UploadProgress progress) {
  14751. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14752. }
  14753. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14754. size_t content_length,
  14755. const std::string &content_type,
  14756. UploadProgress progress) {
  14757. return Patch(path, Headers(), body, content_length, content_type, progress);
  14758. }
  14759. inline Result ClientImpl::Patch(const std::string &path,
  14760. const std::string &body,
  14761. const std::string &content_type,
  14762. UploadProgress progress) {
  14763. return Patch(path, Headers(), body, content_type, progress);
  14764. }
  14765. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14766. return Patch(path, Headers(), params);
  14767. }
  14768. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14769. ContentProvider content_provider,
  14770. const std::string &content_type,
  14771. UploadProgress progress) {
  14772. return Patch(path, Headers(), content_length, std::move(content_provider),
  14773. content_type, progress);
  14774. }
  14775. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14776. ContentProvider content_provider,
  14777. const std::string &content_type,
  14778. ContentReceiver content_receiver,
  14779. UploadProgress progress) {
  14780. return Patch(path, Headers(), content_length, std::move(content_provider),
  14781. content_type, std::move(content_receiver), progress);
  14782. }
  14783. inline Result ClientImpl::Patch(const std::string &path,
  14784. ContentProviderWithoutLength content_provider,
  14785. const std::string &content_type,
  14786. UploadProgress progress) {
  14787. return Patch(path, Headers(), std::move(content_provider), content_type,
  14788. progress);
  14789. }
  14790. inline Result ClientImpl::Patch(const std::string &path,
  14791. ContentProviderWithoutLength content_provider,
  14792. const std::string &content_type,
  14793. ContentReceiver content_receiver,
  14794. UploadProgress progress) {
  14795. return Patch(path, Headers(), std::move(content_provider), content_type,
  14796. std::move(content_receiver), progress);
  14797. }
  14798. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14799. const Params &params) {
  14800. auto query = detail::params_to_query_str(params);
  14801. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14802. }
  14803. inline Result ClientImpl::Patch(const std::string &path,
  14804. const UploadFormDataItems &items,
  14805. UploadProgress progress) {
  14806. return Patch(path, Headers(), items, progress);
  14807. }
  14808. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14809. const UploadFormDataItems &items,
  14810. UploadProgress progress) {
  14811. const auto &boundary = detail::make_multipart_data_boundary();
  14812. const auto &content_type =
  14813. detail::serialize_multipart_formdata_get_content_type(boundary);
  14814. auto content_length = detail::get_multipart_content_length(items, boundary);
  14815. return Patch(path, headers, content_length,
  14816. detail::make_multipart_content_provider(items, boundary),
  14817. content_type, progress);
  14818. }
  14819. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14820. const UploadFormDataItems &items,
  14821. const std::string &boundary,
  14822. UploadProgress progress) {
  14823. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14824. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14825. }
  14826. const auto &content_type =
  14827. detail::serialize_multipart_formdata_get_content_type(boundary);
  14828. auto content_length = detail::get_multipart_content_length(items, boundary);
  14829. return Patch(path, headers, content_length,
  14830. detail::make_multipart_content_provider(items, boundary),
  14831. content_type, progress);
  14832. }
  14833. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14834. const char *body, size_t content_length,
  14835. const std::string &content_type,
  14836. UploadProgress progress) {
  14837. return send_with_content_provider_and_receiver(
  14838. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14839. content_type, nullptr, progress);
  14840. }
  14841. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14842. const std::string &body,
  14843. const std::string &content_type,
  14844. UploadProgress progress) {
  14845. return send_with_content_provider_and_receiver(
  14846. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14847. content_type, nullptr, progress);
  14848. }
  14849. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14850. size_t content_length,
  14851. ContentProvider content_provider,
  14852. const std::string &content_type,
  14853. UploadProgress progress) {
  14854. return send_with_content_provider_and_receiver(
  14855. "PATCH", path, headers, nullptr, content_length,
  14856. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14857. }
  14858. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14859. size_t content_length,
  14860. ContentProvider content_provider,
  14861. const std::string &content_type,
  14862. ContentReceiver content_receiver,
  14863. UploadProgress progress) {
  14864. return send_with_content_provider_and_receiver(
  14865. "PATCH", path, headers, nullptr, content_length,
  14866. std::move(content_provider), nullptr, content_type,
  14867. std::move(content_receiver), progress);
  14868. }
  14869. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14870. ContentProviderWithoutLength content_provider,
  14871. const std::string &content_type,
  14872. UploadProgress progress) {
  14873. return send_with_content_provider_and_receiver(
  14874. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14875. content_type, nullptr, progress);
  14876. }
  14877. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14878. ContentProviderWithoutLength content_provider,
  14879. const std::string &content_type,
  14880. ContentReceiver content_receiver,
  14881. UploadProgress progress) {
  14882. return send_with_content_provider_and_receiver(
  14883. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14884. content_type, std::move(content_receiver), progress);
  14885. }
  14886. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14887. const UploadFormDataItems &items,
  14888. const FormDataProviderItems &provider_items,
  14889. UploadProgress progress) {
  14890. const auto &boundary = detail::make_multipart_data_boundary();
  14891. const auto &content_type =
  14892. detail::serialize_multipart_formdata_get_content_type(boundary);
  14893. return send_with_content_provider_and_receiver(
  14894. "PATCH", path, headers, nullptr, 0, nullptr,
  14895. get_multipart_content_provider(boundary, items, provider_items),
  14896. content_type, nullptr, progress);
  14897. }
  14898. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14899. const std::string &body,
  14900. const std::string &content_type,
  14901. ContentReceiver content_receiver,
  14902. DownloadProgress progress) {
  14903. Request req;
  14904. req.method = "PATCH";
  14905. req.path = path;
  14906. req.headers = headers;
  14907. req.body = body;
  14908. req.content_receiver =
  14909. [content_receiver](const char *data, size_t data_length,
  14910. size_t /*offset*/, size_t /*total_length*/) {
  14911. return content_receiver(data, data_length);
  14912. };
  14913. req.download_progress = std::move(progress);
  14914. if (max_timeout_msec_ > 0) {
  14915. req.start_time_ = std::chrono::steady_clock::now();
  14916. }
  14917. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14918. return send_(std::move(req));
  14919. }
  14920. inline Result ClientImpl::Delete(const std::string &path,
  14921. DownloadProgress progress) {
  14922. return Delete(path, Headers(), std::string(), std::string(), progress);
  14923. }
  14924. inline Result ClientImpl::Delete(const std::string &path,
  14925. const Headers &headers,
  14926. DownloadProgress progress) {
  14927. return Delete(path, headers, std::string(), std::string(), progress);
  14928. }
  14929. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14930. size_t content_length,
  14931. const std::string &content_type,
  14932. DownloadProgress progress) {
  14933. return Delete(path, Headers(), body, content_length, content_type, progress);
  14934. }
  14935. inline Result ClientImpl::Delete(const std::string &path,
  14936. const std::string &body,
  14937. const std::string &content_type,
  14938. DownloadProgress progress) {
  14939. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14940. progress);
  14941. }
  14942. inline Result ClientImpl::Delete(const std::string &path,
  14943. const Headers &headers,
  14944. const std::string &body,
  14945. const std::string &content_type,
  14946. DownloadProgress progress) {
  14947. return Delete(path, headers, body.data(), body.size(), content_type,
  14948. progress);
  14949. }
  14950. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14951. DownloadProgress progress) {
  14952. return Delete(path, Headers(), params, progress);
  14953. }
  14954. inline Result ClientImpl::Delete(const std::string &path,
  14955. const Headers &headers, const Params &params,
  14956. DownloadProgress progress) {
  14957. auto query = detail::params_to_query_str(params);
  14958. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14959. progress);
  14960. }
  14961. inline Result ClientImpl::Delete(const std::string &path,
  14962. const Headers &headers, const char *body,
  14963. size_t content_length,
  14964. const std::string &content_type,
  14965. DownloadProgress progress) {
  14966. Request req;
  14967. req.method = "DELETE";
  14968. req.headers = headers;
  14969. req.path = path;
  14970. req.download_progress = std::move(progress);
  14971. if (max_timeout_msec_ > 0) {
  14972. req.start_time_ = std::chrono::steady_clock::now();
  14973. }
  14974. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14975. req.body.assign(body, content_length);
  14976. return send_(std::move(req));
  14977. }
  14978. inline Result ClientImpl::Options(const std::string &path) {
  14979. return Options(path, Headers());
  14980. }
  14981. inline Result ClientImpl::Options(const std::string &path,
  14982. const Headers &headers) {
  14983. Request req;
  14984. req.method = "OPTIONS";
  14985. req.headers = headers;
  14986. req.path = path;
  14987. if (max_timeout_msec_ > 0) {
  14988. req.start_time_ = std::chrono::steady_clock::now();
  14989. }
  14990. return send_(std::move(req));
  14991. }
  14992. inline void ClientImpl::stop() {
  14993. std::lock_guard<std::mutex> guard(socket_mutex_);
  14994. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14995. // do is to shutdown_socket, so that threads using this socket suddenly
  14996. // discover they can't read/write any more and error out. Everything else
  14997. // (closing the socket, shutting ssl down) is unsafe because these actions
  14998. // are not thread-safe.
  14999. if (socket_requests_in_flight_ > 0) {
  15000. shutdown_socket(socket_);
  15001. // Aside from that, we set a flag for the socket to be closed when we're
  15002. // done.
  15003. socket_should_be_closed_when_request_is_done_ = true;
  15004. return;
  15005. }
  15006. disconnect(/*gracefully=*/true);
  15007. }
  15008. inline std::string ClientImpl::host() const { return host_; }
  15009. inline int ClientImpl::port() const { return port_; }
  15010. inline size_t ClientImpl::is_socket_open() const {
  15011. std::lock_guard<std::mutex> guard(socket_mutex_);
  15012. return socket_.is_open();
  15013. }
  15014. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15015. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15016. connection_timeout_sec_ = sec;
  15017. connection_timeout_usec_ = usec;
  15018. }
  15019. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15020. read_timeout_sec_ = sec;
  15021. read_timeout_usec_ = usec;
  15022. }
  15023. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15024. write_timeout_sec_ = sec;
  15025. write_timeout_usec_ = usec;
  15026. }
  15027. inline void ClientImpl::set_max_timeout(time_t msec) {
  15028. max_timeout_msec_ = msec;
  15029. }
  15030. inline void ClientImpl::set_basic_auth(const std::string &username,
  15031. const std::string &password) {
  15032. basic_auth_username_ = username;
  15033. basic_auth_password_ = password;
  15034. }
  15035. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15036. bearer_token_auth_token_ = token;
  15037. }
  15038. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15039. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15040. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15041. inline void
  15042. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15043. addr_map_ = std::move(addr_map);
  15044. }
  15045. inline void ClientImpl::set_default_headers(Headers headers) {
  15046. default_headers_ = std::move(headers);
  15047. }
  15048. inline void ClientImpl::set_header_writer(
  15049. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15050. header_writer_ = writer;
  15051. }
  15052. inline void ClientImpl::set_address_family(int family) {
  15053. address_family_ = family;
  15054. }
  15055. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15056. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15057. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15058. socket_options_ = std::move(socket_options);
  15059. }
  15060. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15061. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15062. inline void ClientImpl::set_payload_max_length(size_t length) {
  15063. payload_max_length_ = length;
  15064. has_payload_max_length_ = true;
  15065. }
  15066. inline void ClientImpl::set_interface(const std::string &intf) {
  15067. interface_ = intf;
  15068. }
  15069. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15070. proxy_host_ = host;
  15071. proxy_port_ = port;
  15072. std::lock_guard<std::mutex> guard(socket_mutex_);
  15073. disconnect(/*gracefully=*/true);
  15074. }
  15075. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15076. const std::string &password) {
  15077. proxy_basic_auth_username_ = username;
  15078. proxy_basic_auth_password_ = password;
  15079. }
  15080. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15081. proxy_bearer_token_auth_token_ = token;
  15082. }
  15083. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15084. std::vector<detail::NoProxyEntry> parsed;
  15085. parsed.reserve(patterns.size());
  15086. for (const auto &p : patterns) {
  15087. auto trimmed = detail::trim_copy(p);
  15088. if (trimmed.empty()) { continue; }
  15089. detail::NoProxyEntry entry;
  15090. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  15091. parsed.push_back(std::move(entry));
  15092. }
  15093. }
  15094. no_proxy_entries_ = std::move(parsed);
  15095. std::lock_guard<std::mutex> guard(socket_mutex_);
  15096. disconnect(/*gracefully=*/true);
  15097. }
  15098. #ifdef CPPHTTPLIB_SSL_ENABLED
  15099. inline void ClientImpl::set_digest_auth(const std::string &username,
  15100. const std::string &password) {
  15101. digest_auth_username_ = username;
  15102. digest_auth_password_ = password;
  15103. }
  15104. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15105. const std::string &ca_cert_dir_path) {
  15106. ca_cert_file_path_ = ca_cert_file_path;
  15107. ca_cert_dir_path_ = ca_cert_dir_path;
  15108. }
  15109. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15110. const std::string &password) {
  15111. proxy_digest_auth_username_ = username;
  15112. proxy_digest_auth_password_ = password;
  15113. }
  15114. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15115. server_certificate_verification_ = enabled;
  15116. }
  15117. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15118. server_hostname_verification_ = enabled;
  15119. }
  15120. inline void ClientImpl::enable_system_ca(bool enabled) {
  15121. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15122. }
  15123. #endif
  15124. inline void ClientImpl::set_logger(Logger logger) {
  15125. logger_ = std::move(logger);
  15126. }
  15127. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15128. error_logger_ = std::move(error_logger);
  15129. }
  15130. /*
  15131. * SSL/TLS Common Implementation
  15132. */
  15133. inline ClientConnection::~ClientConnection() {
  15134. #ifdef CPPHTTPLIB_SSL_ENABLED
  15135. if (session) {
  15136. tls::shutdown(session, true);
  15137. tls::free_session(session);
  15138. session = nullptr;
  15139. }
  15140. #endif
  15141. if (sock != INVALID_SOCKET) {
  15142. detail::close_socket(sock);
  15143. sock = INVALID_SOCKET;
  15144. }
  15145. }
  15146. // Universal client implementation
  15147. inline Client::Client(const std::string &scheme_host_port)
  15148. : Client(scheme_host_port, std::string(), std::string()) {}
  15149. inline Client::Client(const std::string &scheme_host_port,
  15150. const std::string &client_cert_path,
  15151. const std::string &client_key_path) {
  15152. detail::UrlComponents uc;
  15153. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15154. auto &scheme = uc.scheme;
  15155. #ifdef CPPHTTPLIB_SSL_ENABLED
  15156. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15157. #else
  15158. if (!scheme.empty() && scheme != "http") {
  15159. #endif
  15160. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15161. std::string msg = "'" + scheme + "' scheme is not supported.";
  15162. throw std::invalid_argument(msg);
  15163. #endif
  15164. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15165. return;
  15166. }
  15167. auto is_ssl = scheme == "https";
  15168. auto host = std::move(uc.host);
  15169. auto port = is_ssl ? 443 : 80;
  15170. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15171. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15172. return;
  15173. }
  15174. if (is_ssl) {
  15175. #ifdef CPPHTTPLIB_SSL_ENABLED
  15176. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15177. client_key_path);
  15178. is_ssl_ = is_ssl;
  15179. #endif
  15180. } else {
  15181. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15182. client_key_path);
  15183. }
  15184. } else {
  15185. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15186. // if port param below changes.
  15187. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15188. client_cert_path, client_key_path);
  15189. }
  15190. }
  15191. inline Client::Client(const std::string &host, int port)
  15192. : Client(host, port, std::string(), std::string()) {}
  15193. inline Client::Client(const std::string &host, int port,
  15194. const std::string &client_cert_path,
  15195. const std::string &client_key_path)
  15196. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15197. client_key_path)) {}
  15198. inline Client::~Client() = default;
  15199. inline bool Client::is_valid() const {
  15200. return cli_ != nullptr && cli_->is_valid();
  15201. }
  15202. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15203. return cli_->Get(path, std::move(progress));
  15204. }
  15205. inline Result Client::Get(const std::string &path, const Headers &headers,
  15206. DownloadProgress progress) {
  15207. return cli_->Get(path, headers, std::move(progress));
  15208. }
  15209. inline Result Client::Get(const std::string &path,
  15210. ContentReceiver content_receiver,
  15211. DownloadProgress progress) {
  15212. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15213. }
  15214. inline Result Client::Get(const std::string &path, const Headers &headers,
  15215. ContentReceiver content_receiver,
  15216. DownloadProgress progress) {
  15217. return cli_->Get(path, headers, std::move(content_receiver),
  15218. std::move(progress));
  15219. }
  15220. inline Result Client::Get(const std::string &path,
  15221. ResponseHandler response_handler,
  15222. ContentReceiver content_receiver,
  15223. DownloadProgress progress) {
  15224. return cli_->Get(path, std::move(response_handler),
  15225. std::move(content_receiver), std::move(progress));
  15226. }
  15227. inline Result Client::Get(const std::string &path, const Headers &headers,
  15228. ResponseHandler response_handler,
  15229. ContentReceiver content_receiver,
  15230. DownloadProgress progress) {
  15231. return cli_->Get(path, headers, std::move(response_handler),
  15232. std::move(content_receiver), std::move(progress));
  15233. }
  15234. inline Result Client::Get(const std::string &path, const Params &params,
  15235. DownloadProgress progress) {
  15236. return cli_->Get(path, params, std::move(progress));
  15237. }
  15238. inline Result Client::Get(const std::string &path, const Params &params,
  15239. const Headers &headers, DownloadProgress progress) {
  15240. return cli_->Get(path, params, headers, std::move(progress));
  15241. }
  15242. inline Result Client::Get(const std::string &path, const Params &params,
  15243. const Headers &headers,
  15244. ContentReceiver content_receiver,
  15245. DownloadProgress progress) {
  15246. return cli_->Get(path, params, headers, std::move(content_receiver),
  15247. std::move(progress));
  15248. }
  15249. inline Result Client::Get(const std::string &path, const Params &params,
  15250. const Headers &headers,
  15251. ResponseHandler response_handler,
  15252. ContentReceiver content_receiver,
  15253. DownloadProgress progress) {
  15254. return cli_->Get(path, params, headers, std::move(response_handler),
  15255. std::move(content_receiver), std::move(progress));
  15256. }
  15257. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15258. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15259. return cli_->Head(path, headers);
  15260. }
  15261. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15262. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15263. return cli_->Post(path, headers);
  15264. }
  15265. inline Result Client::Post(const std::string &path, const char *body,
  15266. size_t content_length,
  15267. const std::string &content_type,
  15268. UploadProgress progress) {
  15269. return cli_->Post(path, body, content_length, content_type, progress);
  15270. }
  15271. inline Result Client::Post(const std::string &path, const Headers &headers,
  15272. const char *body, size_t content_length,
  15273. const std::string &content_type,
  15274. UploadProgress progress) {
  15275. return cli_->Post(path, headers, body, content_length, content_type,
  15276. progress);
  15277. }
  15278. inline Result Client::Post(const std::string &path, const std::string &body,
  15279. const std::string &content_type,
  15280. UploadProgress progress) {
  15281. return cli_->Post(path, body, content_type, progress);
  15282. }
  15283. inline Result Client::Post(const std::string &path, const Headers &headers,
  15284. const std::string &body,
  15285. const std::string &content_type,
  15286. UploadProgress progress) {
  15287. return cli_->Post(path, headers, body, content_type, progress);
  15288. }
  15289. inline Result Client::Post(const std::string &path, size_t content_length,
  15290. ContentProvider content_provider,
  15291. const std::string &content_type,
  15292. UploadProgress progress) {
  15293. return cli_->Post(path, content_length, std::move(content_provider),
  15294. content_type, progress);
  15295. }
  15296. inline Result Client::Post(const std::string &path, size_t content_length,
  15297. ContentProvider content_provider,
  15298. const std::string &content_type,
  15299. ContentReceiver content_receiver,
  15300. UploadProgress progress) {
  15301. return cli_->Post(path, content_length, std::move(content_provider),
  15302. content_type, std::move(content_receiver), progress);
  15303. }
  15304. inline Result Client::Post(const std::string &path,
  15305. ContentProviderWithoutLength content_provider,
  15306. const std::string &content_type,
  15307. UploadProgress progress) {
  15308. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15309. }
  15310. inline Result Client::Post(const std::string &path,
  15311. ContentProviderWithoutLength content_provider,
  15312. const std::string &content_type,
  15313. ContentReceiver content_receiver,
  15314. UploadProgress progress) {
  15315. return cli_->Post(path, std::move(content_provider), content_type,
  15316. std::move(content_receiver), progress);
  15317. }
  15318. inline Result Client::Post(const std::string &path, const Headers &headers,
  15319. size_t content_length,
  15320. ContentProvider content_provider,
  15321. const std::string &content_type,
  15322. UploadProgress progress) {
  15323. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15324. content_type, progress);
  15325. }
  15326. inline Result Client::Post(const std::string &path, const Headers &headers,
  15327. size_t content_length,
  15328. ContentProvider content_provider,
  15329. const std::string &content_type,
  15330. ContentReceiver content_receiver,
  15331. DownloadProgress progress) {
  15332. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15333. content_type, std::move(content_receiver), progress);
  15334. }
  15335. inline Result Client::Post(const std::string &path, const Headers &headers,
  15336. ContentProviderWithoutLength content_provider,
  15337. const std::string &content_type,
  15338. UploadProgress progress) {
  15339. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15340. progress);
  15341. }
  15342. inline Result Client::Post(const std::string &path, const Headers &headers,
  15343. ContentProviderWithoutLength content_provider,
  15344. const std::string &content_type,
  15345. ContentReceiver content_receiver,
  15346. DownloadProgress progress) {
  15347. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15348. std::move(content_receiver), progress);
  15349. }
  15350. inline Result Client::Post(const std::string &path, const Params &params) {
  15351. return cli_->Post(path, params);
  15352. }
  15353. inline Result Client::Post(const std::string &path, const Headers &headers,
  15354. const Params &params) {
  15355. return cli_->Post(path, headers, params);
  15356. }
  15357. inline Result Client::Post(const std::string &path,
  15358. const UploadFormDataItems &items,
  15359. UploadProgress progress) {
  15360. return cli_->Post(path, items, progress);
  15361. }
  15362. inline Result Client::Post(const std::string &path, const Headers &headers,
  15363. const UploadFormDataItems &items,
  15364. UploadProgress progress) {
  15365. return cli_->Post(path, headers, items, progress);
  15366. }
  15367. inline Result Client::Post(const std::string &path, const Headers &headers,
  15368. const UploadFormDataItems &items,
  15369. const std::string &boundary,
  15370. UploadProgress progress) {
  15371. return cli_->Post(path, headers, items, boundary, progress);
  15372. }
  15373. inline Result Client::Post(const std::string &path, const Headers &headers,
  15374. const UploadFormDataItems &items,
  15375. const FormDataProviderItems &provider_items,
  15376. UploadProgress progress) {
  15377. return cli_->Post(path, headers, items, provider_items, progress);
  15378. }
  15379. inline Result Client::Post(const std::string &path, const Headers &headers,
  15380. const std::string &body,
  15381. const std::string &content_type,
  15382. ContentReceiver content_receiver,
  15383. DownloadProgress progress) {
  15384. return cli_->Post(path, headers, body, content_type,
  15385. std::move(content_receiver), progress);
  15386. }
  15387. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15388. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15389. return cli_->Put(path, headers);
  15390. }
  15391. inline Result Client::Put(const std::string &path, const char *body,
  15392. size_t content_length,
  15393. const std::string &content_type,
  15394. UploadProgress progress) {
  15395. return cli_->Put(path, body, content_length, content_type, progress);
  15396. }
  15397. inline Result Client::Put(const std::string &path, const Headers &headers,
  15398. const char *body, size_t content_length,
  15399. const std::string &content_type,
  15400. UploadProgress progress) {
  15401. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15402. }
  15403. inline Result Client::Put(const std::string &path, const std::string &body,
  15404. const std::string &content_type,
  15405. UploadProgress progress) {
  15406. return cli_->Put(path, body, content_type, progress);
  15407. }
  15408. inline Result Client::Put(const std::string &path, const Headers &headers,
  15409. const std::string &body,
  15410. const std::string &content_type,
  15411. UploadProgress progress) {
  15412. return cli_->Put(path, headers, body, content_type, progress);
  15413. }
  15414. inline Result Client::Put(const std::string &path, size_t content_length,
  15415. ContentProvider content_provider,
  15416. const std::string &content_type,
  15417. UploadProgress progress) {
  15418. return cli_->Put(path, content_length, std::move(content_provider),
  15419. content_type, progress);
  15420. }
  15421. inline Result Client::Put(const std::string &path, size_t content_length,
  15422. ContentProvider content_provider,
  15423. const std::string &content_type,
  15424. ContentReceiver content_receiver,
  15425. UploadProgress progress) {
  15426. return cli_->Put(path, content_length, std::move(content_provider),
  15427. content_type, std::move(content_receiver), progress);
  15428. }
  15429. inline Result Client::Put(const std::string &path,
  15430. ContentProviderWithoutLength content_provider,
  15431. const std::string &content_type,
  15432. UploadProgress progress) {
  15433. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15434. }
  15435. inline Result Client::Put(const std::string &path,
  15436. ContentProviderWithoutLength content_provider,
  15437. const std::string &content_type,
  15438. ContentReceiver content_receiver,
  15439. UploadProgress progress) {
  15440. return cli_->Put(path, std::move(content_provider), content_type,
  15441. std::move(content_receiver), progress);
  15442. }
  15443. inline Result Client::Put(const std::string &path, const Headers &headers,
  15444. size_t content_length,
  15445. ContentProvider content_provider,
  15446. const std::string &content_type,
  15447. UploadProgress progress) {
  15448. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15449. content_type, progress);
  15450. }
  15451. inline Result Client::Put(const std::string &path, const Headers &headers,
  15452. size_t content_length,
  15453. ContentProvider content_provider,
  15454. const std::string &content_type,
  15455. ContentReceiver content_receiver,
  15456. UploadProgress progress) {
  15457. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15458. content_type, std::move(content_receiver), progress);
  15459. }
  15460. inline Result Client::Put(const std::string &path, const Headers &headers,
  15461. ContentProviderWithoutLength content_provider,
  15462. const std::string &content_type,
  15463. UploadProgress progress) {
  15464. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15465. progress);
  15466. }
  15467. inline Result Client::Put(const std::string &path, const Headers &headers,
  15468. ContentProviderWithoutLength content_provider,
  15469. const std::string &content_type,
  15470. ContentReceiver content_receiver,
  15471. UploadProgress progress) {
  15472. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15473. std::move(content_receiver), progress);
  15474. }
  15475. inline Result Client::Put(const std::string &path, const Params &params) {
  15476. return cli_->Put(path, params);
  15477. }
  15478. inline Result Client::Put(const std::string &path, const Headers &headers,
  15479. const Params &params) {
  15480. return cli_->Put(path, headers, params);
  15481. }
  15482. inline Result Client::Put(const std::string &path,
  15483. const UploadFormDataItems &items,
  15484. UploadProgress progress) {
  15485. return cli_->Put(path, items, progress);
  15486. }
  15487. inline Result Client::Put(const std::string &path, const Headers &headers,
  15488. const UploadFormDataItems &items,
  15489. UploadProgress progress) {
  15490. return cli_->Put(path, headers, items, progress);
  15491. }
  15492. inline Result Client::Put(const std::string &path, const Headers &headers,
  15493. const UploadFormDataItems &items,
  15494. const std::string &boundary,
  15495. UploadProgress progress) {
  15496. return cli_->Put(path, headers, items, boundary, progress);
  15497. }
  15498. inline Result Client::Put(const std::string &path, const Headers &headers,
  15499. const UploadFormDataItems &items,
  15500. const FormDataProviderItems &provider_items,
  15501. UploadProgress progress) {
  15502. return cli_->Put(path, headers, items, provider_items, progress);
  15503. }
  15504. inline Result Client::Put(const std::string &path, const Headers &headers,
  15505. const std::string &body,
  15506. const std::string &content_type,
  15507. ContentReceiver content_receiver,
  15508. DownloadProgress progress) {
  15509. return cli_->Put(path, headers, body, content_type, content_receiver,
  15510. progress);
  15511. }
  15512. inline Result Client::Patch(const std::string &path) {
  15513. return cli_->Patch(path);
  15514. }
  15515. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15516. return cli_->Patch(path, headers);
  15517. }
  15518. inline Result Client::Patch(const std::string &path, const char *body,
  15519. size_t content_length,
  15520. const std::string &content_type,
  15521. UploadProgress progress) {
  15522. return cli_->Patch(path, body, content_length, content_type, progress);
  15523. }
  15524. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15525. const char *body, size_t content_length,
  15526. const std::string &content_type,
  15527. UploadProgress progress) {
  15528. return cli_->Patch(path, headers, body, content_length, content_type,
  15529. progress);
  15530. }
  15531. inline Result Client::Patch(const std::string &path, const std::string &body,
  15532. const std::string &content_type,
  15533. UploadProgress progress) {
  15534. return cli_->Patch(path, body, content_type, progress);
  15535. }
  15536. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15537. const std::string &body,
  15538. const std::string &content_type,
  15539. UploadProgress progress) {
  15540. return cli_->Patch(path, headers, body, content_type, progress);
  15541. }
  15542. inline Result Client::Patch(const std::string &path, size_t content_length,
  15543. ContentProvider content_provider,
  15544. const std::string &content_type,
  15545. UploadProgress progress) {
  15546. return cli_->Patch(path, content_length, std::move(content_provider),
  15547. content_type, progress);
  15548. }
  15549. inline Result Client::Patch(const std::string &path, size_t content_length,
  15550. ContentProvider content_provider,
  15551. const std::string &content_type,
  15552. ContentReceiver content_receiver,
  15553. UploadProgress progress) {
  15554. return cli_->Patch(path, content_length, std::move(content_provider),
  15555. content_type, std::move(content_receiver), progress);
  15556. }
  15557. inline Result Client::Patch(const std::string &path,
  15558. ContentProviderWithoutLength content_provider,
  15559. const std::string &content_type,
  15560. UploadProgress progress) {
  15561. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15562. }
  15563. inline Result Client::Patch(const std::string &path,
  15564. ContentProviderWithoutLength content_provider,
  15565. const std::string &content_type,
  15566. ContentReceiver content_receiver,
  15567. UploadProgress progress) {
  15568. return cli_->Patch(path, std::move(content_provider), content_type,
  15569. std::move(content_receiver), progress);
  15570. }
  15571. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15572. size_t content_length,
  15573. ContentProvider content_provider,
  15574. const std::string &content_type,
  15575. UploadProgress progress) {
  15576. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15577. content_type, progress);
  15578. }
  15579. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15580. size_t content_length,
  15581. ContentProvider content_provider,
  15582. const std::string &content_type,
  15583. ContentReceiver content_receiver,
  15584. UploadProgress progress) {
  15585. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15586. content_type, std::move(content_receiver), progress);
  15587. }
  15588. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15589. ContentProviderWithoutLength content_provider,
  15590. const std::string &content_type,
  15591. UploadProgress progress) {
  15592. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15593. progress);
  15594. }
  15595. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15596. ContentProviderWithoutLength content_provider,
  15597. const std::string &content_type,
  15598. ContentReceiver content_receiver,
  15599. UploadProgress progress) {
  15600. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15601. std::move(content_receiver), progress);
  15602. }
  15603. inline Result Client::Patch(const std::string &path, const Params &params) {
  15604. return cli_->Patch(path, params);
  15605. }
  15606. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15607. const Params &params) {
  15608. return cli_->Patch(path, headers, params);
  15609. }
  15610. inline Result Client::Patch(const std::string &path,
  15611. const UploadFormDataItems &items,
  15612. UploadProgress progress) {
  15613. return cli_->Patch(path, items, progress);
  15614. }
  15615. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15616. const UploadFormDataItems &items,
  15617. UploadProgress progress) {
  15618. return cli_->Patch(path, headers, items, progress);
  15619. }
  15620. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15621. const UploadFormDataItems &items,
  15622. const std::string &boundary,
  15623. UploadProgress progress) {
  15624. return cli_->Patch(path, headers, items, boundary, progress);
  15625. }
  15626. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15627. const UploadFormDataItems &items,
  15628. const FormDataProviderItems &provider_items,
  15629. UploadProgress progress) {
  15630. return cli_->Patch(path, headers, items, provider_items, progress);
  15631. }
  15632. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15633. const std::string &body,
  15634. const std::string &content_type,
  15635. ContentReceiver content_receiver,
  15636. DownloadProgress progress) {
  15637. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15638. progress);
  15639. }
  15640. inline Result Client::Delete(const std::string &path,
  15641. DownloadProgress progress) {
  15642. return cli_->Delete(path, progress);
  15643. }
  15644. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15645. DownloadProgress progress) {
  15646. return cli_->Delete(path, headers, progress);
  15647. }
  15648. inline Result Client::Delete(const std::string &path, const char *body,
  15649. size_t content_length,
  15650. const std::string &content_type,
  15651. DownloadProgress progress) {
  15652. return cli_->Delete(path, body, content_length, content_type, progress);
  15653. }
  15654. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15655. const char *body, size_t content_length,
  15656. const std::string &content_type,
  15657. DownloadProgress progress) {
  15658. return cli_->Delete(path, headers, body, content_length, content_type,
  15659. progress);
  15660. }
  15661. inline Result Client::Delete(const std::string &path, const std::string &body,
  15662. const std::string &content_type,
  15663. DownloadProgress progress) {
  15664. return cli_->Delete(path, body, content_type, progress);
  15665. }
  15666. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15667. const std::string &body,
  15668. const std::string &content_type,
  15669. DownloadProgress progress) {
  15670. return cli_->Delete(path, headers, body, content_type, progress);
  15671. }
  15672. inline Result Client::Delete(const std::string &path, const Params &params,
  15673. DownloadProgress progress) {
  15674. return cli_->Delete(path, params, progress);
  15675. }
  15676. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15677. const Params &params, DownloadProgress progress) {
  15678. return cli_->Delete(path, headers, params, progress);
  15679. }
  15680. inline Result Client::Options(const std::string &path) {
  15681. return cli_->Options(path);
  15682. }
  15683. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15684. return cli_->Options(path, headers);
  15685. }
  15686. inline ClientImpl::StreamHandle
  15687. Client::open_stream(const std::string &method, const std::string &path,
  15688. const Params &params, const Headers &headers,
  15689. const std::string &body, const std::string &content_type) {
  15690. return cli_->open_stream(method, path, params, headers, body, content_type);
  15691. }
  15692. inline bool Client::send(Request &req, Response &res, Error &error) {
  15693. return cli_->send(req, res, error);
  15694. }
  15695. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15696. inline void Client::stop() { cli_->stop(); }
  15697. inline std::string Client::host() const { return cli_->host(); }
  15698. inline int Client::port() const { return cli_->port(); }
  15699. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15700. inline socket_t Client::socket() const { return cli_->socket(); }
  15701. inline void
  15702. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15703. cli_->set_hostname_addr_map(std::move(addr_map));
  15704. }
  15705. inline void Client::set_default_headers(Headers headers) {
  15706. cli_->set_default_headers(std::move(headers));
  15707. }
  15708. inline void Client::set_header_writer(
  15709. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15710. cli_->set_header_writer(writer);
  15711. }
  15712. inline void Client::set_address_family(int family) {
  15713. cli_->set_address_family(family);
  15714. }
  15715. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15716. inline void Client::set_socket_options(SocketOptions socket_options) {
  15717. cli_->set_socket_options(std::move(socket_options));
  15718. }
  15719. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15720. cli_->set_connection_timeout(sec, usec);
  15721. }
  15722. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15723. cli_->set_read_timeout(sec, usec);
  15724. }
  15725. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15726. cli_->set_write_timeout(sec, usec);
  15727. }
  15728. inline void Client::set_basic_auth(const std::string &username,
  15729. const std::string &password) {
  15730. cli_->set_basic_auth(username, password);
  15731. }
  15732. inline void Client::set_bearer_token_auth(const std::string &token) {
  15733. cli_->set_bearer_token_auth(token);
  15734. }
  15735. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15736. inline void Client::set_follow_location(bool on) {
  15737. cli_->set_follow_location(on);
  15738. }
  15739. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15740. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15741. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15742. inline void Client::set_payload_max_length(size_t length) {
  15743. cli_->set_payload_max_length(length);
  15744. }
  15745. inline void Client::set_interface(const std::string &intf) {
  15746. cli_->set_interface(intf);
  15747. }
  15748. inline void Client::set_proxy(const std::string &host, int port) {
  15749. cli_->set_proxy(host, port);
  15750. }
  15751. inline void Client::set_proxy_basic_auth(const std::string &username,
  15752. const std::string &password) {
  15753. cli_->set_proxy_basic_auth(username, password);
  15754. }
  15755. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15756. cli_->set_proxy_bearer_token_auth(token);
  15757. }
  15758. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15759. cli_->set_no_proxy(patterns);
  15760. }
  15761. inline void Client::set_logger(Logger logger) {
  15762. cli_->set_logger(std::move(logger));
  15763. }
  15764. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15765. cli_->set_error_logger(std::move(error_logger));
  15766. }
  15767. /*
  15768. * Group 6: SSL Server and Client implementation
  15769. */
  15770. #ifdef CPPHTTPLIB_SSL_ENABLED
  15771. // SSL HTTP server implementation
  15772. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15773. const char *client_ca_cert_file_path,
  15774. const char *client_ca_cert_dir_path,
  15775. const char *private_key_password) {
  15776. using namespace tls;
  15777. ctx_ = create_server_context();
  15778. if (!ctx_) { return; }
  15779. // Load server certificate and private key
  15780. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15781. private_key_password)) {
  15782. last_ssl_error_ = static_cast<int>(get_error());
  15783. free_context(ctx_);
  15784. ctx_ = nullptr;
  15785. return;
  15786. }
  15787. // Load client CA certificates for client authentication
  15788. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15789. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15790. client_ca_cert_dir_path)) {
  15791. last_ssl_error_ = static_cast<int>(get_error());
  15792. free_context(ctx_);
  15793. ctx_ = nullptr;
  15794. return;
  15795. }
  15796. // Enable client certificate verification
  15797. set_verify_client(ctx_, true);
  15798. }
  15799. }
  15800. inline SSLServer::SSLServer(const PemMemory &pem) {
  15801. using namespace tls;
  15802. ctx_ = create_server_context();
  15803. if (ctx_) {
  15804. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15805. pem.private_key_password)) {
  15806. last_ssl_error_ = static_cast<int>(get_error());
  15807. free_context(ctx_);
  15808. ctx_ = nullptr;
  15809. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15810. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15811. last_ssl_error_ = static_cast<int>(get_error());
  15812. free_context(ctx_);
  15813. ctx_ = nullptr;
  15814. } else {
  15815. set_verify_client(ctx_, true);
  15816. }
  15817. }
  15818. }
  15819. }
  15820. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15821. using namespace tls;
  15822. ctx_ = create_server_context();
  15823. if (ctx_) {
  15824. if (!setup_callback(ctx_)) {
  15825. free_context(ctx_);
  15826. ctx_ = nullptr;
  15827. }
  15828. }
  15829. }
  15830. inline SSLServer::~SSLServer() {
  15831. if (ctx_) { tls::free_context(ctx_); }
  15832. }
  15833. inline bool SSLServer::is_valid() const {
  15834. return ctx_ != nullptr && Server::is_valid();
  15835. }
  15836. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15837. using namespace tls;
  15838. session_t session = nullptr;
  15839. {
  15840. std::unique_lock<std::mutex> lock(ctx_mutex_);
  15841. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  15842. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15843. if (session) { handshakes_in_progress_++; }
  15844. }
  15845. if (!session) {
  15846. last_ssl_error_ = static_cast<int>(get_error());
  15847. detail::shutdown_socket(sock);
  15848. detail::close_socket(sock);
  15849. return false;
  15850. }
  15851. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15852. bool handshake_done = false;
  15853. bool ret = false;
  15854. bool websocket_upgraded = false;
  15855. auto cleanup = detail::scope_exit([&] {
  15856. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15857. free_session(session);
  15858. detail::shutdown_socket(sock);
  15859. detail::close_socket(sock);
  15860. });
  15861. // Perform TLS accept handshake with timeout
  15862. TlsError tls_err;
  15863. auto accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  15864. read_timeout_usec_, &tls_err);
  15865. {
  15866. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15867. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  15868. }
  15869. if (!accepted) {
  15870. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15871. // Map TlsError to legacy ssl_error for backward compatibility
  15872. if (tls_err.code == ErrorCode::WantRead) {
  15873. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15874. } else if (tls_err.code == ErrorCode::WantWrite) {
  15875. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15876. } else {
  15877. last_ssl_error_ = SSL_ERROR_SSL;
  15878. }
  15879. #else
  15880. last_ssl_error_ = static_cast<int>(get_error());
  15881. #endif
  15882. return false;
  15883. }
  15884. handshake_done = true;
  15885. std::string remote_addr;
  15886. int remote_port = 0;
  15887. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15888. std::string local_addr;
  15889. int local_port = 0;
  15890. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15891. ret = serve_guarded([&]() {
  15892. return detail::process_server_socket_ssl(
  15893. svr_sock_, session, sock, keep_alive_max_count_,
  15894. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15895. write_timeout_sec_, write_timeout_usec_,
  15896. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15897. return process_request(
  15898. strm, remote_addr, remote_port, local_addr, local_port,
  15899. close_connection, connection_closed,
  15900. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15901. });
  15902. });
  15903. return ret;
  15904. }
  15905. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15906. const char *key_pem,
  15907. const char *client_ca_pem,
  15908. const char *password) {
  15909. if (!ctx_) { return false; }
  15910. std::unique_lock<std::mutex> lock(ctx_mutex_);
  15911. updates_pending_++;
  15912. auto se = detail::scope_exit([&] {
  15913. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  15914. });
  15915. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  15916. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15917. return false;
  15918. }
  15919. if (client_ca_pem) {
  15920. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15921. }
  15922. return true;
  15923. }
  15924. // SSL HTTP client implementation
  15925. inline SSLClient::~SSLClient() {
  15926. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15927. // base function rather than the derived function once we get to the
  15928. // base class destructor, and won't free the SSL (causing a leak).
  15929. // This must happen before the context is freed below: some backends
  15930. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15931. // context, so freeing the context first leaves close_notify reading
  15932. // freed memory.
  15933. shutdown_ssl_impl(socket_, true);
  15934. if (ctx_) {
  15935. tls::free_context(ctx_);
  15936. ctx_ = nullptr;
  15937. }
  15938. }
  15939. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15940. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15941. shutdown_ssl_impl(socket, shutdown_gracefully);
  15942. }
  15943. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15944. bool shutdown_gracefully) {
  15945. if (socket.sock == INVALID_SOCKET) {
  15946. assert(socket.ssl == nullptr);
  15947. return;
  15948. }
  15949. if (socket.ssl) {
  15950. tls::shutdown(socket.ssl, shutdown_gracefully);
  15951. {
  15952. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15953. tls::free_session(socket.ssl);
  15954. }
  15955. socket.ssl = nullptr;
  15956. }
  15957. assert(socket.ssl == nullptr);
  15958. }
  15959. inline bool SSLClient::process_socket(
  15960. const Socket &socket,
  15961. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15962. std::function<bool(Stream &strm)> callback) {
  15963. assert(socket.ssl);
  15964. return detail::process_client_socket_ssl(
  15965. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15966. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15967. std::move(callback));
  15968. }
  15969. inline bool SSLClient::is_ssl() const { return true; }
  15970. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15971. if (!is_valid()) {
  15972. error = Error::SSLConnection;
  15973. return false;
  15974. }
  15975. return ClientImpl::create_and_connect_socket(socket, error);
  15976. }
  15977. inline bool SSLClient::setup_proxy_connection(
  15978. Socket &socket,
  15979. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15980. Response &res, bool &success, Error &error) {
  15981. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15982. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15983. return false;
  15984. }
  15985. if (!initialize_ssl(socket, error)) {
  15986. success = false;
  15987. return false;
  15988. }
  15989. return true;
  15990. }
  15991. // Assumes that socket_mutex_ is locked and that there are no requests in
  15992. // flight
  15993. inline bool SSLClient::connect_with_proxy(
  15994. Socket &socket,
  15995. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15996. Response &res, bool &success, Error &error) {
  15997. success = true;
  15998. Response proxy_res;
  15999. if (!detail::process_client_socket(
  16000. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16001. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16002. start_time, [&](Stream &strm) {
  16003. Request req2;
  16004. req2.method = "CONNECT";
  16005. req2.path =
  16006. detail::make_host_and_port_string_always_port(host_, port_);
  16007. if (max_timeout_msec_ > 0) {
  16008. req2.start_time_ = std::chrono::steady_clock::now();
  16009. }
  16010. return process_request(strm, req2, proxy_res, false, error);
  16011. })) {
  16012. // Thread-safe to close everything because we are assuming there are no
  16013. // requests in flight
  16014. shutdown_ssl(socket, true);
  16015. shutdown_socket(socket);
  16016. close_socket(socket);
  16017. success = false;
  16018. return false;
  16019. }
  16020. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16021. if (!proxy_digest_auth_username_.empty() &&
  16022. !proxy_digest_auth_password_.empty()) {
  16023. std::map<std::string, std::string> auth;
  16024. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16025. // Close the current socket and create a new one for the authenticated
  16026. // request
  16027. shutdown_ssl(socket, true);
  16028. shutdown_socket(socket);
  16029. close_socket(socket);
  16030. // Create a new socket for the authenticated CONNECT request
  16031. if (!ensure_socket_connection(socket, error)) {
  16032. success = false;
  16033. output_error_log(error, nullptr);
  16034. return false;
  16035. }
  16036. proxy_res = Response();
  16037. if (!detail::process_client_socket(
  16038. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16039. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16040. start_time, [&](Stream &strm) {
  16041. Request req3;
  16042. req3.method = "CONNECT";
  16043. req3.path = detail::make_host_and_port_string_always_port(
  16044. host_, port_);
  16045. req3.headers.insert(detail::make_digest_authentication_header(
  16046. req3, auth, 1, detail::random_string(10),
  16047. proxy_digest_auth_username_, proxy_digest_auth_password_,
  16048. true));
  16049. if (max_timeout_msec_ > 0) {
  16050. req3.start_time_ = std::chrono::steady_clock::now();
  16051. }
  16052. return process_request(strm, req3, proxy_res, false, error);
  16053. })) {
  16054. // Thread-safe to close everything because we are assuming there are
  16055. // no requests in flight
  16056. shutdown_ssl(socket, true);
  16057. shutdown_socket(socket);
  16058. close_socket(socket);
  16059. success = false;
  16060. return false;
  16061. }
  16062. }
  16063. }
  16064. }
  16065. // If status code is not 200, proxy request is failed.
  16066. // Set error to ProxyConnection. A refusal such as 407 is returned as the
  16067. // response of the request, so the caller sees why; any other status would
  16068. // read as the answer of the origin, which it never reached.
  16069. if (proxy_res.status != StatusCode::OK_200) {
  16070. error = Error::ProxyConnection;
  16071. output_error_log(error, nullptr);
  16072. if (400 <= proxy_res.status && proxy_res.status < 600) {
  16073. res = std::move(proxy_res);
  16074. } else {
  16075. success = false;
  16076. }
  16077. // Thread-safe to close everything because we are assuming there are
  16078. // no requests in flight
  16079. shutdown_ssl(socket, true);
  16080. shutdown_socket(socket);
  16081. close_socket(socket);
  16082. return false;
  16083. }
  16084. return true;
  16085. }
  16086. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16087. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16088. if (is_proxy_enabled_for_host(host_)) { return true; }
  16089. if (!initialize_ssl(socket, error)) {
  16090. shutdown_socket(socket);
  16091. close_socket(socket);
  16092. return false;
  16093. }
  16094. return true;
  16095. }
  16096. // SSL HTTP client implementation
  16097. inline SSLClient::SSLClient(const std::string &host)
  16098. : SSLClient(host, 443, std::string(), std::string()) {}
  16099. inline SSLClient::SSLClient(const std::string &host, int port)
  16100. : SSLClient(host, port, std::string(), std::string()) {}
  16101. inline void SSLClient::init_ctx() {
  16102. ctx_ = tls::create_client_context();
  16103. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16104. }
  16105. inline void SSLClient::reset_ctx_on_error() {
  16106. last_backend_error_ = tls::get_error();
  16107. tls::free_context(ctx_);
  16108. ctx_ = nullptr;
  16109. }
  16110. inline SSLClient::SSLClient(const std::string &host, int port,
  16111. const std::string &client_cert_path,
  16112. const std::string &client_key_path,
  16113. const std::string &private_key_password)
  16114. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16115. init_ctx();
  16116. if (!ctx_) { return; }
  16117. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16118. const char *password =
  16119. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16120. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16121. client_key_path.c_str(), password)) {
  16122. reset_ctx_on_error();
  16123. }
  16124. }
  16125. }
  16126. inline SSLClient::SSLClient(const std::string &host, int port,
  16127. const PemMemory &pem)
  16128. : ClientImpl(host, port) {
  16129. init_ctx();
  16130. if (!ctx_) { return; }
  16131. if (pem.cert_pem && pem.key_pem) {
  16132. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  16133. pem.private_key_password)) {
  16134. reset_ctx_on_error();
  16135. }
  16136. }
  16137. }
  16138. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16139. if (ca_cert_store && ctx_) {
  16140. // set_ca_store takes ownership of ca_cert_store
  16141. tls::set_ca_store(ctx_, ca_cert_store);
  16142. ca_cert_store_set_ = true;
  16143. } else if (ca_cert_store) {
  16144. tls::free_ca_store(ca_cert_store);
  16145. }
  16146. }
  16147. inline void
  16148. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16149. if (!ctx_) { return; }
  16150. server_certificate_verifier_ = verifier;
  16151. tls::set_verify_callback(ctx_, std::move(verifier));
  16152. }
  16153. inline void SSLClient::set_session_verifier(
  16154. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16155. session_verifier_ = std::move(verifier);
  16156. }
  16157. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16158. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16159. enable_windows_cert_verification_ = enabled;
  16160. }
  16161. #endif
  16162. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16163. std::size_t size) {
  16164. if (ctx_ && ca_cert && size > 0) {
  16165. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  16166. tls::load_ca_pem(ctx_, ca_cert, size);
  16167. }
  16168. }
  16169. inline bool SSLClient::load_certs() {
  16170. auto ret = true;
  16171. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16172. // one client is shared across concurrent requests here.
  16173. std::call_once(initialize_cert_, [&]() {
  16174. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16175. ret = detail::load_client_ca_config(
  16176. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  16177. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  16178. last_backend_error_);
  16179. });
  16180. return ret;
  16181. }
  16182. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16183. // Load CA certificates if server verification is enabled
  16184. if (server_certificate_verification_) {
  16185. if (!load_certs()) {
  16186. error = Error::SSLLoadingCerts;
  16187. output_error_log(error, nullptr);
  16188. return false;
  16189. }
  16190. }
  16191. detail::ClientTlsSessionOptions options;
  16192. options.server_hostname_verification = server_hostname_verification_;
  16193. options.session_verifier = session_verifier_;
  16194. options.ctx_mutex = &ctx_mutex_;
  16195. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16196. // Skip Schannel when a custom CA cert is specified, as the Windows
  16197. // certificate store would not know about user-provided CA certificates.
  16198. // Also skip when system CA trust is explicitly disabled.
  16199. options.windows_cert_verification =
  16200. enable_windows_cert_verification_ &&
  16201. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16202. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16203. // Only a verifier set through set_server_certificate_verifier() is seen
  16204. // here, not one installed with tls::set_verify_callback() directly.
  16205. options.server_certificate_verifier_set =
  16206. static_cast<bool>(server_certificate_verifier_);
  16207. #endif
  16208. tls::session_t session = nullptr;
  16209. // Use scope_exit to ensure session is freed on error paths
  16210. bool success = false;
  16211. auto session_guard = detail::scope_exit([&] {
  16212. if (!success) { tls::free_session(session); }
  16213. });
  16214. detail::ClientTlsSessionError tls_error;
  16215. if (!detail::setup_client_tls_session(
  16216. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16217. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16218. options)) {
  16219. error = tls_error.error;
  16220. last_ssl_error_ = tls_error.ssl_error;
  16221. last_backend_error_ = tls_error.backend_error;
  16222. output_error_log(error, nullptr);
  16223. return false;
  16224. }
  16225. success = true;
  16226. socket.ssl = session;
  16227. return true;
  16228. }
  16229. inline void Client::set_digest_auth(const std::string &username,
  16230. const std::string &password) {
  16231. cli_->set_digest_auth(username, password);
  16232. }
  16233. inline void Client::set_proxy_digest_auth(const std::string &username,
  16234. const std::string &password) {
  16235. cli_->set_proxy_digest_auth(username, password);
  16236. }
  16237. inline void Client::enable_server_certificate_verification(bool enabled) {
  16238. cli_->enable_server_certificate_verification(enabled);
  16239. }
  16240. inline void Client::enable_server_hostname_verification(bool enabled) {
  16241. cli_->enable_server_hostname_verification(enabled);
  16242. }
  16243. inline void Client::enable_system_ca(bool enabled) {
  16244. cli_->enable_system_ca(enabled);
  16245. }
  16246. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16247. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16248. if (is_ssl_) {
  16249. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16250. enabled);
  16251. }
  16252. }
  16253. #endif
  16254. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16255. const std::string &ca_cert_dir_path) {
  16256. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16257. }
  16258. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16259. if (is_ssl_) {
  16260. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16261. } else if (ca_cert_store) {
  16262. tls::free_ca_store(ca_cert_store);
  16263. }
  16264. }
  16265. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16266. if (is_ssl_) {
  16267. // Use the PEM-based path so the CA data is retained for redirect transfer
  16268. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16269. }
  16270. }
  16271. inline void
  16272. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16273. if (is_ssl_) {
  16274. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16275. std::move(verifier));
  16276. }
  16277. }
  16278. inline void Client::set_session_verifier(
  16279. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16280. if (is_ssl_) {
  16281. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16282. }
  16283. }
  16284. inline tls::ctx_t Client::tls_context() const {
  16285. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16286. return nullptr;
  16287. }
  16288. #endif // CPPHTTPLIB_SSL_ENABLED
  16289. /*
  16290. * Group 7: TLS abstraction layer - Common API
  16291. */
  16292. #ifdef CPPHTTPLIB_SSL_ENABLED
  16293. namespace tls {
  16294. // Helper for PeerCert construction
  16295. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16296. return PeerCert(get_peer_cert(session));
  16297. }
  16298. namespace impl {
  16299. // Check if a string is an IPv4 address
  16300. inline bool is_ipv4_address(const std::string &str) {
  16301. int dots = 0;
  16302. for (char c : str) {
  16303. if (c == '.') {
  16304. dots++;
  16305. } else if (!detail::is_ascii_digit(c)) {
  16306. return false;
  16307. }
  16308. }
  16309. return dots == 3;
  16310. }
  16311. // Parse IPv4 address string to bytes
  16312. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16313. const char *p = str.c_str();
  16314. for (int i = 0; i < 4; i++) {
  16315. if (i > 0) {
  16316. if (*p != '.') { return false; }
  16317. p++;
  16318. }
  16319. int val = 0;
  16320. int digits = 0;
  16321. while (detail::is_ascii_digit(*p)) {
  16322. val = val * 10 + (*p - '0');
  16323. if (val > 255) { return false; }
  16324. p++;
  16325. digits++;
  16326. }
  16327. if (digits == 0) { return false; }
  16328. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16329. if (digits > 1 && *(p - digits) == '0') { return false; }
  16330. out[i] = static_cast<unsigned char>(val);
  16331. }
  16332. return *p == '\0';
  16333. }
  16334. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16335. // `out` must have room for at least 16 bytes. Returns the address length
  16336. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16337. // literal. Used to match a host against iPAddress SANs the same way the
  16338. // OpenSSL backend does via X509_check_ip.
  16339. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16340. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16341. struct in6_addr addr6 = {};
  16342. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16343. memcpy(out, &addr6, 16);
  16344. return 16;
  16345. }
  16346. return 0;
  16347. }
  16348. #ifdef _WIN32
  16349. // Enumerate Windows system certificates and call callback with DER data
  16350. template <typename Callback>
  16351. inline bool enumerate_windows_system_certs(Callback cb) {
  16352. bool loaded = false;
  16353. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16354. for (auto store_name : store_names) {
  16355. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16356. if (hStore) {
  16357. PCCERT_CONTEXT pContext = nullptr;
  16358. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16359. nullptr) {
  16360. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16361. loaded = true;
  16362. }
  16363. }
  16364. CertCloseStore(hStore, 0);
  16365. }
  16366. }
  16367. return loaded;
  16368. }
  16369. #endif
  16370. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16371. // Enumerate macOS Keychain certificates and call callback with DER data
  16372. template <typename Callback>
  16373. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16374. bool loaded = false;
  16375. const SecTrustSettingsDomain domains[] = {
  16376. kSecTrustSettingsDomainSystem,
  16377. kSecTrustSettingsDomainAdmin,
  16378. kSecTrustSettingsDomainUser,
  16379. };
  16380. for (auto domain : domains) {
  16381. CFArrayRef certs = nullptr;
  16382. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16383. if (status != errSecSuccess || !certs) {
  16384. if (certs) CFRelease(certs);
  16385. continue;
  16386. }
  16387. CFIndex count = CFArrayGetCount(certs);
  16388. for (CFIndex i = 0; i < count; i++) {
  16389. SecCertificateRef cert =
  16390. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16391. CFDataRef data = SecCertificateCopyData(cert);
  16392. if (data) {
  16393. if (cb(CFDataGetBytePtr(data),
  16394. static_cast<size_t>(CFDataGetLength(data)))) {
  16395. loaded = true;
  16396. }
  16397. CFRelease(data);
  16398. }
  16399. }
  16400. CFRelease(certs);
  16401. }
  16402. return loaded;
  16403. }
  16404. #endif
  16405. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16406. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16407. // Common CA certificate file paths on Linux/Unix
  16408. inline const char **system_ca_paths() {
  16409. static const char *paths[] = {
  16410. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16411. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16412. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16413. "/etc/pki/tls/cacert.pem", // OpenELEC
  16414. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16415. nullptr};
  16416. return paths;
  16417. }
  16418. // Common CA certificate directory paths on Linux/Unix
  16419. inline const char **system_ca_dirs() {
  16420. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16421. "/etc/pki/tls/certs", // RHEL/CentOS
  16422. "/usr/share/ca-certificates", // Other
  16423. nullptr};
  16424. return dirs;
  16425. }
  16426. #endif
  16427. } // namespace impl
  16428. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16429. const char *ca_dir) {
  16430. if (!ctx) { return false; }
  16431. bool success = true;
  16432. if (ca_file && *ca_file) {
  16433. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16434. }
  16435. if (ca_dir && *ca_dir) {
  16436. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16437. }
  16438. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16439. // Set CA list for client certificate request (CertificateRequest message)
  16440. if (ca_file && *ca_file) {
  16441. auto list = SSL_load_client_CA_file(ca_file);
  16442. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16443. }
  16444. #endif
  16445. return success;
  16446. }
  16447. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16448. const char *password) {
  16449. return set_client_cert_pem(ctx, cert, key, password);
  16450. }
  16451. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16452. const char *key_path, const char *password) {
  16453. return set_client_cert_file(ctx, cert_path, key_path, password);
  16454. }
  16455. // PeerCert implementation
  16456. inline PeerCert::PeerCert() = default;
  16457. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16458. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16459. other.cert_ = nullptr;
  16460. }
  16461. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16462. if (this != &other) {
  16463. if (cert_) { free_cert(cert_); }
  16464. cert_ = other.cert_;
  16465. other.cert_ = nullptr;
  16466. }
  16467. return *this;
  16468. }
  16469. inline PeerCert::~PeerCert() {
  16470. if (cert_) { free_cert(cert_); }
  16471. }
  16472. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16473. inline std::string PeerCert::subject_cn() const {
  16474. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16475. }
  16476. inline std::string PeerCert::issuer_name() const {
  16477. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16478. }
  16479. inline bool PeerCert::check_hostname(const char *hostname) const {
  16480. return cert_ ? verify_hostname(cert_, hostname) : false;
  16481. }
  16482. inline std::vector<SanEntry> PeerCert::sans() const {
  16483. std::vector<SanEntry> result;
  16484. if (cert_) { get_cert_sans(cert_, result); }
  16485. return result;
  16486. }
  16487. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16488. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16489. }
  16490. inline std::string PeerCert::serial() const {
  16491. return cert_ ? get_cert_serial(cert_) : std::string();
  16492. }
  16493. // VerifyContext method implementations
  16494. inline std::string VerifyContext::subject_cn() const {
  16495. return cert ? get_cert_subject_cn(cert) : std::string();
  16496. }
  16497. inline std::string VerifyContext::issuer_name() const {
  16498. return cert ? get_cert_issuer_name(cert) : std::string();
  16499. }
  16500. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16501. return cert ? verify_hostname(cert, hostname) : false;
  16502. }
  16503. inline std::vector<SanEntry> VerifyContext::sans() const {
  16504. std::vector<SanEntry> result;
  16505. if (cert) { get_cert_sans(cert, result); }
  16506. return result;
  16507. }
  16508. inline bool VerifyContext::validity(time_t &not_before,
  16509. time_t &not_after) const {
  16510. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16511. }
  16512. inline std::string VerifyContext::serial() const {
  16513. return cert ? get_cert_serial(cert) : std::string();
  16514. }
  16515. // TlsError static method implementation
  16516. inline std::string TlsError::verify_error_to_string(long error_code) {
  16517. return verify_error_string(error_code);
  16518. }
  16519. } // namespace tls
  16520. // Request::peer_cert() implementation
  16521. inline tls::PeerCert Request::peer_cert() const {
  16522. return tls::get_peer_cert_from_session(ssl);
  16523. }
  16524. // Request::sni() implementation
  16525. inline std::string Request::sni() const {
  16526. if (!ssl) { return std::string(); }
  16527. const char *s = tls::get_sni(ssl);
  16528. return s ? std::string(s) : std::string();
  16529. }
  16530. #endif // CPPHTTPLIB_SSL_ENABLED
  16531. /*
  16532. * Group 8: TLS abstraction layer - OpenSSL backend
  16533. */
  16534. /*
  16535. * OpenSSL Backend Implementation
  16536. */
  16537. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16538. namespace tls {
  16539. namespace impl {
  16540. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16541. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16542. switch (ssl_error) {
  16543. case SSL_ERROR_NONE: return ErrorCode::Success;
  16544. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16545. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16546. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16547. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16548. case SSL_ERROR_SSL:
  16549. default: return ErrorCode::Fatal;
  16550. }
  16551. }
  16552. // Helper: Create client CA list from PEM string
  16553. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16554. // Caller takes ownership of returned list
  16555. inline STACK_OF(X509_NAME) *
  16556. create_client_ca_list_from_pem(const char *ca_pem) {
  16557. if (!ca_pem) { return nullptr; }
  16558. auto ca_list = sk_X509_NAME_new_null();
  16559. if (!ca_list) { return nullptr; }
  16560. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16561. if (!bio) {
  16562. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16563. return nullptr;
  16564. }
  16565. X509 *cert = nullptr;
  16566. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16567. nullptr) {
  16568. const X509_NAME *name = X509_get_subject_name(cert);
  16569. if (name) {
  16570. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16571. }
  16572. X509_free(cert);
  16573. }
  16574. BIO_free(bio);
  16575. return ca_list;
  16576. }
  16577. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16578. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16579. long /*argl*/, void * /*argp*/) {
  16580. delete static_cast<VerifyCallback *>(ptr);
  16581. }
  16582. // The SSL_CTX owns its verify callback, so each client or server sees only
  16583. // its own, on whichever thread runs the handshake.
  16584. inline int verify_callback_index() {
  16585. static const auto index = SSL_CTX_get_ex_new_index(
  16586. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16587. return index;
  16588. }
  16589. // OpenSSL verify callback wrapper
  16590. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16591. // Get SSL object from X509_STORE_CTX
  16592. auto ssl = static_cast<SSL *>(
  16593. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16594. if (!ssl) { return preverify_ok; }
  16595. auto callback = static_cast<VerifyCallback *>(
  16596. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16597. if (!callback) { return preverify_ok; }
  16598. // Get current certificate and depth
  16599. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16600. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16601. int error = X509_STORE_CTX_get_error(ctx);
  16602. // Build context
  16603. VerifyContext verify_ctx;
  16604. verify_ctx.session = static_cast<session_t>(ssl);
  16605. verify_ctx.cert = static_cast<cert_t>(cert);
  16606. verify_ctx.depth = depth;
  16607. verify_ctx.preverify_ok = (preverify_ok != 0);
  16608. verify_ctx.error_code = error;
  16609. verify_ctx.error_string =
  16610. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16611. return (*callback)(verify_ctx) ? 1 : 0;
  16612. }
  16613. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16614. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16615. // that must be released with release_store_objects
  16616. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16617. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16618. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16619. #endif
  16620. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16621. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16622. return X509_STORE_get1_objects(store);
  16623. #else
  16624. return X509_STORE_get0_objects(store);
  16625. #endif
  16626. }
  16627. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16628. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16629. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16630. #else
  16631. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16632. #endif
  16633. }
  16634. } // namespace impl
  16635. inline ctx_t create_client_context() {
  16636. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16637. if (ctx) {
  16638. // Disable auto-retry to properly handle non-blocking I/O
  16639. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16640. // Set minimum TLS version
  16641. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16642. }
  16643. return static_cast<ctx_t>(ctx);
  16644. }
  16645. inline void free_context(ctx_t ctx) {
  16646. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16647. }
  16648. inline bool set_min_version(ctx_t ctx, Version version) {
  16649. if (!ctx) return false;
  16650. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16651. static_cast<int>(version)) == 1;
  16652. }
  16653. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16654. if (!ctx || !pem || len == 0) return false;
  16655. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16656. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16657. if (!store) return false;
  16658. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16659. if (!bio) return false;
  16660. bool ok = true;
  16661. X509 *cert = nullptr;
  16662. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16663. nullptr) {
  16664. if (X509_STORE_add_cert(store, cert) != 1) {
  16665. // Ignore duplicate errors
  16666. auto err = ERR_peek_last_error();
  16667. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16668. ok = false;
  16669. }
  16670. }
  16671. X509_free(cert);
  16672. if (!ok) break;
  16673. }
  16674. BIO_free(bio);
  16675. // Clear any "no more certificates" errors
  16676. ERR_clear_error();
  16677. return ok;
  16678. }
  16679. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16680. if (!ctx || !file_path) return false;
  16681. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16682. nullptr) == 1;
  16683. }
  16684. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16685. if (!ctx || !dir_path) return false;
  16686. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16687. dir_path) == 1;
  16688. }
  16689. inline bool load_system_certs(ctx_t ctx) {
  16690. if (!ctx) return false;
  16691. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16692. #ifdef _WIN32
  16693. // Windows: Load from system certificate store (ROOT and CA)
  16694. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16695. if (!store) return false;
  16696. bool loaded_any = false;
  16697. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16698. for (auto store_name : store_names) {
  16699. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16700. if (!hStore) continue;
  16701. PCCERT_CONTEXT pContext = nullptr;
  16702. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16703. nullptr) {
  16704. const unsigned char *data = pContext->pbCertEncoded;
  16705. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16706. if (x509) {
  16707. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16708. X509_free(x509);
  16709. }
  16710. }
  16711. CertCloseStore(hStore, 0);
  16712. }
  16713. return loaded_any;
  16714. #elif defined(__APPLE__)
  16715. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16716. // macOS: Load from Keychain
  16717. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16718. if (!store) return false;
  16719. bool loaded_any = false;
  16720. const SecTrustSettingsDomain domains[] = {
  16721. kSecTrustSettingsDomainSystem,
  16722. kSecTrustSettingsDomainAdmin,
  16723. kSecTrustSettingsDomainUser,
  16724. };
  16725. for (auto domain : domains) {
  16726. CFArrayRef certs = nullptr;
  16727. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16728. !certs) {
  16729. if (certs) CFRelease(certs);
  16730. continue;
  16731. }
  16732. auto count = CFArrayGetCount(certs);
  16733. for (CFIndex i = 0; i < count; i++) {
  16734. auto cert = reinterpret_cast<SecCertificateRef>(
  16735. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16736. CFDataRef der = SecCertificateCopyData(cert);
  16737. if (der) {
  16738. const unsigned char *data = CFDataGetBytePtr(der);
  16739. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16740. if (x509) {
  16741. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16742. X509_free(x509);
  16743. }
  16744. CFRelease(der);
  16745. }
  16746. }
  16747. CFRelease(certs);
  16748. }
  16749. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16750. #else
  16751. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16752. #endif
  16753. #else
  16754. // Other Unix: use default verify paths
  16755. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16756. #endif
  16757. }
  16758. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16759. const char *password) {
  16760. if (!ctx || !cert || !key) return false;
  16761. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16762. // Load certificate
  16763. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16764. if (!cert_bio) return false;
  16765. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16766. BIO_free(cert_bio);
  16767. if (!x509) return false;
  16768. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16769. X509_free(x509);
  16770. if (!cert_ok) return false;
  16771. // Load private key
  16772. auto key_bio = BIO_new_mem_buf(key, -1);
  16773. if (!key_bio) return false;
  16774. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16775. password ? const_cast<char *>(password)
  16776. : nullptr);
  16777. BIO_free(key_bio);
  16778. if (!pkey) return false;
  16779. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16780. EVP_PKEY_free(pkey);
  16781. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16782. }
  16783. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16784. const char *key_path, const char *password) {
  16785. if (!ctx || !cert_path || !key_path) return false;
  16786. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16787. if (password && password[0] != '\0') {
  16788. SSL_CTX_set_default_passwd_cb_userdata(
  16789. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16790. }
  16791. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16792. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16793. }
  16794. inline ctx_t create_server_context() {
  16795. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16796. if (ctx) {
  16797. // No renegotiation, which would run a handshake outside the one that
  16798. // SSLServer::update_certs_pem() waits for, as the other backends have it
  16799. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16800. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  16801. SSL_OP_NO_RENEGOTIATION);
  16802. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16803. }
  16804. return static_cast<ctx_t>(ctx);
  16805. }
  16806. inline void set_verify_client(ctx_t ctx, bool require) {
  16807. if (!ctx) return;
  16808. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16809. require
  16810. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16811. : SSL_VERIFY_NONE,
  16812. nullptr);
  16813. }
  16814. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16815. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16816. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16817. SSL *ssl = SSL_new(ssl_ctx);
  16818. if (!ssl) return nullptr;
  16819. // Disable auto-retry for proper non-blocking I/O handling
  16820. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16821. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16822. if (!bio) {
  16823. SSL_free(ssl);
  16824. return nullptr;
  16825. }
  16826. SSL_set_bio(ssl, bio, bio);
  16827. return static_cast<session_t>(ssl);
  16828. }
  16829. inline void free_session(session_t session) {
  16830. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16831. }
  16832. inline bool set_sni(session_t session, const char *hostname,
  16833. bool /*verify_hostname*/) {
  16834. if (!session || !hostname) return false;
  16835. auto ssl = static_cast<SSL *>(session);
  16836. // Set SNI (Server Name Indication) only - does not enable verification.
  16837. // OpenSSL never binds identity checking to SNI (that happens post-
  16838. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16839. #if defined(OPENSSL_IS_BORINGSSL)
  16840. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16841. #else
  16842. // Direct call instead of macro to suppress -Wold-style-cast warning
  16843. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16844. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16845. #endif
  16846. }
  16847. inline TlsError connect(session_t session) {
  16848. if (!session) { return TlsError(); }
  16849. auto ssl = static_cast<SSL *>(session);
  16850. auto ret = SSL_connect(ssl);
  16851. TlsError err;
  16852. if (ret == 1) {
  16853. err.code = ErrorCode::Success;
  16854. } else {
  16855. auto ssl_err = SSL_get_error(ssl, ret);
  16856. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16857. err.backend_code = ERR_get_error();
  16858. }
  16859. return err;
  16860. }
  16861. inline TlsError accept(session_t session) {
  16862. if (!session) { return TlsError(); }
  16863. auto ssl = static_cast<SSL *>(session);
  16864. auto ret = SSL_accept(ssl);
  16865. TlsError err;
  16866. if (ret == 1) {
  16867. err.code = ErrorCode::Success;
  16868. } else {
  16869. auto ssl_err = SSL_get_error(ssl, ret);
  16870. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16871. err.backend_code = ERR_get_error();
  16872. }
  16873. return err;
  16874. }
  16875. inline bool connect_nonblocking(session_t session, socket_t sock,
  16876. time_t timeout_sec, time_t timeout_usec,
  16877. TlsError *err) {
  16878. if (!session) {
  16879. if (err) { err->code = ErrorCode::Fatal; }
  16880. return false;
  16881. }
  16882. auto ssl = static_cast<SSL *>(session);
  16883. auto bio = SSL_get_rbio(ssl);
  16884. // Set non-blocking mode for handshake
  16885. detail::set_nonblocking(sock, true);
  16886. if (bio) { BIO_set_nbio(bio, 1); }
  16887. auto cleanup = detail::scope_exit([&]() {
  16888. // Restore blocking mode after handshake
  16889. if (bio) { BIO_set_nbio(bio, 0); }
  16890. detail::set_nonblocking(sock, false);
  16891. });
  16892. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  16893. auto res = 0;
  16894. while ((res = SSL_connect(ssl)) != 1) {
  16895. auto ssl_err = SSL_get_error(ssl, res);
  16896. switch (ssl_err) {
  16897. case SSL_ERROR_WANT_READ:
  16898. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  16899. break;
  16900. case SSL_ERROR_WANT_WRITE:
  16901. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  16902. break;
  16903. default: break;
  16904. }
  16905. if (err) {
  16906. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16907. err->backend_code = ERR_get_error();
  16908. }
  16909. return false;
  16910. }
  16911. if (err) { err->code = ErrorCode::Success; }
  16912. return true;
  16913. }
  16914. inline bool accept_nonblocking(session_t session, socket_t sock,
  16915. time_t timeout_sec, time_t timeout_usec,
  16916. TlsError *err) {
  16917. if (!session) {
  16918. if (err) { err->code = ErrorCode::Fatal; }
  16919. return false;
  16920. }
  16921. auto ssl = static_cast<SSL *>(session);
  16922. auto bio = SSL_get_rbio(ssl);
  16923. // Set non-blocking mode for handshake
  16924. detail::set_nonblocking(sock, true);
  16925. if (bio) { BIO_set_nbio(bio, 1); }
  16926. auto cleanup = detail::scope_exit([&]() {
  16927. // Restore blocking mode after handshake
  16928. if (bio) { BIO_set_nbio(bio, 0); }
  16929. detail::set_nonblocking(sock, false);
  16930. });
  16931. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  16932. auto res = 0;
  16933. while ((res = SSL_accept(ssl)) != 1) {
  16934. auto ssl_err = SSL_get_error(ssl, res);
  16935. switch (ssl_err) {
  16936. case SSL_ERROR_WANT_READ:
  16937. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  16938. break;
  16939. case SSL_ERROR_WANT_WRITE:
  16940. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  16941. break;
  16942. default: break;
  16943. }
  16944. if (err) {
  16945. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16946. err->backend_code = ERR_get_error();
  16947. }
  16948. return false;
  16949. }
  16950. if (err) { err->code = ErrorCode::Success; }
  16951. return true;
  16952. }
  16953. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16954. if (!session || !buf) {
  16955. err.code = ErrorCode::Fatal;
  16956. return -1;
  16957. }
  16958. auto ssl = static_cast<SSL *>(session);
  16959. constexpr auto max_len =
  16960. static_cast<size_t>((std::numeric_limits<int>::max)());
  16961. if (len > max_len) { len = max_len; }
  16962. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16963. if (ret > 0) {
  16964. err.code = ErrorCode::Success;
  16965. return ret;
  16966. }
  16967. auto ssl_err = SSL_get_error(ssl, ret);
  16968. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16969. if (err.code == ErrorCode::PeerClosed) {
  16970. return 0;
  16971. } // Gracefully handle the peer closed state.
  16972. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16973. return -1;
  16974. }
  16975. inline ssize_t write(session_t session, const void *buf, size_t len,
  16976. TlsError &err) {
  16977. if (!session || !buf) {
  16978. err.code = ErrorCode::Fatal;
  16979. return -1;
  16980. }
  16981. auto ssl = static_cast<SSL *>(session);
  16982. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16983. if (ret > 0) {
  16984. err.code = ErrorCode::Success;
  16985. return ret;
  16986. }
  16987. auto ssl_err = SSL_get_error(ssl, ret);
  16988. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16989. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16990. return -1;
  16991. }
  16992. inline int pending(const_session_t session) {
  16993. if (!session) return 0;
  16994. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16995. }
  16996. inline void shutdown(session_t session, bool graceful) {
  16997. if (!session) return;
  16998. auto ssl = static_cast<SSL *>(session);
  16999. if (graceful) {
  17000. // Send close_notify without waiting for the peer's. The connection is
  17001. // closed right after this, so a unidirectional shutdown is enough, and an
  17002. // idle peer that never answers would otherwise hold this thread until the
  17003. // read timeout. The other backends do not wait either.
  17004. SSL_shutdown(ssl);
  17005. }
  17006. }
  17007. inline bool is_peer_closed(session_t session, socket_t sock) {
  17008. if (!session) return true;
  17009. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17010. detail::set_nonblocking(sock, true);
  17011. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17012. auto ssl = static_cast<SSL *>(session);
  17013. char buf;
  17014. auto ret = SSL_peek(ssl, &buf, 1);
  17015. if (ret > 0) return false;
  17016. auto err = SSL_get_error(ssl, ret);
  17017. return err == SSL_ERROR_ZERO_RETURN;
  17018. }
  17019. inline cert_t get_peer_cert(const_session_t session) {
  17020. if (!session) return nullptr;
  17021. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17022. static_cast<SSL *>(const_cast<void *>(session))));
  17023. }
  17024. inline size_t get_peer_certs(const_session_t session,
  17025. std::vector<cert_t> &certs) {
  17026. certs.clear();
  17027. if (!session) { return 0; }
  17028. auto ssl = static_cast<const SSL *>(session);
  17029. // On the server side, the chain leaves out the peer's own certificate
  17030. if (SSL_is_server(ssl)) {
  17031. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17032. }
  17033. auto sk = SSL_get_peer_cert_chain(ssl);
  17034. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  17035. auto x509 = sk_X509_value(sk, i);
  17036. X509_up_ref(x509);
  17037. certs.push_back(static_cast<cert_t>(x509));
  17038. }
  17039. return certs.size();
  17040. }
  17041. inline void free_cert(cert_t cert) {
  17042. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17043. }
  17044. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17045. if (!cert || !hostname) return false;
  17046. auto x509 = static_cast<X509 *>(cert);
  17047. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17048. if (detail::is_ip_address(hostname)) {
  17049. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17050. }
  17051. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  17052. }
  17053. inline uint64_t hostname_mismatch_code() {
  17054. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17055. }
  17056. inline long get_verify_result(const_session_t session) {
  17057. if (!session) return X509_V_ERR_UNSPECIFIED;
  17058. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17059. }
  17060. inline std::string get_cert_subject_cn(cert_t cert) {
  17061. if (!cert) return "";
  17062. auto x509 = static_cast<X509 *>(cert);
  17063. auto subject_name = X509_get_subject_name(x509);
  17064. if (!subject_name) return "";
  17065. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17066. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17067. if (idx < 0) return "";
  17068. auto entry = X509_NAME_get_entry(subject_name, idx);
  17069. if (!entry) return "";
  17070. auto data = X509_NAME_ENTRY_get_data(entry);
  17071. if (!data) return "";
  17072. return std::string(
  17073. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17074. static_cast<size_t>(ASN1_STRING_length(data)));
  17075. }
  17076. inline std::string get_cert_issuer_name(cert_t cert) {
  17077. if (!cert) return "";
  17078. auto x509 = static_cast<X509 *>(cert);
  17079. auto issuer_name = X509_get_issuer_name(x509);
  17080. if (!issuer_name) return "";
  17081. char buf[256];
  17082. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17083. return std::string(buf);
  17084. }
  17085. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17086. sans.clear();
  17087. if (!cert) return false;
  17088. auto x509 = static_cast<X509 *>(cert);
  17089. auto names = static_cast<GENERAL_NAMES *>(
  17090. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17091. if (!names) return true; // No SANs is valid
  17092. auto count = sk_GENERAL_NAME_num(names);
  17093. for (decltype(count) i = 0; i < count; i++) {
  17094. auto gen = sk_GENERAL_NAME_value(names, i);
  17095. if (!gen) continue;
  17096. SanEntry entry;
  17097. switch (gen->type) {
  17098. case GEN_DNS:
  17099. entry.type = SanType::DNS;
  17100. if (gen->d.dNSName) {
  17101. entry.value = std::string(
  17102. reinterpret_cast<const char *>(
  17103. ASN1_STRING_get0_data(gen->d.dNSName)),
  17104. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17105. }
  17106. break;
  17107. case GEN_IPADD:
  17108. entry.type = SanType::IP;
  17109. if (gen->d.iPAddress) {
  17110. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17111. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17112. if (len == 4) {
  17113. // IPv4
  17114. char buf[INET_ADDRSTRLEN];
  17115. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17116. entry.value = buf;
  17117. } else if (len == 16) {
  17118. // IPv6
  17119. char buf[INET6_ADDRSTRLEN];
  17120. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17121. entry.value = buf;
  17122. }
  17123. }
  17124. break;
  17125. case GEN_EMAIL:
  17126. entry.type = SanType::EMAIL;
  17127. if (gen->d.rfc822Name) {
  17128. entry.value = std::string(
  17129. reinterpret_cast<const char *>(
  17130. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17131. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17132. }
  17133. break;
  17134. case GEN_URI:
  17135. entry.type = SanType::URI;
  17136. if (gen->d.uniformResourceIdentifier) {
  17137. entry.value = std::string(
  17138. reinterpret_cast<const char *>(
  17139. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17140. static_cast<size_t>(
  17141. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17142. }
  17143. break;
  17144. default: entry.type = SanType::OTHER; break;
  17145. }
  17146. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17147. }
  17148. GENERAL_NAMES_free(names);
  17149. return true;
  17150. }
  17151. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17152. time_t &not_after) {
  17153. if (!cert) return false;
  17154. auto x509 = static_cast<X509 *>(cert);
  17155. auto nb = X509_get0_notBefore(x509);
  17156. auto na = X509_get0_notAfter(x509);
  17157. if (!nb || !na) return false;
  17158. ASN1_TIME *epoch = ASN1_TIME_new();
  17159. if (!epoch) return false;
  17160. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17161. if (!ASN1_TIME_set(epoch, 0)) return false;
  17162. int pday, psec;
  17163. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17164. not_before = 86400 * (time_t)pday + psec;
  17165. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17166. not_after = 86400 * (time_t)pday + psec;
  17167. return true;
  17168. }
  17169. inline std::string get_cert_serial(cert_t cert) {
  17170. if (!cert) return "";
  17171. auto x509 = static_cast<X509 *>(cert);
  17172. auto serial = X509_get_serialNumber(x509);
  17173. if (!serial) return "";
  17174. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17175. if (!bn) return "";
  17176. auto hex = BN_bn2hex(bn);
  17177. BN_free(bn);
  17178. if (!hex) return "";
  17179. std::string result(hex);
  17180. OPENSSL_free(hex);
  17181. return result;
  17182. }
  17183. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17184. if (!cert) return false;
  17185. auto x509 = static_cast<X509 *>(cert);
  17186. auto len = i2d_X509(x509, nullptr);
  17187. if (len < 0) return false;
  17188. der.resize(static_cast<size_t>(len));
  17189. auto p = der.data();
  17190. i2d_X509(x509, &p);
  17191. return true;
  17192. }
  17193. inline const char *get_sni(const_session_t session) {
  17194. if (!session) return nullptr;
  17195. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17196. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17197. }
  17198. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17199. inline uint64_t get_error() { return ERR_get_error(); }
  17200. inline std::string error_string(uint64_t code) {
  17201. char buf[256];
  17202. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  17203. return std::string(buf);
  17204. }
  17205. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17206. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17207. if (!mem) { return nullptr; }
  17208. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17209. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17210. if (!inf) { return nullptr; }
  17211. auto store = X509_STORE_new();
  17212. if (store) {
  17213. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  17214. auto itmp = sk_X509_INFO_value(inf, i);
  17215. if (!itmp) { continue; }
  17216. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17217. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17218. }
  17219. }
  17220. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17221. return static_cast<ca_store_t>(store);
  17222. }
  17223. inline void free_ca_store(ca_store_t store) {
  17224. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17225. }
  17226. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17227. if (!ctx || !store) { return false; }
  17228. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17229. auto x509_store = static_cast<X509_STORE *>(store);
  17230. // Check if same store is already set
  17231. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17232. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17233. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17234. return true;
  17235. }
  17236. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17237. certs.clear();
  17238. if (!ctx) { return 0; }
  17239. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17240. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17241. if (!store) { return 0; }
  17242. auto objs = impl::get_store_objects(store);
  17243. if (!objs) { return 0; }
  17244. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17245. auto count = sk_X509_OBJECT_num(objs);
  17246. for (decltype(count) i = 0; i < count; i++) {
  17247. auto obj = sk_X509_OBJECT_value(objs, i);
  17248. if (!obj) { continue; }
  17249. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17250. auto x509 = X509_OBJECT_get0_X509(obj);
  17251. if (x509) {
  17252. // Increment reference count so caller can free it
  17253. X509_up_ref(x509);
  17254. certs.push_back(static_cast<cert_t>(x509));
  17255. }
  17256. }
  17257. }
  17258. return certs.size();
  17259. }
  17260. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17261. std::vector<std::string> names;
  17262. if (!ctx) { return names; }
  17263. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17264. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17265. if (!store) { return names; }
  17266. auto objs = impl::get_store_objects(store);
  17267. if (!objs) { return names; }
  17268. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17269. auto count = sk_X509_OBJECT_num(objs);
  17270. for (decltype(count) i = 0; i < count; i++) {
  17271. auto obj = sk_X509_OBJECT_value(objs, i);
  17272. if (!obj) { continue; }
  17273. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17274. auto x509 = X509_OBJECT_get0_X509(obj);
  17275. if (x509) {
  17276. auto subject = X509_get_subject_name(x509);
  17277. if (subject) {
  17278. char buf[512];
  17279. X509_NAME_oneline(subject, buf, sizeof(buf));
  17280. names.push_back(buf);
  17281. }
  17282. }
  17283. }
  17284. }
  17285. return names;
  17286. }
  17287. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17288. const char *key_pem, const char *password) {
  17289. if (!ctx || !cert_pem || !key_pem) { return false; }
  17290. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17291. // Load certificate from PEM
  17292. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17293. if (!cert_bio) { return false; }
  17294. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17295. BIO_free(cert_bio);
  17296. if (!cert) { return false; }
  17297. // Load private key from PEM
  17298. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17299. if (!key_bio) {
  17300. X509_free(cert);
  17301. return false;
  17302. }
  17303. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17304. password ? const_cast<char *>(password)
  17305. : nullptr);
  17306. BIO_free(key_bio);
  17307. if (!key) {
  17308. X509_free(cert);
  17309. return false;
  17310. }
  17311. // Update certificate and key
  17312. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17313. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17314. X509_free(cert);
  17315. EVP_PKEY_free(key);
  17316. return ret;
  17317. }
  17318. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17319. if (!ctx || !ca_pem) { return false; }
  17320. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17321. // Create new X509_STORE from PEM
  17322. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17323. if (!store) { return false; }
  17324. // SSL_CTX_set_cert_store takes ownership
  17325. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17326. // Set client CA list for client certificate request
  17327. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17328. if (ca_list) {
  17329. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17330. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17331. }
  17332. // A resumed session is not verified again, so forget the sessions and the
  17333. // ticket keys from before, or a client verified under the old CAs could go
  17334. // on resuming.
  17335. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17336. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17337. #else
  17338. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17339. #endif
  17340. unsigned char ticket_keys[80];
  17341. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) == 1) {
  17342. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys, sizeof(ticket_keys));
  17343. }
  17344. return true;
  17345. }
  17346. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17347. if (!ctx) { return false; }
  17348. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17349. auto index = impl::verify_callback_index();
  17350. if (index < 0) { return false; }
  17351. auto stored = callback ? new VerifyCallback(std::move(callback)) : nullptr;
  17352. delete static_cast<VerifyCallback *>(SSL_CTX_get_ex_data(ssl_ctx, index));
  17353. SSL_CTX_set_ex_data(ssl_ctx, index, stored);
  17354. if (stored) {
  17355. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  17356. } else {
  17357. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  17358. }
  17359. return true;
  17360. }
  17361. inline long get_verify_error(const_session_t session) {
  17362. if (!session) { return -1; }
  17363. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17364. return SSL_get_verify_result(ssl);
  17365. }
  17366. inline std::string verify_error_string(long error_code) {
  17367. if (error_code == X509_V_OK) { return ""; }
  17368. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17369. return str ? str : "unknown error";
  17370. }
  17371. } // namespace tls
  17372. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17373. /*
  17374. * Group 9: TLS abstraction layer - Mbed TLS backend
  17375. */
  17376. /*
  17377. * Mbed TLS Backend Implementation
  17378. */
  17379. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17380. namespace tls {
  17381. namespace impl {
  17382. // Mbed TLS session wrapper
  17383. struct MbedTlsSession {
  17384. mbedtls_ssl_context ssl;
  17385. socket_t sock = INVALID_SOCKET;
  17386. std::string hostname; // For client: set via set_sni
  17387. std::string sni_hostname; // For server: received from client via SNI callback
  17388. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17389. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17390. // (e.g. a response that arrived while this side was still in its post-write
  17391. // check), the byte is pushed back here and served by the next read().
  17392. unsigned char peeked_byte = 0;
  17393. bool has_peeked_byte = false;
  17394. // Set by set_sni() when the caller disabled hostname verification, so the
  17395. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17396. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17397. // OpenSSL and wolfSSL keep them independent).
  17398. bool suppress_hostname_mismatch = false;
  17399. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17400. // ever runs the callback of its own context.
  17401. VerifyCallback verify_callback;
  17402. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17403. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17404. MbedTlsSession(const MbedTlsSession &) = delete;
  17405. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17406. };
  17407. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17408. // queue)
  17409. inline int &mbedtls_last_error() {
  17410. static thread_local int err = 0;
  17411. return err;
  17412. }
  17413. // Helper to map Mbed TLS error to ErrorCode
  17414. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17415. uint32_t verify_flags) {
  17416. if (ret == 0) { return ErrorCode::Success; }
  17417. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17418. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17419. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17420. return ErrorCode::PeerClosed;
  17421. }
  17422. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17423. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17424. out_errno = errno;
  17425. return ErrorCode::SyscallError;
  17426. }
  17427. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17428. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17429. // the handshake's chain verification (see set_sni()); a mismatch there
  17430. // is reported the same way as any other verify_flags bit. Report it as
  17431. // HostnameMismatch, matching the other backends and the post-handshake
  17432. // identity check below, but only when naming is the sole problem -
  17433. // if the chain itself is also untrusted/expired/etc., that takes
  17434. // priority over the naming detail.
  17435. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17436. return ErrorCode::HostnameMismatch;
  17437. }
  17438. return ErrorCode::CertVerifyFailed;
  17439. }
  17440. return ErrorCode::Fatal;
  17441. }
  17442. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17443. // return value, including the verify-flags-dependent HostnameMismatch
  17444. // mapping; shared by connect() and connect_nonblocking() so the
  17445. // backend_code policy for that mapping only lives in one place.
  17446. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17447. int ret) {
  17448. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17449. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17450. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17451. ? static_cast<uint64_t>(verify_flags)
  17452. : static_cast<uint64_t>(-ret);
  17453. }
  17454. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17455. // non-fatal notification delivered between records, not an error and not
  17456. // application data, so I/O calls that see it should just be retried. Kept in
  17457. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17458. // splitting the closing brace across an #if.
  17459. inline bool mbedtls_is_session_ticket(int ret) {
  17460. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17461. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17462. #else
  17463. (void)ret;
  17464. return false;
  17465. #endif
  17466. }
  17467. // BIO-like send callback for Mbed TLS
  17468. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17469. size_t len) {
  17470. auto sock = *static_cast<socket_t *>(ctx);
  17471. #ifdef _WIN32
  17472. auto ret =
  17473. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17474. if (ret == SOCKET_ERROR) {
  17475. int err = WSAGetLastError();
  17476. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17477. return MBEDTLS_ERR_NET_SEND_FAILED;
  17478. }
  17479. #else
  17480. auto ret = send(sock, buf, len, 0);
  17481. if (ret < 0) {
  17482. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17483. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17484. }
  17485. return MBEDTLS_ERR_NET_SEND_FAILED;
  17486. }
  17487. #endif
  17488. return static_cast<int>(ret);
  17489. }
  17490. // BIO-like recv callback for Mbed TLS
  17491. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17492. auto sock = *static_cast<socket_t *>(ctx);
  17493. #ifdef _WIN32
  17494. auto ret =
  17495. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17496. if (ret == SOCKET_ERROR) {
  17497. int err = WSAGetLastError();
  17498. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17499. return MBEDTLS_ERR_NET_RECV_FAILED;
  17500. }
  17501. #else
  17502. auto ret = recv(sock, buf, len, 0);
  17503. if (ret < 0) {
  17504. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17505. return MBEDTLS_ERR_SSL_WANT_READ;
  17506. }
  17507. return MBEDTLS_ERR_NET_RECV_FAILED;
  17508. }
  17509. #endif
  17510. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17511. return static_cast<int>(ret);
  17512. }
  17513. // MbedTlsContext constructor/destructor implementations
  17514. inline MbedTlsContext::MbedTlsContext() {
  17515. mbedtls_ssl_config_init(&conf);
  17516. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17517. mbedtls_entropy_init(&entropy);
  17518. mbedtls_ctr_drbg_init(&ctr_drbg);
  17519. #endif
  17520. mbedtls_x509_crt_init(&ca_chain);
  17521. mbedtls_x509_crt_init(&own_cert);
  17522. mbedtls_pk_init(&own_key);
  17523. }
  17524. inline MbedTlsContext::~MbedTlsContext() {
  17525. mbedtls_pk_free(&own_key);
  17526. mbedtls_x509_crt_free(&own_cert);
  17527. mbedtls_x509_crt_free(&ca_chain);
  17528. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17529. mbedtls_ctr_drbg_free(&ctr_drbg);
  17530. mbedtls_entropy_free(&entropy);
  17531. #endif
  17532. mbedtls_ssl_config_free(&conf);
  17533. }
  17534. // Thread-local storage for SNI captured during handshake
  17535. // This is needed because the SNI callback doesn't have a way to pass
  17536. // session-specific data before the session is fully set up
  17537. inline std::string &mbedpending_sni() {
  17538. static thread_local std::string sni;
  17539. return sni;
  17540. }
  17541. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17542. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17543. const unsigned char *name, size_t name_len) {
  17544. (void)p_ctx;
  17545. (void)ssl;
  17546. // Store SNI name in thread-local storage
  17547. // It will be retrieved and stored in the session after handshake
  17548. if (name && name_len > 0) {
  17549. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17550. } else {
  17551. mbedpending_sni().clear();
  17552. }
  17553. return 0; // Accept any SNI
  17554. }
  17555. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17556. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17557. }
  17558. // Verify callback used when hostname verification is disabled for a session
  17559. // that has no user-supplied verify callback of its own.
  17560. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17561. mbedtls_x509_crt *, int,
  17562. uint32_t *flags) {
  17563. (void)data;
  17564. mbedtls_clear_cn_mismatch(flags);
  17565. return 0;
  17566. }
  17567. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17568. int cert_depth, uint32_t *flags);
  17569. // MbedTLS verify callback wrapper
  17570. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17571. int cert_depth, uint32_t *flags) {
  17572. // data points to the MbedTlsSession
  17573. auto *session = static_cast<MbedTlsSession *>(data);
  17574. // set_sni() disabled hostname verification for this session: drop the
  17575. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17576. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17577. // SNI. The final pass/fail decision still comes from the remaining flags
  17578. // (or, below, from the user's own verify callback).
  17579. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17580. // Build context
  17581. VerifyContext verify_ctx;
  17582. verify_ctx.session = static_cast<session_t>(session);
  17583. verify_ctx.cert = static_cast<cert_t>(crt);
  17584. verify_ctx.depth = cert_depth;
  17585. verify_ctx.preverify_ok = (*flags == 0);
  17586. verify_ctx.error_code = static_cast<long>(*flags);
  17587. // Convert Mbed TLS flags to error string
  17588. static thread_local char error_buf[256];
  17589. if (*flags != 0) {
  17590. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17591. verify_ctx.error_string = error_buf;
  17592. } else {
  17593. verify_ctx.error_string = nullptr;
  17594. }
  17595. bool accepted = session->verify_callback(verify_ctx);
  17596. if (accepted) {
  17597. *flags = 0; // Clear all error flags
  17598. return 0;
  17599. }
  17600. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17601. }
  17602. } // namespace impl
  17603. inline ctx_t create_client_context() {
  17604. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17605. if (!ctx) { return nullptr; }
  17606. ctx->is_server = false;
  17607. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17608. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17609. if (!detail::ensure_mbedtls_psa_crypto()) {
  17610. delete ctx;
  17611. return nullptr;
  17612. }
  17613. int ret;
  17614. #else
  17615. // Seed the random number generator
  17616. const char *pers = "httplib_client";
  17617. int ret = mbedtls_ctr_drbg_seed(
  17618. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17619. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17620. if (ret != 0) {
  17621. impl::mbedtls_last_error() = ret;
  17622. delete ctx;
  17623. return nullptr;
  17624. }
  17625. #endif
  17626. // Set up SSL config for client
  17627. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17628. MBEDTLS_SSL_TRANSPORT_STREAM,
  17629. MBEDTLS_SSL_PRESET_DEFAULT);
  17630. if (ret != 0) {
  17631. impl::mbedtls_last_error() = ret;
  17632. delete ctx;
  17633. return nullptr;
  17634. }
  17635. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17636. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17637. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17638. #endif
  17639. // Default: verify peer certificate
  17640. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17641. // Set minimum TLS version to 1.2
  17642. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17643. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17644. #else
  17645. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17646. MBEDTLS_SSL_MINOR_VERSION_3);
  17647. #endif
  17648. return static_cast<ctx_t>(ctx);
  17649. }
  17650. inline ctx_t create_server_context() {
  17651. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17652. if (!ctx) { return nullptr; }
  17653. ctx->is_server = true;
  17654. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17655. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17656. if (!detail::ensure_mbedtls_psa_crypto()) {
  17657. delete ctx;
  17658. return nullptr;
  17659. }
  17660. int ret;
  17661. #else
  17662. // Seed the random number generator
  17663. const char *pers = "httplib_server";
  17664. int ret = mbedtls_ctr_drbg_seed(
  17665. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17666. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17667. if (ret != 0) {
  17668. impl::mbedtls_last_error() = ret;
  17669. delete ctx;
  17670. return nullptr;
  17671. }
  17672. #endif
  17673. // Set up SSL config for server
  17674. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17675. MBEDTLS_SSL_TRANSPORT_STREAM,
  17676. MBEDTLS_SSL_PRESET_DEFAULT);
  17677. if (ret != 0) {
  17678. impl::mbedtls_last_error() = ret;
  17679. delete ctx;
  17680. return nullptr;
  17681. }
  17682. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17683. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17684. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17685. #endif
  17686. // Default: don't verify client
  17687. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17688. // Set minimum TLS version to 1.2
  17689. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17690. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17691. #else
  17692. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17693. MBEDTLS_SSL_MINOR_VERSION_3);
  17694. #endif
  17695. // Set SNI callback to capture client's SNI hostname
  17696. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17697. return static_cast<ctx_t>(ctx);
  17698. }
  17699. inline void free_context(ctx_t ctx) {
  17700. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17701. }
  17702. inline bool set_min_version(ctx_t ctx, Version version) {
  17703. if (!ctx) { return false; }
  17704. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17705. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17706. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17707. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17708. if (version >= Version::TLS1_3) {
  17709. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17710. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17711. #endif
  17712. }
  17713. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17714. #else
  17715. // Mbed TLS 2.x uses major/minor version numbers
  17716. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17717. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17718. if (version >= Version::TLS1_3) {
  17719. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17720. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17721. #else
  17722. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17723. #endif
  17724. }
  17725. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17726. #endif
  17727. return true;
  17728. }
  17729. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17730. if (!ctx || !pem) { return false; }
  17731. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17732. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17733. // Add null terminator if not present
  17734. std::string pem_str(pem, len);
  17735. int ret = mbedtls_x509_crt_parse(
  17736. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17737. pem_str.size() + 1);
  17738. if (ret != 0) {
  17739. impl::mbedtls_last_error() = ret;
  17740. return false;
  17741. }
  17742. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17743. return true;
  17744. }
  17745. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17746. if (!ctx || !file_path) { return false; }
  17747. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17748. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17749. if (ret != 0) {
  17750. impl::mbedtls_last_error() = ret;
  17751. return false;
  17752. }
  17753. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17754. return true;
  17755. }
  17756. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17757. if (!ctx || !dir_path) { return false; }
  17758. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17759. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17760. if (ret < 0) { // Returns number of certs on success, negative on error
  17761. impl::mbedtls_last_error() = ret;
  17762. return false;
  17763. }
  17764. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17765. return true;
  17766. }
  17767. inline bool load_system_certs(ctx_t ctx) {
  17768. if (!ctx) { return false; }
  17769. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17770. bool loaded = false;
  17771. #ifdef _WIN32
  17772. loaded = impl::enumerate_windows_system_certs(
  17773. [&](const unsigned char *data, size_t len) {
  17774. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17775. });
  17776. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17777. loaded = impl::enumerate_macos_keychain_certs(
  17778. [&](const unsigned char *data, size_t len) {
  17779. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17780. });
  17781. #else
  17782. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17783. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17784. loaded = true;
  17785. break;
  17786. }
  17787. }
  17788. if (!loaded) {
  17789. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17790. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17791. loaded = true;
  17792. break;
  17793. }
  17794. }
  17795. }
  17796. #endif
  17797. if (loaded) {
  17798. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17799. }
  17800. return loaded;
  17801. }
  17802. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17803. const char *password) {
  17804. if (!ctx || !cert || !key) { return false; }
  17805. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17806. // Parse certificate
  17807. std::string cert_str(cert);
  17808. int ret = mbedtls_x509_crt_parse(
  17809. &mctx->own_cert,
  17810. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17811. cert_str.size() + 1);
  17812. if (ret != 0) {
  17813. impl::mbedtls_last_error() = ret;
  17814. return false;
  17815. }
  17816. // Parse private key
  17817. std::string key_str(key);
  17818. const unsigned char *pwd =
  17819. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17820. size_t pwd_len = password ? strlen(password) : 0;
  17821. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17822. ret = mbedtls_pk_parse_key(
  17823. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17824. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17825. &mctx->ctr_drbg);
  17826. #else
  17827. ret = mbedtls_pk_parse_key(
  17828. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17829. key_str.size() + 1, pwd, pwd_len);
  17830. #endif
  17831. if (ret != 0) {
  17832. impl::mbedtls_last_error() = ret;
  17833. return false;
  17834. }
  17835. // Verify that the certificate and private key match.
  17836. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17837. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17838. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17839. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17840. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17841. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17842. #else
  17843. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17844. #endif
  17845. if (ret != 0) {
  17846. impl::mbedtls_last_error() = ret;
  17847. return false;
  17848. }
  17849. #endif
  17850. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17851. if (ret != 0) {
  17852. impl::mbedtls_last_error() = ret;
  17853. return false;
  17854. }
  17855. return true;
  17856. }
  17857. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17858. const char *key_path, const char *password) {
  17859. if (!ctx || !cert_path || !key_path) { return false; }
  17860. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17861. // Parse certificate file
  17862. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17863. if (ret != 0) {
  17864. impl::mbedtls_last_error() = ret;
  17865. return false;
  17866. }
  17867. // Parse private key file
  17868. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17869. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17870. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17871. #else
  17872. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17873. #endif
  17874. if (ret != 0) {
  17875. impl::mbedtls_last_error() = ret;
  17876. return false;
  17877. }
  17878. // Verify that the certificate and private key match.
  17879. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17880. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17881. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17882. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17883. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17884. #else
  17885. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17886. #endif
  17887. if (ret != 0) {
  17888. impl::mbedtls_last_error() = ret;
  17889. return false;
  17890. }
  17891. #endif
  17892. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17893. if (ret != 0) {
  17894. impl::mbedtls_last_error() = ret;
  17895. return false;
  17896. }
  17897. return true;
  17898. }
  17899. inline void set_verify_client(ctx_t ctx, bool require) {
  17900. if (!ctx) { return; }
  17901. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17902. mctx->verify_client = require;
  17903. if (require) {
  17904. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17905. } else {
  17906. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17907. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17908. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->verify_callback
  17909. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17910. : MBEDTLS_SSL_VERIFY_NONE);
  17911. }
  17912. }
  17913. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17914. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17915. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17916. auto session = new (std::nothrow) impl::MbedTlsSession();
  17917. if (!session) { return nullptr; }
  17918. session->sock = sock;
  17919. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17920. if (ret != 0) {
  17921. impl::mbedtls_last_error() = ret;
  17922. delete session;
  17923. return nullptr;
  17924. }
  17925. // Explicitly opt out of in-handshake hostname verification by default;
  17926. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17927. // fails outright when no hostname was set. set_sni() installs the real
  17928. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17929. // caller verifies the certificate identity post-handshake via
  17930. // verify_hostname().
  17931. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17932. // Set BIO callbacks
  17933. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17934. impl::mbedtls_net_recv_cb, nullptr);
  17935. // Set per-session verify callback with session pointer if callback is
  17936. // registered
  17937. session->verify_callback = mctx->verify_callback;
  17938. if (session->verify_callback) {
  17939. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17940. session);
  17941. }
  17942. return static_cast<session_t>(session);
  17943. }
  17944. inline void free_session(session_t session) {
  17945. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17946. }
  17947. inline bool set_sni(session_t session, const char *hostname,
  17948. bool verify_hostname) {
  17949. if (!session || !hostname) { return false; }
  17950. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17951. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17952. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17953. // independently, so a disabled hostname check is handled below by masking
  17954. // the resulting mismatch flag instead of skipping this call.
  17955. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17956. if (ret != 0) {
  17957. impl::mbedtls_last_error() = ret;
  17958. return false;
  17959. }
  17960. msession->hostname = hostname;
  17961. if (!verify_hostname) {
  17962. msession->suppress_hostname_mismatch = true;
  17963. // If a user verify callback is already wired for this session,
  17964. // mbedtls_verify_callback() masks the mismatch flag itself before
  17965. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17966. // here would be redundant. Otherwise install the masking callback alone.
  17967. if (!msession->verify_callback) {
  17968. mbedtls_ssl_set_verify(&msession->ssl,
  17969. impl::mbedtls_mask_hostname_mismatch_callback,
  17970. msession);
  17971. }
  17972. }
  17973. return true;
  17974. }
  17975. inline TlsError connect(session_t session) {
  17976. TlsError err;
  17977. if (!session) {
  17978. err.code = ErrorCode::Fatal;
  17979. return err;
  17980. }
  17981. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17982. int ret;
  17983. do {
  17984. ret = mbedtls_ssl_handshake(&msession->ssl);
  17985. } while (impl::mbedtls_is_session_ticket(ret));
  17986. if (ret == 0) {
  17987. err.code = ErrorCode::Success;
  17988. } else {
  17989. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17990. impl::mbedtls_last_error() = ret;
  17991. }
  17992. return err;
  17993. }
  17994. inline TlsError accept(session_t session) {
  17995. // Same as connect for Mbed TLS - handshake works for both client and server
  17996. auto result = connect(session);
  17997. // After successful handshake, capture SNI from thread-local storage
  17998. if (result.code == ErrorCode::Success && session) {
  17999. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18000. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18001. impl::mbedpending_sni().clear();
  18002. }
  18003. return result;
  18004. }
  18005. inline bool connect_nonblocking(session_t session, socket_t sock,
  18006. time_t timeout_sec, time_t timeout_usec,
  18007. TlsError *err) {
  18008. if (!session) {
  18009. if (err) { err->code = ErrorCode::Fatal; }
  18010. return false;
  18011. }
  18012. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18013. // Set socket to non-blocking mode
  18014. detail::set_nonblocking(sock, true);
  18015. auto cleanup =
  18016. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18017. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18018. int ret;
  18019. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18020. // Non-fatal TLS 1.3 ticket; retry immediately.
  18021. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18022. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18023. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18024. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18025. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18026. }
  18027. // TlsError or timeout
  18028. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18029. impl::mbedtls_last_error() = ret;
  18030. return false;
  18031. }
  18032. if (err) { err->code = ErrorCode::Success; }
  18033. return true;
  18034. }
  18035. inline bool accept_nonblocking(session_t session, socket_t sock,
  18036. time_t timeout_sec, time_t timeout_usec,
  18037. TlsError *err) {
  18038. // Same implementation as connect for Mbed TLS
  18039. bool result =
  18040. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18041. // After successful handshake, capture SNI from thread-local storage
  18042. if (result && session) {
  18043. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18044. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18045. impl::mbedpending_sni().clear();
  18046. }
  18047. return result;
  18048. }
  18049. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18050. if (!session || !buf) {
  18051. err.code = ErrorCode::Fatal;
  18052. return -1;
  18053. }
  18054. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18055. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18056. if (msession->has_peeked_byte) {
  18057. if (len == 0) { return 0; }
  18058. auto p = static_cast<unsigned char *>(buf);
  18059. p[0] = msession->peeked_byte;
  18060. msession->has_peeked_byte = false;
  18061. size_t n = 1;
  18062. // Top up with any already-decrypted bytes without risking a block.
  18063. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18064. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18065. if (extra > 0) { n += static_cast<size_t>(extra); }
  18066. }
  18067. err.code = ErrorCode::Success;
  18068. return static_cast<ssize_t>(n);
  18069. }
  18070. int ret;
  18071. do {
  18072. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18073. len);
  18074. } while (impl::mbedtls_is_session_ticket(ret));
  18075. if (ret > 0) {
  18076. err.code = ErrorCode::Success;
  18077. return static_cast<ssize_t>(ret);
  18078. }
  18079. if (ret == 0) {
  18080. err.code = ErrorCode::PeerClosed;
  18081. return 0;
  18082. }
  18083. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18084. err.backend_code = static_cast<uint64_t>(-ret);
  18085. impl::mbedtls_last_error() = ret;
  18086. // mbedTLS signals a clean close_notify via a negative error code rather
  18087. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18088. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18089. return -1;
  18090. }
  18091. inline ssize_t write(session_t session, const void *buf, size_t len,
  18092. TlsError &err) {
  18093. if (!session || !buf) {
  18094. err.code = ErrorCode::Fatal;
  18095. return -1;
  18096. }
  18097. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18098. int ret;
  18099. do {
  18100. ret = mbedtls_ssl_write(&msession->ssl,
  18101. static_cast<const unsigned char *>(buf), len);
  18102. } while (impl::mbedtls_is_session_ticket(ret));
  18103. if (ret > 0) {
  18104. err.code = ErrorCode::Success;
  18105. return static_cast<ssize_t>(ret);
  18106. }
  18107. if (ret == 0) {
  18108. err.code = ErrorCode::PeerClosed;
  18109. return 0;
  18110. }
  18111. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18112. err.backend_code = static_cast<uint64_t>(-ret);
  18113. impl::mbedtls_last_error() = ret;
  18114. return -1;
  18115. }
  18116. inline int pending(const_session_t session) {
  18117. if (!session) { return 0; }
  18118. auto msession =
  18119. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18120. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18121. (msession->has_peeked_byte ? 1 : 0);
  18122. }
  18123. inline void shutdown(session_t session, bool graceful) {
  18124. if (!session) { return; }
  18125. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18126. if (graceful) {
  18127. // Try to send close_notify, but don't block forever
  18128. int ret;
  18129. int attempts = 0;
  18130. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18131. attempts < 3) {
  18132. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18133. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18134. break;
  18135. }
  18136. attempts++;
  18137. }
  18138. }
  18139. }
  18140. inline bool is_peer_closed(session_t session, socket_t sock) {
  18141. if (!session || sock == INVALID_SOCKET) { return true; }
  18142. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18143. // Check if there's already decrypted or pushed-back data available.
  18144. // If so, the connection is definitely alive.
  18145. if (msession->has_peeked_byte ||
  18146. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18147. return false;
  18148. }
  18149. // Set socket to non-blocking to avoid blocking on read
  18150. detail::set_nonblocking(sock, true);
  18151. auto cleanup =
  18152. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18153. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18154. // on application data — e.g. a response that already arrived — push the
  18155. // byte back so the next read() delivers it instead of losing it.
  18156. unsigned char buf;
  18157. int ret;
  18158. do {
  18159. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18160. } while (impl::mbedtls_is_session_ticket(ret));
  18161. // If we got data or WANT_READ (would block), connection is alive
  18162. if (ret > 0) {
  18163. msession->peeked_byte = buf;
  18164. msession->has_peeked_byte = true;
  18165. return false;
  18166. }
  18167. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18168. // If we get a peer close notify or a connection reset, the peer is closed
  18169. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18170. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18171. }
  18172. inline cert_t get_peer_cert(const_session_t session) {
  18173. if (!session) { return nullptr; }
  18174. auto msession =
  18175. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18176. // Mbed TLS returns a pointer to the internal peer cert chain.
  18177. // WARNING: This pointer is only valid while the session is active.
  18178. // Do not use the certificate after calling free_session().
  18179. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18180. return const_cast<mbedtls_x509_crt *>(cert);
  18181. }
  18182. inline size_t get_peer_certs(const_session_t session,
  18183. std::vector<cert_t> &certs) {
  18184. certs.clear();
  18185. // Mbed TLS parses the whole received chain into a list headed by the peer
  18186. // certificate, owned by the session like get_peer_cert()'s result
  18187. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18188. crt && crt->raw.len > 0; crt = crt->next) {
  18189. certs.push_back(static_cast<cert_t>(crt));
  18190. }
  18191. return certs.size();
  18192. }
  18193. inline void free_cert(cert_t cert) {
  18194. // Mbed TLS: peer certificate is owned by the SSL context.
  18195. // No-op here, but callers should still call this for cross-backend
  18196. // portability.
  18197. (void)cert;
  18198. }
  18199. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18200. if (!cert || !hostname) { return false; }
  18201. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18202. std::string host_str(hostname);
  18203. // Check if hostname is an IP address (IPv4 or IPv6)
  18204. unsigned char ip_bytes[16];
  18205. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18206. auto is_ip = ip_len > 0;
  18207. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18208. // in buf.tag and the raw value in buf.p / buf.len.
  18209. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  18210. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  18211. const unsigned char *p = san->buf.p;
  18212. size_t len = san->buf.len;
  18213. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18214. if (is_ip) {
  18215. // For an IP host, only a matching iPAddress SAN of the same family
  18216. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18217. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18218. memcmp(p, ip_bytes, ip_len) == 0) {
  18219. return true;
  18220. }
  18221. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18222. std::string san_name(reinterpret_cast<const char *>(p), len);
  18223. if (detail::match_hostname(san_name, host_str)) { return true; }
  18224. }
  18225. san = san->next;
  18226. }
  18227. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18228. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18229. // the OpenSSL backend's X509_check_ip behaves the same way).
  18230. if (!is_ip) {
  18231. char cn[256];
  18232. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  18233. if (ret > 0) {
  18234. std::string cn_str(cn);
  18235. // Look for "CN=" in the DN string
  18236. size_t cn_pos = cn_str.find("CN=");
  18237. if (cn_pos != std::string::npos) {
  18238. size_t start = cn_pos + 3;
  18239. size_t end = cn_str.find(',', start);
  18240. std::string cn_value =
  18241. cn_str.substr(start, end == std::string::npos ? end : end - start);
  18242. if (detail::match_hostname(cn_value, host_str)) { return true; }
  18243. }
  18244. }
  18245. }
  18246. return false;
  18247. }
  18248. inline uint64_t hostname_mismatch_code() {
  18249. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18250. }
  18251. inline long get_verify_result(const_session_t session) {
  18252. if (!session) { return -1; }
  18253. auto msession =
  18254. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18255. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18256. // Return 0 (X509_V_OK equivalent) if verification passed
  18257. return flags == 0 ? 0 : static_cast<long>(flags);
  18258. }
  18259. inline std::string get_cert_subject_cn(cert_t cert) {
  18260. if (!cert) return "";
  18261. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18262. // Find the CN in the subject
  18263. const mbedtls_x509_name *name = &x509->subject;
  18264. while (name != nullptr) {
  18265. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18266. return std::string(reinterpret_cast<const char *>(name->val.p),
  18267. name->val.len);
  18268. }
  18269. name = name->next;
  18270. }
  18271. return "";
  18272. }
  18273. inline std::string get_cert_issuer_name(cert_t cert) {
  18274. if (!cert) return "";
  18275. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18276. // Build a human-readable issuer name string
  18277. char buf[512];
  18278. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18279. if (ret < 0) return "";
  18280. return std::string(buf);
  18281. }
  18282. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18283. sans.clear();
  18284. if (!cert) return false;
  18285. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18286. // Parse the Subject Alternative Name extension
  18287. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18288. while (cur != nullptr) {
  18289. if (cur->buf.len > 0) {
  18290. const unsigned char *p = cur->buf.p;
  18291. size_t value_len = cur->buf.len;
  18292. SanEntry entry;
  18293. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18294. case MBEDTLS_X509_SAN_DNS_NAME:
  18295. entry.type = SanType::DNS;
  18296. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18297. break;
  18298. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18299. entry.type = SanType::IP;
  18300. if (value_len == 4) {
  18301. // IPv4
  18302. char buf[16];
  18303. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18304. entry.value = buf;
  18305. } else if (value_len == 16) {
  18306. // IPv6
  18307. char buf[64];
  18308. snprintf(buf, sizeof(buf),
  18309. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18310. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18311. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18312. p[10], p[11], p[12], p[13], p[14], p[15]);
  18313. entry.value = buf;
  18314. }
  18315. break;
  18316. case MBEDTLS_X509_SAN_RFC822_NAME:
  18317. entry.type = SanType::EMAIL;
  18318. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18319. break;
  18320. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18321. entry.type = SanType::URI;
  18322. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18323. break;
  18324. default: entry.type = SanType::OTHER; break;
  18325. }
  18326. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18327. }
  18328. cur = cur->next;
  18329. }
  18330. return true;
  18331. }
  18332. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18333. time_t &not_after) {
  18334. if (!cert) return false;
  18335. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18336. // Convert mbedtls_x509_time to time_t
  18337. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18338. struct tm tm_time = {};
  18339. tm_time.tm_year = t.year - 1900;
  18340. tm_time.tm_mon = t.mon - 1;
  18341. tm_time.tm_mday = t.day;
  18342. tm_time.tm_hour = t.hour;
  18343. tm_time.tm_min = t.min;
  18344. tm_time.tm_sec = t.sec;
  18345. #ifdef _WIN32
  18346. return _mkgmtime(&tm_time);
  18347. #else
  18348. return timegm(&tm_time);
  18349. #endif
  18350. };
  18351. not_before = to_time_t(x509->valid_from);
  18352. not_after = to_time_t(x509->valid_to);
  18353. return true;
  18354. }
  18355. inline std::string get_cert_serial(cert_t cert) {
  18356. if (!cert) return "";
  18357. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18358. // Convert serial number to hex string
  18359. std::string result;
  18360. result.reserve(x509->serial.len * 2);
  18361. for (size_t i = 0; i < x509->serial.len; i++) {
  18362. char hex[3];
  18363. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18364. result += hex;
  18365. }
  18366. return result;
  18367. }
  18368. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18369. if (!cert) return false;
  18370. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18371. if (!crt->raw.p || crt->raw.len == 0) return false;
  18372. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18373. return true;
  18374. }
  18375. inline const char *get_sni(const_session_t session) {
  18376. if (!session) return nullptr;
  18377. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18378. // For server: return SNI received from client during handshake
  18379. if (!msession->sni_hostname.empty()) {
  18380. return msession->sni_hostname.c_str();
  18381. }
  18382. // For client: return the hostname set via set_sni
  18383. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18384. return nullptr;
  18385. }
  18386. inline uint64_t peek_error() {
  18387. // Mbed TLS doesn't have an error queue, return the last error
  18388. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18389. }
  18390. inline uint64_t get_error() {
  18391. // Mbed TLS doesn't have an error queue, return and clear the last error
  18392. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18393. impl::mbedtls_last_error() = 0;
  18394. return err;
  18395. }
  18396. inline std::string error_string(uint64_t code) {
  18397. char buf[256];
  18398. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18399. return std::string(buf);
  18400. }
  18401. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18402. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18403. if (!ca_chain) { return nullptr; }
  18404. mbedtls_x509_crt_init(ca_chain);
  18405. // mbedtls_x509_crt_parse expects null-terminated PEM
  18406. int ret = mbedtls_x509_crt_parse(ca_chain,
  18407. reinterpret_cast<const unsigned char *>(pem),
  18408. len + 1); // +1 for null terminator
  18409. if (ret != 0) {
  18410. // Try without +1 in case PEM is already null-terminated
  18411. ret = mbedtls_x509_crt_parse(
  18412. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18413. if (ret != 0) {
  18414. mbedtls_x509_crt_free(ca_chain);
  18415. delete ca_chain;
  18416. return nullptr;
  18417. }
  18418. }
  18419. return static_cast<ca_store_t>(ca_chain);
  18420. }
  18421. inline void free_ca_store(ca_store_t store) {
  18422. if (store) {
  18423. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18424. mbedtls_x509_crt_free(ca_chain);
  18425. delete ca_chain;
  18426. }
  18427. }
  18428. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18429. if (!ctx || !store) { return false; }
  18430. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18431. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18432. // Free existing CA chain
  18433. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18434. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18435. // Copy the CA chain (deep copy)
  18436. // Parse from the raw data of the source cert
  18437. mbedtls_x509_crt *src = ca_chain;
  18438. while (src != nullptr) {
  18439. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18440. src->raw.len);
  18441. if (ret != 0) {
  18442. free_ca_store(store);
  18443. return false;
  18444. }
  18445. src = src->next;
  18446. }
  18447. // This function takes ownership of the store; the chain was deep-copied
  18448. // above, so release the source
  18449. free_ca_store(store);
  18450. // Update the SSL config to use the new CA chain
  18451. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18452. return true;
  18453. }
  18454. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18455. certs.clear();
  18456. if (!ctx) { return 0; }
  18457. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18458. // Iterate through the CA chain
  18459. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18460. while (cert != nullptr && cert->raw.len > 0) {
  18461. // Create a copy of the certificate for the caller
  18462. auto *copy = new mbedtls_x509_crt;
  18463. mbedtls_x509_crt_init(copy);
  18464. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18465. if (ret == 0) {
  18466. certs.push_back(static_cast<cert_t>(copy));
  18467. } else {
  18468. mbedtls_x509_crt_free(copy);
  18469. delete copy;
  18470. }
  18471. cert = cert->next;
  18472. }
  18473. return certs.size();
  18474. }
  18475. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18476. std::vector<std::string> names;
  18477. if (!ctx) { return names; }
  18478. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18479. // Iterate through the CA chain
  18480. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18481. while (cert != nullptr && cert->raw.len > 0) {
  18482. char buf[512];
  18483. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18484. if (ret > 0) { names.push_back(buf); }
  18485. cert = cert->next;
  18486. }
  18487. return names;
  18488. }
  18489. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18490. const char *key_pem, const char *password) {
  18491. if (!ctx || !cert_pem || !key_pem) { return false; }
  18492. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18493. // Parse into new objects first, so that a bad pair leaves the old one in
  18494. // place, and swap them in after; the old ones are freed on the way out.
  18495. mbedtls_x509_crt cert;
  18496. mbedtls_pk_context key;
  18497. mbedtls_x509_crt_init(&cert);
  18498. mbedtls_pk_init(&key);
  18499. auto se = detail::scope_exit([&] {
  18500. mbedtls_x509_crt_free(&cert);
  18501. mbedtls_pk_free(&key);
  18502. });
  18503. // Parse certificate PEM
  18504. int ret = mbedtls_x509_crt_parse(
  18505. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18506. strlen(cert_pem) + 1);
  18507. if (ret != 0) {
  18508. impl::mbedtls_last_error() = ret;
  18509. return false;
  18510. }
  18511. // Parse private key PEM
  18512. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18513. ret = mbedtls_pk_parse_key(
  18514. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18515. strlen(key_pem) + 1,
  18516. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18517. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18518. &mbed_ctx->ctr_drbg);
  18519. #else
  18520. ret = mbedtls_pk_parse_key(
  18521. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18522. strlen(key_pem) + 1,
  18523. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18524. password ? strlen(password) : 0);
  18525. #endif
  18526. if (ret != 0) {
  18527. impl::mbedtls_last_error() = ret;
  18528. return false;
  18529. }
  18530. std::swap(mbed_ctx->own_cert, cert);
  18531. std::swap(mbed_ctx->own_key, key);
  18532. // Configure SSL to use the new certificate and key
  18533. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18534. &mbed_ctx->own_key);
  18535. if (ret != 0) {
  18536. impl::mbedtls_last_error() = ret;
  18537. return false;
  18538. }
  18539. return true;
  18540. }
  18541. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18542. if (!ctx || !ca_pem) { return false; }
  18543. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18544. // Parse into a new chain first, so that a bad one leaves the old in place
  18545. mbedtls_x509_crt chain;
  18546. mbedtls_x509_crt_init(&chain);
  18547. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  18548. // Parse CA PEM
  18549. int ret = mbedtls_x509_crt_parse(
  18550. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18551. strlen(ca_pem) + 1);
  18552. if (ret != 0) {
  18553. impl::mbedtls_last_error() = ret;
  18554. return false;
  18555. }
  18556. std::swap(mbed_ctx->ca_chain, chain);
  18557. // Update SSL config to use new CA chain
  18558. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18559. return true;
  18560. }
  18561. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18562. if (!ctx) { return false; }
  18563. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18564. // create_session() hands each session its own copy to run.
  18565. mbed_ctx->verify_callback = std::move(callback);
  18566. if (mbed_ctx->verify_callback) {
  18567. // Set OPTIONAL mode to ensure callback is called even when verification
  18568. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18569. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18570. }
  18571. return true;
  18572. }
  18573. inline long get_verify_error(const_session_t session) {
  18574. if (!session) { return -1; }
  18575. auto *msession =
  18576. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18577. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18578. }
  18579. inline std::string verify_error_string(long error_code) {
  18580. if (error_code == 0) { return ""; }
  18581. char buf[256];
  18582. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18583. static_cast<uint32_t>(error_code));
  18584. // Remove trailing newline if present
  18585. std::string result(buf);
  18586. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18587. result.pop_back();
  18588. }
  18589. return result;
  18590. }
  18591. } // namespace tls
  18592. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18593. /*
  18594. * Group 10: TLS abstraction layer - wolfSSL backend
  18595. */
  18596. /*
  18597. * wolfSSL Backend Implementation
  18598. */
  18599. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18600. namespace tls {
  18601. namespace impl {
  18602. // wolfSSL session wrapper
  18603. struct WolfSSLSession {
  18604. WOLFSSL *ssl = nullptr;
  18605. socket_t sock = INVALID_SOCKET;
  18606. std::string hostname; // For client: set via set_sni
  18607. std::string sni_hostname; // For server: received from client via SNI callback
  18608. WolfSSLSession() = default;
  18609. ~WolfSSLSession() {
  18610. if (ssl) { wolfSSL_free(ssl); }
  18611. }
  18612. WolfSSLSession(const WolfSSLSession &) = delete;
  18613. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18614. };
  18615. // Thread-local error code accessor for wolfSSL
  18616. inline uint64_t &wolfssl_last_error() {
  18617. static thread_local uint64_t err = 0;
  18618. return err;
  18619. }
  18620. // Helper to map wolfSSL error to ErrorCode.
  18621. // ssl_error is the value from wolfSSL_get_error().
  18622. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18623. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18624. int &out_errno) {
  18625. switch (ssl_error) {
  18626. case SSL_ERROR_NONE: return ErrorCode::Success;
  18627. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18628. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18629. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18630. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18631. default:
  18632. if (ssl) {
  18633. // wolfSSL stores the low-level error code as a negative value.
  18634. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18635. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18636. if (low_err == DOMAIN_NAME_MISMATCH) {
  18637. return ErrorCode::HostnameMismatch;
  18638. }
  18639. // Check verify result to distinguish cert verification from generic SSL
  18640. // errors.
  18641. long vr = wolfSSL_get_verify_result(ssl);
  18642. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18643. }
  18644. return ErrorCode::Fatal;
  18645. }
  18646. }
  18647. // WolfSSLContext constructor/destructor implementations
  18648. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18649. inline WolfSSLContext::~WolfSSLContext() {
  18650. if (ctx) { wolfSSL_CTX_free(ctx); }
  18651. }
  18652. // Thread-local storage for SNI captured during handshake
  18653. inline std::string &wolfssl_pending_sni() {
  18654. static thread_local std::string sni;
  18655. return sni;
  18656. }
  18657. // SNI callback for wolfSSL server to capture client's SNI hostname
  18658. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18659. (void)ret;
  18660. (void)exArg;
  18661. void *name_data = nullptr;
  18662. unsigned short name_len =
  18663. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18664. if (name_data && name_len > 0) {
  18665. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18666. name_len);
  18667. } else {
  18668. wolfssl_pending_sni().clear();
  18669. }
  18670. return 0; // Continue regardless
  18671. }
  18672. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18673. // runs the verify callback of its own context.
  18674. inline int context_ex_data_index() {
  18675. static const auto index =
  18676. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18677. return index;
  18678. }
  18679. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  18680. // other tls:: function takes.
  18681. inline int session_ex_data_index() {
  18682. static const auto index =
  18683. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18684. return index;
  18685. }
  18686. // wolfSSL verify callback wrapper
  18687. inline int wolfssl_verify_callback(int preverify_ok,
  18688. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18689. // Get the WOLFSSL object from the X509_STORE_CTX
  18690. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18691. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18692. if (!ssl) { return preverify_ok; }
  18693. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  18694. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  18695. if (!wctx || !wctx->verify_callback) { return preverify_ok; }
  18696. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18697. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18698. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18699. VerifyContext verify_ctx;
  18700. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  18701. verify_ctx.cert = static_cast<cert_t>(cert);
  18702. verify_ctx.depth = depth;
  18703. verify_ctx.preverify_ok = (preverify_ok != 0);
  18704. verify_ctx.error_code = static_cast<long>(err);
  18705. if (err != 0) {
  18706. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18707. } else {
  18708. verify_ctx.error_string = nullptr;
  18709. }
  18710. bool accepted = wctx->verify_callback(verify_ctx);
  18711. return accepted ? 1 : 0;
  18712. }
  18713. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18714. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18715. wolfSSL_CTX_set_default_passwd_cb(
  18716. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18717. auto *pwd = static_cast<const char *>(userdata);
  18718. if (!pwd) return 0;
  18719. auto len = static_cast<int>(strlen(pwd));
  18720. if (len > size) len = size;
  18721. memcpy(buf, pwd, static_cast<size_t>(len));
  18722. return len;
  18723. });
  18724. }
  18725. } // namespace impl
  18726. inline ctx_t create_client_context() {
  18727. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18728. if (!ctx) { return nullptr; }
  18729. ctx->is_server = false;
  18730. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18731. if (!method) {
  18732. delete ctx;
  18733. return nullptr;
  18734. }
  18735. ctx->ctx = wolfSSL_CTX_new(method);
  18736. if (!ctx->ctx ||
  18737. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18738. WOLFSSL_SUCCESS) {
  18739. delete ctx;
  18740. return nullptr;
  18741. }
  18742. // Default: verify peer certificate
  18743. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18744. return static_cast<ctx_t>(ctx);
  18745. }
  18746. inline ctx_t create_server_context() {
  18747. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18748. if (!ctx) { return nullptr; }
  18749. ctx->is_server = true;
  18750. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18751. if (!method) {
  18752. delete ctx;
  18753. return nullptr;
  18754. }
  18755. ctx->ctx = wolfSSL_CTX_new(method);
  18756. if (!ctx->ctx ||
  18757. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18758. WOLFSSL_SUCCESS) {
  18759. delete ctx;
  18760. return nullptr;
  18761. }
  18762. // Default: don't verify client
  18763. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18764. // Enable SNI on server
  18765. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18766. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18767. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18768. return static_cast<ctx_t>(ctx);
  18769. }
  18770. inline void free_context(ctx_t ctx) {
  18771. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18772. }
  18773. inline bool set_min_version(ctx_t ctx, Version version) {
  18774. if (!ctx) { return false; }
  18775. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18776. int min_ver = WOLFSSL_TLSV1_2;
  18777. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18778. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18779. }
  18780. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18781. if (!ctx || !pem) { return false; }
  18782. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18783. int ret = wolfSSL_CTX_load_verify_buffer(
  18784. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18785. static_cast<long>(len), SSL_FILETYPE_PEM);
  18786. if (ret != SSL_SUCCESS) {
  18787. impl::wolfssl_last_error() =
  18788. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18789. return false;
  18790. }
  18791. wctx->ca_pem_data_.append(pem, len);
  18792. return true;
  18793. }
  18794. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18795. if (!ctx || !file_path) { return false; }
  18796. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18797. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18798. if (ret != SSL_SUCCESS) {
  18799. impl::wolfssl_last_error() =
  18800. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18801. return false;
  18802. }
  18803. return true;
  18804. }
  18805. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18806. if (!ctx || !dir_path) { return false; }
  18807. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18808. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18809. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18810. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18811. // immediately. Return true even on failure since the CA file may have
  18812. // already been loaded, matching OpenSSL's lenient behavior.
  18813. (void)ret;
  18814. return true;
  18815. }
  18816. inline bool load_system_certs(ctx_t ctx) {
  18817. if (!ctx) { return false; }
  18818. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18819. bool loaded = false;
  18820. #ifdef _WIN32
  18821. loaded = impl::enumerate_windows_system_certs(
  18822. [&](const unsigned char *data, size_t len) {
  18823. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18824. static_cast<long>(len),
  18825. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18826. });
  18827. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18828. loaded = impl::enumerate_macos_keychain_certs(
  18829. [&](const unsigned char *data, size_t len) {
  18830. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18831. static_cast<long>(len),
  18832. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18833. });
  18834. #else
  18835. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18836. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18837. SSL_SUCCESS) {
  18838. loaded = true;
  18839. break;
  18840. }
  18841. }
  18842. if (!loaded) {
  18843. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18844. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18845. SSL_SUCCESS) {
  18846. loaded = true;
  18847. break;
  18848. }
  18849. }
  18850. }
  18851. #endif
  18852. return loaded;
  18853. }
  18854. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18855. const char *password) {
  18856. if (!ctx || !cert || !key) { return false; }
  18857. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18858. // Load certificate
  18859. int ret = wolfSSL_CTX_use_certificate_buffer(
  18860. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18861. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18862. if (ret != SSL_SUCCESS) {
  18863. impl::wolfssl_last_error() =
  18864. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18865. return false;
  18866. }
  18867. // Set password callback if password is provided
  18868. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18869. // Load private key
  18870. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18871. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18872. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18873. if (ret != SSL_SUCCESS) {
  18874. impl::wolfssl_last_error() =
  18875. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18876. return false;
  18877. }
  18878. // Verify that the certificate and private key match
  18879. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18880. }
  18881. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18882. const char *key_path, const char *password) {
  18883. if (!ctx || !cert_path || !key_path) { return false; }
  18884. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18885. // Load certificate file
  18886. int ret =
  18887. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18888. if (ret != SSL_SUCCESS) {
  18889. impl::wolfssl_last_error() =
  18890. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18891. return false;
  18892. }
  18893. // Set password callback if password is provided
  18894. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18895. // Load private key file
  18896. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18897. if (ret != SSL_SUCCESS) {
  18898. impl::wolfssl_last_error() =
  18899. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18900. return false;
  18901. }
  18902. // Verify that the certificate and private key match
  18903. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18904. }
  18905. inline void set_verify_client(ctx_t ctx, bool require) {
  18906. if (!ctx) { return; }
  18907. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18908. wctx->verify_client = require;
  18909. if (require) {
  18910. wolfSSL_CTX_set_verify(
  18911. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18912. wctx->verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18913. } else {
  18914. if (wctx->verify_callback) {
  18915. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18916. impl::wolfssl_verify_callback);
  18917. } else {
  18918. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18919. }
  18920. }
  18921. }
  18922. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18923. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18924. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18925. auto session = new (std::nothrow) impl::WolfSSLSession();
  18926. if (!session) { return nullptr; }
  18927. session->sock = sock;
  18928. session->ssl = wolfSSL_new(wctx->ctx);
  18929. if (!session->ssl) {
  18930. impl::wolfssl_last_error() =
  18931. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18932. delete session;
  18933. return nullptr;
  18934. }
  18935. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  18936. session) != WOLFSSL_SUCCESS) {
  18937. delete session;
  18938. return nullptr;
  18939. }
  18940. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18941. return static_cast<session_t>(session);
  18942. }
  18943. inline void free_session(session_t session) {
  18944. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18945. }
  18946. inline bool set_sni(session_t session, const char *hostname,
  18947. bool verify_hostname) {
  18948. if (!session || !hostname) { return false; }
  18949. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18950. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18951. static_cast<word16>(strlen(hostname)));
  18952. if (ret != WOLFSSL_SUCCESS) {
  18953. impl::wolfssl_last_error() =
  18954. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18955. return false;
  18956. }
  18957. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18958. // separately from the SNI extension sent above; skip it when hostname
  18959. // verification is disabled so only the chain is checked, matching OpenSSL.
  18960. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18961. wsession->hostname = hostname;
  18962. return true;
  18963. }
  18964. inline TlsError connect(session_t session) {
  18965. TlsError err;
  18966. if (!session) {
  18967. err.code = ErrorCode::Fatal;
  18968. return err;
  18969. }
  18970. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18971. int ret = wolfSSL_connect(wsession->ssl);
  18972. if (ret == SSL_SUCCESS) {
  18973. err.code = ErrorCode::Success;
  18974. } else {
  18975. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18976. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18977. err.backend_code = static_cast<uint64_t>(ssl_error);
  18978. impl::wolfssl_last_error() = err.backend_code;
  18979. }
  18980. return err;
  18981. }
  18982. inline TlsError accept(session_t session) {
  18983. TlsError err;
  18984. if (!session) {
  18985. err.code = ErrorCode::Fatal;
  18986. return err;
  18987. }
  18988. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18989. int ret = wolfSSL_accept(wsession->ssl);
  18990. if (ret == SSL_SUCCESS) {
  18991. err.code = ErrorCode::Success;
  18992. // Capture SNI from thread-local storage after successful handshake
  18993. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18994. impl::wolfssl_pending_sni().clear();
  18995. } else {
  18996. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18997. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18998. err.backend_code = static_cast<uint64_t>(ssl_error);
  18999. impl::wolfssl_last_error() = err.backend_code;
  19000. }
  19001. return err;
  19002. }
  19003. inline bool connect_nonblocking(session_t session, socket_t sock,
  19004. time_t timeout_sec, time_t timeout_usec,
  19005. TlsError *err) {
  19006. if (!session) {
  19007. if (err) { err->code = ErrorCode::Fatal; }
  19008. return false;
  19009. }
  19010. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19011. // Set socket to non-blocking mode
  19012. detail::set_nonblocking(sock, true);
  19013. auto cleanup =
  19014. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19015. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19016. int ret;
  19017. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19018. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19019. if (ssl_error == SSL_ERROR_WANT_READ) {
  19020. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19021. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19022. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19023. }
  19024. // Error or timeout
  19025. if (err) {
  19026. err->code =
  19027. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19028. err->backend_code = static_cast<uint64_t>(ssl_error);
  19029. }
  19030. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19031. return false;
  19032. }
  19033. if (err) { err->code = ErrorCode::Success; }
  19034. return true;
  19035. }
  19036. inline bool accept_nonblocking(session_t session, socket_t sock,
  19037. time_t timeout_sec, time_t timeout_usec,
  19038. TlsError *err) {
  19039. if (!session) {
  19040. if (err) { err->code = ErrorCode::Fatal; }
  19041. return false;
  19042. }
  19043. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19044. // Set socket to non-blocking mode
  19045. detail::set_nonblocking(sock, true);
  19046. auto cleanup =
  19047. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19048. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19049. int ret;
  19050. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19051. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19052. if (ssl_error == SSL_ERROR_WANT_READ) {
  19053. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19054. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19055. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19056. }
  19057. // Error or timeout
  19058. if (err) {
  19059. err->code =
  19060. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19061. err->backend_code = static_cast<uint64_t>(ssl_error);
  19062. }
  19063. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19064. return false;
  19065. }
  19066. if (err) { err->code = ErrorCode::Success; }
  19067. // Capture SNI from thread-local storage after successful handshake
  19068. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19069. impl::wolfssl_pending_sni().clear();
  19070. return true;
  19071. }
  19072. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19073. if (!session || !buf) {
  19074. err.code = ErrorCode::Fatal;
  19075. return -1;
  19076. }
  19077. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19078. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19079. if (ret > 0) {
  19080. err.code = ErrorCode::Success;
  19081. return static_cast<ssize_t>(ret);
  19082. }
  19083. if (ret == 0) {
  19084. err.code = ErrorCode::PeerClosed;
  19085. return 0;
  19086. }
  19087. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19088. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19089. err.backend_code = static_cast<uint64_t>(ssl_error);
  19090. impl::wolfssl_last_error() = err.backend_code;
  19091. return -1;
  19092. }
  19093. inline ssize_t write(session_t session, const void *buf, size_t len,
  19094. TlsError &err) {
  19095. if (!session || !buf) {
  19096. err.code = ErrorCode::Fatal;
  19097. return -1;
  19098. }
  19099. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19100. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19101. if (ret > 0) {
  19102. err.code = ErrorCode::Success;
  19103. return static_cast<ssize_t>(ret);
  19104. }
  19105. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19106. // Treat this as an error (return -1) so callers don't spin in a
  19107. // write loop adding zero to the offset.
  19108. if (ret == 0) {
  19109. err.code = ErrorCode::PeerClosed;
  19110. return -1;
  19111. }
  19112. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19113. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19114. err.backend_code = static_cast<uint64_t>(ssl_error);
  19115. impl::wolfssl_last_error() = err.backend_code;
  19116. return -1;
  19117. }
  19118. inline int pending(const_session_t session) {
  19119. if (!session) { return 0; }
  19120. auto wsession =
  19121. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19122. return wolfSSL_pending(wsession->ssl);
  19123. }
  19124. inline void shutdown(session_t session, bool graceful) {
  19125. if (!session) { return; }
  19126. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19127. if (graceful) {
  19128. int ret;
  19129. int attempts = 0;
  19130. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19131. attempts < 3) {
  19132. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19133. if (ssl_error != SSL_ERROR_WANT_READ &&
  19134. ssl_error != SSL_ERROR_WANT_WRITE) {
  19135. break;
  19136. }
  19137. attempts++;
  19138. }
  19139. } else {
  19140. wolfSSL_shutdown(wsession->ssl);
  19141. }
  19142. }
  19143. inline bool is_peer_closed(session_t session, socket_t sock) {
  19144. if (!session || sock == INVALID_SOCKET) { return true; }
  19145. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19146. // Check if there's already decrypted data available
  19147. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19148. // Set socket to non-blocking to avoid blocking on read
  19149. detail::set_nonblocking(sock, true);
  19150. auto cleanup =
  19151. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19152. // Peek 1 byte to check connection status without consuming data
  19153. unsigned char buf;
  19154. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19155. // If we got data or WANT_READ (would block), connection is alive
  19156. if (ret > 0) { return false; }
  19157. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19158. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19159. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19160. ret == 0;
  19161. }
  19162. inline cert_t get_peer_cert(const_session_t session) {
  19163. if (!session) { return nullptr; }
  19164. auto wsession =
  19165. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19166. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19167. return static_cast<cert_t>(cert);
  19168. }
  19169. inline size_t get_peer_certs(const_session_t session,
  19170. std::vector<cert_t> &certs) {
  19171. certs.clear();
  19172. if (!session) { return 0; }
  19173. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19174. #ifdef SESSION_CERTS
  19175. auto wsession =
  19176. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19177. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19178. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19179. for (int i = 0; i < count; i++) {
  19180. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19181. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19182. }
  19183. #endif
  19184. return certs.size();
  19185. }
  19186. inline void free_cert(cert_t cert) {
  19187. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19188. }
  19189. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19190. if (!cert || !hostname) { return false; }
  19191. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19192. std::string host_str(hostname);
  19193. // Check if hostname is an IP address (IPv4 or IPv6)
  19194. unsigned char ip_bytes[16];
  19195. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19196. auto is_ip = ip_len > 0;
  19197. // Check Subject Alternative Names
  19198. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19199. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19200. if (san_names) {
  19201. int san_count = wolfSSL_sk_num(san_names);
  19202. for (int i = 0; i < san_count; i++) {
  19203. auto *names =
  19204. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19205. if (!names) continue;
  19206. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19207. // DNS name
  19208. unsigned char *dns_name = nullptr;
  19209. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19210. if (dns_name && dns_len > 0) {
  19211. std::string san_name(reinterpret_cast<char *>(dns_name),
  19212. static_cast<size_t>(dns_len));
  19213. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19214. if (detail::match_hostname(san_name, host_str)) {
  19215. wolfSSL_sk_free(san_names);
  19216. return true;
  19217. }
  19218. }
  19219. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19220. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19221. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19222. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19223. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19224. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19225. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19226. wolfSSL_sk_free(san_names);
  19227. return true;
  19228. }
  19229. }
  19230. }
  19231. wolfSSL_sk_free(san_names);
  19232. }
  19233. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  19234. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  19235. // the OpenSSL backend's X509_check_ip behaves the same way).
  19236. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  19237. if (subject) {
  19238. char cn[256] = {};
  19239. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19240. sizeof(cn));
  19241. if (cn_len > 0) {
  19242. std::string cn_str(cn, static_cast<size_t>(cn_len));
  19243. if (detail::match_hostname(cn_str, host_str)) { return true; }
  19244. }
  19245. }
  19246. return false;
  19247. }
  19248. inline uint64_t hostname_mismatch_code() {
  19249. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19250. }
  19251. inline long get_verify_result(const_session_t session) {
  19252. if (!session) { return -1; }
  19253. auto wsession =
  19254. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19255. long result = wolfSSL_get_verify_result(wsession->ssl);
  19256. return result;
  19257. }
  19258. inline std::string get_cert_subject_cn(cert_t cert) {
  19259. if (!cert) return "";
  19260. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19261. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19262. if (!subject) return "";
  19263. char cn[256] = {};
  19264. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19265. sizeof(cn));
  19266. if (cn_len <= 0) return "";
  19267. return std::string(cn, static_cast<size_t>(cn_len));
  19268. }
  19269. inline std::string get_cert_issuer_name(cert_t cert) {
  19270. if (!cert) return "";
  19271. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19272. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19273. if (!issuer) return "";
  19274. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19275. if (!name_str) return "";
  19276. std::string result(name_str);
  19277. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19278. return result;
  19279. }
  19280. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19281. sans.clear();
  19282. if (!cert) return false;
  19283. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19284. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19285. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19286. if (!san_names) return true; // No SANs is not an error
  19287. int count = wolfSSL_sk_num(san_names);
  19288. for (int i = 0; i < count; i++) {
  19289. auto *name =
  19290. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19291. if (!name) continue;
  19292. SanEntry entry;
  19293. switch (name->type) {
  19294. case WOLFSSL_GEN_DNS: {
  19295. entry.type = SanType::DNS;
  19296. unsigned char *dns_name = nullptr;
  19297. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19298. if (dns_name && dns_len > 0) {
  19299. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19300. static_cast<size_t>(dns_len));
  19301. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19302. }
  19303. break;
  19304. }
  19305. case WOLFSSL_GEN_IPADD: {
  19306. entry.type = SanType::IP;
  19307. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19308. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19309. if (ip_data && ip_len == 4) {
  19310. char buf[16];
  19311. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19312. ip_data[2], ip_data[3]);
  19313. entry.value = buf;
  19314. } else if (ip_data && ip_len == 16) {
  19315. char buf[64];
  19316. snprintf(buf, sizeof(buf),
  19317. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19318. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19319. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19320. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19321. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19322. ip_data[14], ip_data[15]);
  19323. entry.value = buf;
  19324. }
  19325. break;
  19326. }
  19327. case WOLFSSL_GEN_EMAIL:
  19328. entry.type = SanType::EMAIL;
  19329. {
  19330. unsigned char *email = nullptr;
  19331. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19332. if (email && email_len > 0) {
  19333. entry.value = std::string(reinterpret_cast<char *>(email),
  19334. static_cast<size_t>(email_len));
  19335. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19336. }
  19337. }
  19338. break;
  19339. case WOLFSSL_GEN_URI:
  19340. entry.type = SanType::URI;
  19341. {
  19342. unsigned char *uri = nullptr;
  19343. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19344. &uri, name->d.uniformResourceIdentifier);
  19345. if (uri && uri_len > 0) {
  19346. entry.value = std::string(reinterpret_cast<char *>(uri),
  19347. static_cast<size_t>(uri_len));
  19348. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19349. }
  19350. }
  19351. break;
  19352. default: entry.type = SanType::OTHER; break;
  19353. }
  19354. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19355. }
  19356. wolfSSL_sk_free(san_names);
  19357. return true;
  19358. }
  19359. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19360. time_t &not_after) {
  19361. if (!cert) return false;
  19362. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19363. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19364. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19365. if (!nb || !na) return false;
  19366. // wolfSSL_ASN1_TIME_to_tm is available
  19367. struct tm tm_nb = {}, tm_na = {};
  19368. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19369. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19370. #ifdef _WIN32
  19371. not_before = _mkgmtime(&tm_nb);
  19372. not_after = _mkgmtime(&tm_na);
  19373. #else
  19374. not_before = timegm(&tm_nb);
  19375. not_after = timegm(&tm_na);
  19376. #endif
  19377. return true;
  19378. }
  19379. inline std::string get_cert_serial(cert_t cert) {
  19380. if (!cert) return "";
  19381. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19382. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19383. if (!serial_asn1) return "";
  19384. // Get the serial number data
  19385. int len = serial_asn1->length;
  19386. unsigned char *data = serial_asn1->data;
  19387. if (!data || len <= 0) return "";
  19388. std::string result;
  19389. result.reserve(static_cast<size_t>(len) * 2);
  19390. for (int i = 0; i < len; i++) {
  19391. char hex[3];
  19392. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19393. result += hex;
  19394. }
  19395. return result;
  19396. }
  19397. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19398. if (!cert) return false;
  19399. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19400. int der_len = 0;
  19401. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19402. if (!der_data || der_len <= 0) return false;
  19403. der.assign(der_data, der_data + der_len);
  19404. return true;
  19405. }
  19406. inline const char *get_sni(const_session_t session) {
  19407. if (!session) return nullptr;
  19408. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19409. // For server: return SNI received from client during handshake
  19410. if (!wsession->sni_hostname.empty()) {
  19411. return wsession->sni_hostname.c_str();
  19412. }
  19413. // For client: return the hostname set via set_sni
  19414. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19415. return nullptr;
  19416. }
  19417. inline uint64_t peek_error() {
  19418. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19419. }
  19420. inline uint64_t get_error() {
  19421. uint64_t err = impl::wolfssl_last_error();
  19422. impl::wolfssl_last_error() = 0;
  19423. return err;
  19424. }
  19425. inline std::string error_string(uint64_t code) {
  19426. char buf[256];
  19427. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19428. return std::string(buf);
  19429. }
  19430. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19431. if (!pem || len == 0) { return nullptr; }
  19432. // Validate by attempting to load into a temporary ctx
  19433. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19434. if (!tmp_ctx) { return nullptr; }
  19435. int ret = wolfSSL_CTX_load_verify_buffer(
  19436. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19437. static_cast<long>(len), SSL_FILETYPE_PEM);
  19438. wolfSSL_CTX_free(tmp_ctx);
  19439. if (ret != SSL_SUCCESS) { return nullptr; }
  19440. return static_cast<ca_store_t>(
  19441. new impl::WolfSSLCAStore{std::string(pem, len)});
  19442. }
  19443. inline void free_ca_store(ca_store_t store) {
  19444. delete static_cast<impl::WolfSSLCAStore *>(store);
  19445. }
  19446. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19447. if (!ctx || !store) { return false; }
  19448. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19449. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19450. int ret = wolfSSL_CTX_load_verify_buffer(
  19451. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19452. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19453. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19454. // This function takes ownership of the store; the PEM data was copied into
  19455. // the context, so release the source
  19456. free_ca_store(store);
  19457. return ret == SSL_SUCCESS;
  19458. }
  19459. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19460. certs.clear();
  19461. if (!ctx) { return 0; }
  19462. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19463. if (wctx->ca_pem_data_.empty()) { return 0; }
  19464. const std::string &pem = wctx->ca_pem_data_;
  19465. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19466. const std::string end_marker = "-----END CERTIFICATE-----";
  19467. size_t pos = 0;
  19468. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19469. size_t end_pos = pem.find(end_marker, pos);
  19470. if (end_pos == std::string::npos) { break; }
  19471. end_pos += end_marker.size();
  19472. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19473. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19474. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19475. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19476. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19477. pos = end_pos;
  19478. }
  19479. return certs.size();
  19480. }
  19481. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19482. std::vector<std::string> names;
  19483. if (!ctx) { return names; }
  19484. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19485. if (wctx->ca_pem_data_.empty()) { return names; }
  19486. const std::string &pem = wctx->ca_pem_data_;
  19487. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19488. const std::string end_marker = "-----END CERTIFICATE-----";
  19489. size_t pos = 0;
  19490. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19491. size_t end_pos = pem.find(end_marker, pos);
  19492. if (end_pos == std::string::npos) { break; }
  19493. end_pos += end_marker.size();
  19494. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19495. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19496. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19497. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19498. if (x509) {
  19499. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19500. if (subject) {
  19501. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19502. if (name_str) {
  19503. names.push_back(name_str);
  19504. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19505. }
  19506. }
  19507. wolfSSL_X509_free(x509);
  19508. }
  19509. pos = end_pos;
  19510. }
  19511. return names;
  19512. }
  19513. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19514. const char *key_pem, const char *password) {
  19515. if (!ctx || !cert_pem || !key_pem) { return false; }
  19516. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19517. // Try the pair on a scratch context first, so a bad one leaves the server
  19518. // with its old certificate and key rather than half of each.
  19519. {
  19520. auto tmp = wolfSSL_CTX_new(wolfTLSv1_2_server_method());
  19521. if (!tmp) { return false; }
  19522. auto se = detail::scope_exit([&] { wolfSSL_CTX_free(tmp); });
  19523. if (password) { impl::set_wolfssl_password_cb(tmp, password); }
  19524. if (wolfSSL_CTX_use_certificate_buffer(
  19525. tmp, reinterpret_cast<const unsigned char *>(cert_pem),
  19526. static_cast<long>(strlen(cert_pem)),
  19527. SSL_FILETYPE_PEM) != SSL_SUCCESS ||
  19528. wolfSSL_CTX_use_PrivateKey_buffer(
  19529. tmp, reinterpret_cast<const unsigned char *>(key_pem),
  19530. static_cast<long>(strlen(key_pem)),
  19531. SSL_FILETYPE_PEM) != SSL_SUCCESS) {
  19532. impl::wolfssl_last_error() =
  19533. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19534. return false;
  19535. }
  19536. }
  19537. // Load new certificate
  19538. int ret = wolfSSL_CTX_use_certificate_buffer(
  19539. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19540. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19541. if (ret != SSL_SUCCESS) {
  19542. impl::wolfssl_last_error() =
  19543. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19544. return false;
  19545. }
  19546. // Set password if provided
  19547. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19548. // Load new private key
  19549. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19550. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19551. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19552. if (ret != SSL_SUCCESS) {
  19553. impl::wolfssl_last_error() =
  19554. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19555. return false;
  19556. }
  19557. return true;
  19558. }
  19559. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19560. if (!ctx || !ca_pem) { return false; }
  19561. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19562. // Replace the CAs rather than add to them, as the other backends do, once
  19563. // the new ones are known to load
  19564. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  19565. if (!store) { return false; }
  19566. free_ca_store(store);
  19567. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  19568. int ret = wolfSSL_CTX_load_verify_buffer(
  19569. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19570. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19571. if (ret != SSL_SUCCESS) {
  19572. impl::wolfssl_last_error() =
  19573. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19574. return false;
  19575. }
  19576. wctx->ca_pem_data_ = ca_pem;
  19577. return true;
  19578. }
  19579. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19580. if (!ctx) { return false; }
  19581. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19582. wctx->verify_callback = std::move(callback);
  19583. if (wctx->verify_callback) {
  19584. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19585. impl::wolfssl_verify_callback);
  19586. } else {
  19587. wolfSSL_CTX_set_verify(
  19588. wctx->ctx,
  19589. wctx->verify_client
  19590. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19591. : SSL_VERIFY_NONE,
  19592. nullptr);
  19593. }
  19594. return true;
  19595. }
  19596. inline long get_verify_error(const_session_t session) {
  19597. if (!session) { return -1; }
  19598. auto *wsession =
  19599. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19600. return wolfSSL_get_verify_result(wsession->ssl);
  19601. }
  19602. inline std::string verify_error_string(long error_code) {
  19603. if (error_code == 0) { return ""; }
  19604. const char *str =
  19605. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19606. return str ? std::string(str) : std::string();
  19607. }
  19608. } // namespace tls
  19609. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19610. // WebSocket implementation
  19611. namespace ws {
  19612. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19613. bool fin) {
  19614. std::lock_guard<std::mutex> lock(write_mutex_);
  19615. if (closed_) { return false; }
  19616. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19617. }
  19618. inline ReadResult WebSocket::read(std::string &msg) {
  19619. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is malformed,
  19620. // which is answered with a protocol error instead.
  19621. auto answer_close = [&](const std::string &payload) {
  19622. if (closed_.exchange(true)) { return; }
  19623. auto reply = payload;
  19624. if (!impl::is_valid_close_payload(payload)) {
  19625. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  19626. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  19627. }
  19628. std::lock_guard<std::mutex> lock(write_mutex_);
  19629. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  19630. reply.size(), true, !is_server_);
  19631. };
  19632. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19633. while (!closed_) {
  19634. Opcode opcode;
  19635. std::string payload;
  19636. bool fin;
  19637. impl::FrameRead r =
  19638. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19639. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19640. // A timeout landed on a frame boundary: the connection is untouched and
  19641. // still usable, so hand control back without closing it. That is only
  19642. // useful to a caller who asked for the timeout; the compile-time default
  19643. // is a backstop against a peer gone quiet, and elapsing it closes the
  19644. // connection so a plain `while (ws.read(msg))` loop ends.
  19645. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19646. if (r != impl::FrameRead::Ok) {
  19647. closed_ = true;
  19648. return Fail;
  19649. }
  19650. switch (opcode) {
  19651. case Opcode::Ping: {
  19652. std::lock_guard<std::mutex> lock(write_mutex_);
  19653. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19654. payload.size(), true, !is_server_);
  19655. continue;
  19656. }
  19657. case Opcode::Pong: {
  19658. std::lock_guard<std::mutex> lock(ping_mutex_);
  19659. unacked_pings_ = 0;
  19660. continue;
  19661. }
  19662. case Opcode::Close: {
  19663. answer_close(payload);
  19664. return Fail;
  19665. }
  19666. case Opcode::Text:
  19667. case Opcode::Binary: {
  19668. auto result = opcode == Opcode::Text ? Text : Binary;
  19669. msg = std::move(payload);
  19670. // Handle fragmentation
  19671. if (!fin) {
  19672. while (true) {
  19673. Opcode cont_opcode;
  19674. std::string cont_payload;
  19675. bool cont_fin;
  19676. // A timeout is not reportable here: half of a fragmented message is
  19677. // already in `msg` and read() has no way to resume it, so it is a
  19678. // failure like any other. Timeouts are only ever seen on a message
  19679. // boundary.
  19680. // Only what is left of the limit, but room for a control frame,
  19681. // which may come between the fragments.
  19682. auto max_len =
  19683. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  19684. ? size_t(0)
  19685. : (std::max)(size_t(125),
  19686. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  19687. msg.size());
  19688. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  19689. cont_fin, is_server_,
  19690. max_len) != impl::FrameRead::Ok) {
  19691. closed_ = true;
  19692. return Fail;
  19693. }
  19694. if (cont_opcode == Opcode::Ping) {
  19695. std::lock_guard<std::mutex> lock(write_mutex_);
  19696. detail::write_websocket_frame(
  19697. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19698. true, !is_server_);
  19699. continue;
  19700. }
  19701. if (cont_opcode == Opcode::Pong) {
  19702. std::lock_guard<std::mutex> lock(ping_mutex_);
  19703. unacked_pings_ = 0;
  19704. continue;
  19705. }
  19706. if (cont_opcode == Opcode::Close) {
  19707. answer_close(cont_payload);
  19708. return Fail;
  19709. }
  19710. // RFC 6455: continuation frames must use opcode 0x0
  19711. if (cont_opcode != Opcode::Continuation) {
  19712. closed_ = true;
  19713. return Fail;
  19714. }
  19715. msg += cont_payload;
  19716. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  19717. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19718. closed_ = true;
  19719. return Fail;
  19720. }
  19721. if (cont_fin) { break; }
  19722. }
  19723. }
  19724. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19725. if (result == Text && !impl::is_valid_utf8(msg)) {
  19726. // close() takes the read lock to wait for the peer's Close reply, so
  19727. // it must not run while this thread still holds it.
  19728. read_lock.unlock();
  19729. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19730. return Fail;
  19731. }
  19732. return result;
  19733. }
  19734. default: closed_ = true; return Fail;
  19735. }
  19736. }
  19737. return Fail;
  19738. }
  19739. inline bool WebSocket::send(const std::string &data) {
  19740. return send_frame(Opcode::Text, data.data(), data.size());
  19741. }
  19742. inline bool WebSocket::send(const char *data, size_t len) {
  19743. return send_frame(Opcode::Binary, data, len);
  19744. }
  19745. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19746. if (closed_.exchange(true)) { return; }
  19747. ping_cv_.notify_all();
  19748. std::string payload;
  19749. auto code = static_cast<uint16_t>(status);
  19750. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19751. payload.push_back(static_cast<char>(code & 0xFF));
  19752. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19753. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19754. payload += reason.substr(0, 123);
  19755. {
  19756. std::lock_guard<std::mutex> lock(write_mutex_);
  19757. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19758. payload.size(), true, !is_server_);
  19759. }
  19760. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19761. // Close response before closing the TCP connection.
  19762. //
  19763. // Wait only when no other thread is parsing frames. When one is, it is the
  19764. // thread positioned to see the peer's reply, and reading here would take
  19765. // bytes out of the message it is assembling. Bailing out also leaves the
  19766. // stream, including its read timeout, entirely to that thread.
  19767. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19768. if (!read_lock.owns_lock()) { return; }
  19769. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19770. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19771. Opcode op;
  19772. std::string resp;
  19773. bool fin;
  19774. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19775. impl::FrameRead::Ok) {
  19776. if (op == Opcode::Close) { break; }
  19777. }
  19778. }
  19779. inline WebSocket::~WebSocket() {
  19780. {
  19781. std::lock_guard<std::mutex> lock(ping_mutex_);
  19782. closed_ = true;
  19783. }
  19784. ping_cv_.notify_all();
  19785. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19786. }
  19787. inline void WebSocket::start_heartbeat() {
  19788. if (ping_interval_sec_ == 0) { return; }
  19789. ping_thread_ = std::thread([this]() {
  19790. std::unique_lock<std::mutex> lock(ping_mutex_);
  19791. // The predicate keeps a spurious wakeup from sending a ping early
  19792. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  19793. [this]() { return closed_.load(); })) {
  19794. // If the peer has failed to respond to the previous pings, give up.
  19795. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19796. // opt-in liveness check controlled by max_missed_pongs_.
  19797. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19798. lock.unlock();
  19799. close(CloseStatus::GoingAway, "pong timeout");
  19800. // Wake a read() blocked on the unresponsive peer. Only the read side
  19801. // is shut down: a TLS backend answers the EOF with an alert, and
  19802. // writing it to a socket closed for writing raises SIGPIPE.
  19803. #ifdef _WIN32
  19804. shutdown(strm_.socket(), SD_RECEIVE);
  19805. #else
  19806. shutdown(strm_.socket(), SHUT_RD);
  19807. #endif
  19808. return;
  19809. }
  19810. lock.unlock();
  19811. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19812. lock.lock();
  19813. closed_ = true;
  19814. break;
  19815. }
  19816. lock.lock();
  19817. unacked_pings_++;
  19818. }
  19819. });
  19820. }
  19821. inline const Request &WebSocket::request() const { return req_; }
  19822. inline bool WebSocket::is_open() const { return !closed_; }
  19823. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19824. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19825. // poll(), where 0 would instead mean "return immediately", so hand it the
  19826. // negative poll uses for an unbounded wait.
  19827. if (sec == 0 && usec == 0) { sec = -1; }
  19828. strm_.set_read_timeout(sec, usec);
  19829. read_timeout_set_ = true;
  19830. }
  19831. // WebSocketClient implementation
  19832. inline WebSocketClient::WebSocketClient(
  19833. const std::string &scheme_host_port_path, const Headers &headers)
  19834. : headers_(headers) {
  19835. detail::UrlComponents uc;
  19836. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19837. !uc.host.empty() && !uc.path.empty()) {
  19838. auto &scheme = uc.scheme;
  19839. #ifdef CPPHTTPLIB_SSL_ENABLED
  19840. if (scheme != "ws" && scheme != "wss") {
  19841. #else
  19842. if (scheme != "ws") {
  19843. #endif
  19844. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19845. std::string msg = "'" + scheme + "' scheme is not supported.";
  19846. throw std::invalid_argument(msg);
  19847. #endif
  19848. return;
  19849. }
  19850. auto is_ssl = scheme == "wss";
  19851. host_ = std::move(uc.host);
  19852. port_ = is_ssl ? 443 : 80;
  19853. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19854. path_ = std::move(uc.path);
  19855. if (!uc.query.empty()) { path_ += uc.query; }
  19856. #ifdef CPPHTTPLIB_SSL_ENABLED
  19857. is_ssl_ = is_ssl;
  19858. if (is_ssl_) {
  19859. // The context lives as long as the client so that CA configuration
  19860. // survives reconnects; sessions are created per connection.
  19861. tls_ctx_ = tls::create_client_context();
  19862. if (!tls_ctx_) { return; }
  19863. }
  19864. #else
  19865. if (is_ssl) { return; }
  19866. #endif
  19867. is_valid_ = true;
  19868. }
  19869. }
  19870. #ifdef CPPHTTPLIB_SSL_ENABLED
  19871. inline WebSocketClient::WebSocketClient(
  19872. const std::string &scheme_host_port_path, const PemMemory &pem,
  19873. const Headers &headers)
  19874. : WebSocketClient(scheme_host_port_path, headers) {
  19875. // For ws:// URLs the client certificate is silently ignored, consistent
  19876. // with the TLS-only setters such as set_ca_cert_path().
  19877. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19878. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19879. pem.private_key_password)) {
  19880. tls::free_context(tls_ctx_);
  19881. tls_ctx_ = nullptr;
  19882. is_valid_ = false;
  19883. }
  19884. }
  19885. }
  19886. #endif
  19887. inline WebSocketClient::~WebSocketClient() {
  19888. shutdown_and_close();
  19889. #ifdef CPPHTTPLIB_SSL_ENABLED
  19890. if (tls_ctx_) {
  19891. tls::free_context(tls_ctx_);
  19892. tls_ctx_ = nullptr;
  19893. }
  19894. #endif
  19895. }
  19896. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19897. inline void WebSocketClient::shutdown_and_close() {
  19898. // Send the close frame while the TLS session is still alive: ws_ holds an
  19899. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19900. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19901. if (ws_ && ws_->is_open()) { ws_->close(); }
  19902. ws_.reset();
  19903. #ifdef CPPHTTPLIB_SSL_ENABLED
  19904. if (is_ssl_) {
  19905. if (tls_session_) {
  19906. tls::shutdown(tls_session_, true);
  19907. tls::free_session(tls_session_);
  19908. tls_session_ = nullptr;
  19909. }
  19910. }
  19911. #endif
  19912. if (sock_ != INVALID_SOCKET) {
  19913. detail::shutdown_socket(sock_);
  19914. detail::close_socket(sock_);
  19915. sock_ = INVALID_SOCKET;
  19916. }
  19917. }
  19918. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19919. Error &error, int &ssl_error,
  19920. uint64_t &ssl_backend_error) {
  19921. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19922. // The streams wait with poll(), where 0 instead means "return immediately",
  19923. // so they are given the negative poll uses for an unbounded wait.
  19924. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19925. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19926. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19927. // The handshake belongs to establishing the connection, so an unset read
  19928. // timeout leaves it bounded by the connection timeout instead of forever.
  19929. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19930. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19931. #ifdef CPPHTTPLIB_SSL_ENABLED
  19932. if (is_ssl_) {
  19933. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19934. // is not safe to call concurrently on one client to begin with, since
  19935. // nothing else here is guarded either.
  19936. if (server_certificate_verification_ && !certs_loaded_) {
  19937. uint64_t backend_error = 0;
  19938. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19939. ca_cert_dir_path_, custom_ca_loaded_,
  19940. system_ca_mode_, backend_error);
  19941. certs_loaded_ = true;
  19942. }
  19943. detail::ClientTlsSessionOptions options;
  19944. options.server_hostname_verification = server_hostname_verification_;
  19945. detail::ClientTlsSessionError tls_error;
  19946. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19947. server_certificate_verification_,
  19948. hs_sec, hs_usec, &tls_error,
  19949. options)) {
  19950. error = tls_error.error;
  19951. ssl_error = tls_error.ssl_error;
  19952. ssl_backend_error = tls_error.backend_error;
  19953. return false;
  19954. }
  19955. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19956. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19957. write_timeout_usec_));
  19958. return true;
  19959. }
  19960. #else
  19961. (void)error;
  19962. (void)ssl_error;
  19963. (void)ssl_backend_error;
  19964. (void)hs_sec;
  19965. (void)hs_usec;
  19966. #endif
  19967. strm = std::unique_ptr<Stream>(
  19968. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19969. write_timeout_sec_, write_timeout_usec_));
  19970. return true;
  19971. }
  19972. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19973. #ifdef CPPHTTPLIB_SSL_ENABLED
  19974. auto is_ssl = is_ssl_;
  19975. #else
  19976. auto is_ssl = false;
  19977. #endif
  19978. if (!req.has_header("Host")) {
  19979. req.headers.emplace("Host", detail::make_default_host_header_value(
  19980. host_, port_, is_ssl, address_family_));
  19981. }
  19982. detail::add_default_user_agent_header(req);
  19983. }
  19984. inline Result WebSocketClient::connect() {
  19985. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19986. shutdown_and_close();
  19987. // Check is custom IP or hostname specified for host_
  19988. std::string connect_host;
  19989. std::string ip;
  19990. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19991. auto error = Error::Success;
  19992. sock_ = detail::create_client_socket(
  19993. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19994. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19995. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19996. write_timeout_usec_, interface_, error);
  19997. if (sock_ == INVALID_SOCKET) {
  19998. if (error == Error::Success) { error = Error::Connection; }
  19999. return Result{error, -1, Headers{}};
  20000. }
  20001. std::unique_ptr<Stream> strm;
  20002. auto stream_error = Error::SSLConnection;
  20003. int ssl_error = 0;
  20004. uint64_t ssl_backend_error = 0;
  20005. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20006. shutdown_and_close();
  20007. #ifdef CPPHTTPLIB_SSL_ENABLED
  20008. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20009. #else
  20010. return Result{stream_error, -1, Headers{}};
  20011. #endif
  20012. }
  20013. Request req;
  20014. req.method = "GET";
  20015. req.path = path_;
  20016. req.headers = headers_;
  20017. prepare_default_headers(req);
  20018. detail::WebSocketUpgradeResponse upgrade;
  20019. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20020. shutdown_and_close();
  20021. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20022. }
  20023. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20024. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20025. websocket_ping_interval_sec_,
  20026. websocket_max_missed_pongs_));
  20027. // The stream was created with the timeout already; tell the WebSocket
  20028. // whether it came from the caller, so read() knows to report it as Timeout.
  20029. ws_->read_timeout_set_ = read_timeout_set_;
  20030. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20031. }
  20032. inline ReadResult WebSocketClient::read(std::string &msg) {
  20033. if (!ws_) { return Fail; }
  20034. return ws_->read(msg);
  20035. }
  20036. inline bool WebSocketClient::send(const std::string &data) {
  20037. if (!ws_) { return false; }
  20038. return ws_->send(data);
  20039. }
  20040. inline bool WebSocketClient::send(const char *data, size_t len) {
  20041. if (!ws_) { return false; }
  20042. return ws_->send(data, len);
  20043. }
  20044. inline void WebSocketClient::close(CloseStatus status,
  20045. const std::string &reason) {
  20046. if (ws_) { ws_->close(status, reason); }
  20047. }
  20048. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20049. inline const std::string &WebSocketClient::subprotocol() const {
  20050. return subprotocol_;
  20051. }
  20052. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20053. read_timeout_sec_ = sec;
  20054. read_timeout_usec_ = usec;
  20055. read_timeout_set_ = true;
  20056. // The members above only seed the next connect(); read() consults the
  20057. // stream, so an already-open connection has to be told directly.
  20058. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20059. }
  20060. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20061. write_timeout_sec_ = sec;
  20062. write_timeout_usec_ = usec;
  20063. }
  20064. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20065. websocket_ping_interval_sec_ = sec;
  20066. }
  20067. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20068. websocket_max_missed_pongs_ = count;
  20069. }
  20070. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20071. inline void WebSocketClient::set_address_family(int family) {
  20072. address_family_ = family;
  20073. }
  20074. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20075. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20076. socket_options_ = std::move(socket_options);
  20077. }
  20078. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20079. connection_timeout_sec_ = sec;
  20080. connection_timeout_usec_ = usec;
  20081. }
  20082. inline void WebSocketClient::set_interface(const std::string &intf) {
  20083. interface_ = intf;
  20084. }
  20085. inline void WebSocketClient::set_hostname_addr_map(
  20086. std::map<std::string, std::string> addr_map) {
  20087. addr_map_ = std::move(addr_map);
  20088. }
  20089. #ifdef CPPHTTPLIB_SSL_ENABLED
  20090. inline void
  20091. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20092. const std::string &ca_cert_dir_path) {
  20093. ca_cert_file_path_ = ca_cert_file_path;
  20094. ca_cert_dir_path_ = ca_cert_dir_path;
  20095. }
  20096. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20097. if (store && tls_ctx_) {
  20098. // set_ca_store takes ownership of store
  20099. tls::set_ca_store(tls_ctx_, store);
  20100. custom_ca_loaded_ = true;
  20101. } else if (store) {
  20102. tls::free_ca_store(store);
  20103. }
  20104. }
  20105. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20106. std::size_t size) {
  20107. if (tls_ctx_ && ca_cert && size > 0) {
  20108. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20109. custom_ca_loaded_ = true;
  20110. }
  20111. }
  20112. inline void
  20113. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20114. server_certificate_verification_ = enabled;
  20115. }
  20116. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20117. server_hostname_verification_ = enabled;
  20118. }
  20119. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20120. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20121. }
  20122. #endif // CPPHTTPLIB_SSL_ENABLED
  20123. } // namespace ws
  20124. // ----------------------------------------------------------------------------
  20125. } // namespace httplib
  20126. #endif // CPPHTTPLIB_HTTPLIB_H